-
Notifications
You must be signed in to change notification settings - Fork 1
REL-1212267 EW Documents - Custom JSON Related Configurations #45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: REL-1238635-cumulative-cum-folder-hierarchy-change
Are you sure you want to change the base?
REL-1212267 EW Documents - Custom JSON Related Configurations #45
Conversation
docs/custom-json-configuration/environment_watch_configuration.md
Outdated
Show resolved
Hide resolved
…the structure of the documents
… link in the install integration page.
docs/custom-json-configuration/alert_notification_handlers_configuration.md
Outdated
Show resolved
Hide resolved
…o REL-1212267-EW--Document-JSON-Configuration
|
|
||
| This document provides an overview of the custom JSON configuration for Environment Watch. This feature allows users to centrally define monitoring for Windows services and Certificates using a shared configuration file, and to send alerts to a Slack channel based on the configured Slack notification settings. | ||
|
|
||
| Using a shared configuration ensures that custom monitoring settings remain intact during Environment Watch upgrades, making monitoring both extensible and upgrade-safe. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor feedback: We may want to clarify that Slack is the currently supported notification platform and that the configuration is designed to be extensible for other notification platforms:
This document provides an overview of the custom JSON configuration used by Environment Watch. The configuration allows users to centrally define and customize monitoring for Windows services and certificates, as well as configure Slack notifications for alerting.
The shared configuration file enables users to control what is monitored—such as specific Windows services or certificate conditions—and how alerts are delivered. Currently, Slack is the only supported notification platform. The notification configuration is designed to be extensible, allowing additional platforms to be supported in future releases. Because the configuration is external to the application, custom monitoring settings are preserved during Environment Watch upgrades, making the solution both extensible and upgrade-safe.
@satishdayala-relativity @anujavinash What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated the paragraph as suggested above.
docs/custom-json-configuration/alert_notification_handlers_configuration.md
Outdated
Show resolved
Hide resolved
docs/custom-json-configuration/alert_notification_handlers_configuration.md
Outdated
Show resolved
Hide resolved
KarunaDhawan
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some minor comments on few files, other than that everything else looks good.
@KarunaDhawan - addressed all recent feedbacks, could you please re-review and approve the PR. |
docs/custom-json-configuration/alert_notification_handlers_configuration.md
Show resolved
Hide resolved
…de link for all custom json use case documents.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just minor feedback for consistency to use to 'JSON configuration file' in place of 'JSON object'.
| @@ -0,0 +1,83 @@ | |||
| # Windows Service Configuration | |||
|
|
|||
| This section describes how to configure Windows service monitoring using the `environmentWatchConfiguration` JSON object. | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to maintain consistency - this should also be updated from 'JSON object' to 'JSON configuration file.'
KarunaDhawan
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@amithshet I approved the PR, but I noticed the scope has expanded. I just saw your comment about the troubleshooting guide being included in this PR—I still need to review the changes related to the troubleshooting guide.
@KarunaDhawan - addressed feedbacks related to
Could you please re-review and approve the PR. |
Following PR covers the following topics:
Attached SQE Verification Evidence by @SridharChiguru . Evidences include Certificate, Windows Service, Slack Notification verification and custom Json troubleshooting guide document.
EW-documentation-certificates-windowsservices.docx
Relativity-EW-troubleshooting-custom.json.docx
Dev Verification Evidences:
Certificate-Windows-Services-Verification.docx
Slack-Alert-Notification.docx
SQL-Cluster-Dev-Verification.docx
Install Other Integrations

environment_watch_install_other_integrations.md
SQL Cluster Configuration



sql-cluster-configuration.md
Custom Json Configuration


environment_watch_configuration.md
Certificates Configuration


certificates_configuration.md
Windows Service Configuration


windows_services_configuration.md
Slack Notification





alert_notification_handlers_configuration.md