Skip to content

Conversation

@santhoshjattappa
Copy link

@santhoshjattappa santhoshjattappa commented Dec 9, 2025

Following PR covers the following topics:

  • custom-json configuration.
  • windows service monitoring using custom-json.
  • certificate monitoring using custom-json.
  • slack monitoring using custom-json.
  • sql cluster instance monitoring using custom-json.
  • custom json troubleshooting guide.

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
image

SQL Cluster Configuration
sql-cluster-configuration.md
image
image
image

Custom Json Configuration
environment_watch_configuration.md
image
image

Certificates Configuration
certificates_configuration.md
image
image

Windows Service Configuration
windows_services_configuration.md
image
image

Slack Notification
alert_notification_handlers_configuration.md
image
image
image
image
image

@amithshet amithshet changed the title Rel 1212267 ew document json configuration Rel 1212267 EW Documents - Custom JSON Related Configurations Dec 15, 2025
@amithshet amithshet changed the title Rel 1212267 EW Documents - Custom JSON Related Configurations REL-1212267 EW Documents - Custom JSON Related Configurations Dec 15, 2025
@amithshet amithshet marked this pull request as draft December 15, 2025 15:50
@anujavinash anujavinash changed the base branch from main to REL-1238635-cumulative-cum-folder-hierarchy-change December 22, 2025 10:33
…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.
Copy link
Contributor

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?

Copy link
Collaborator

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.

Copy link
Contributor

@KarunaDhawan KarunaDhawan left a 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.

@amithshet
Copy link
Collaborator

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.

@amithshet amithshet requested a review from KarunaDhawan January 6, 2026 12:29
Copy link
Contributor

@KarunaDhawan KarunaDhawan left a 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.
Copy link
Contributor

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.'

Copy link
Contributor

@KarunaDhawan KarunaDhawan left a 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.

@amithshet
Copy link
Collaborator

@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

  • Avoiding 'you' in all documents.
  • Update custom JSON to 'custom JSON configuration issue'

Could you please re-review and approve the PR.

@amithshet amithshet requested a review from KarunaDhawan January 9, 2026 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants