REL-1212267 EW Documents - Custom JSON Related Configurations #45

santhoshjattappa · 2025-12-09T04:17:28Z

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

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

…ration

docs/custom-json-configuration/environment_watch_configuration.md

…rt Notification.

… main json.

…cements.

…the structure of the documents

… link in the install integration page.

amithshet · 2025-12-17T12:40:02Z

Hi @KarunaDhawan ,

Have addressed all feedbacks related

Casing
Avoiding 'array'
Better user - readability sentences.

Could you please re-review and approve the PR.

docs/custom-json-configuration/alert_notification_handlers_configuration.md

…o REL-1212267-EW--Document-JSON-Configuration

KarunaDhawan · 2026-01-05T19:24:45Z

docs/custom-json-configuration/environment_watch_configuration.md

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


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?

Updated the paragraph as suggested above.

docs/custom-json-configuration/alert_notification_handlers_configuration.md

KarunaDhawan

Left some minor comments on few files, other than that everything else looks good.

amithshet · 2026-01-06T12:29:21Z

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

docs/custom-json-configuration/certificates_configuration.md

…om PR 55

…de link for all custom json use case documents.

KarunaDhawan

just minor feedback for consistency to use to 'JSON configuration file' in place of 'JSON object'.

KarunaDhawan · 2026-01-08T17:00:05Z

docs/custom-json-configuration/windows_services_configuration.md

@@ -0,0 +1,83 @@
+# Windows Service Configuration
+
+This section describes how to configure Windows service monitoring using the `environmentWatchConfiguration` JSON object.


to maintain consistency - this should also be updated from 'JSON object' to 'JSON configuration file.'

KarunaDhawan

@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 · 2026-01-08T19:40:15Z

docs/sql-cluster-configuration/sql-cluster-configuration.md

+> [!NOTE]
+> Use the steps below only if your environment uses SQL cluster servers for Environment Watch monitoring.
+
+An environment may include SQL cluster instances consisting of two or more nodes. To monitor these instances using the Environment Watch Windows service, you need to define specific configurations in a custom JSON file.


For consistency this should be updated from 'custom JSON file' to 'custom JSON configuration file'
This must be reviewed across the document to make sure we use the same terminology at all places

KarunaDhawan · 2026-01-08T20:02:32Z

docs/sql-cluster-configuration/sql-cluster-configuration.md

+
+## Configure SQL Cluster Instances
+
+To configure SQL cluster instances in the Custom JSON file, the "**hosts**" section needs to be updated.


Update to: Specify SQL cluster configuration in the custom JSON configuration file within the "hosts" section.

KarunaDhawan · 2026-01-08T20:07:55Z

docs/sql-cluster-configuration/sql-cluster-configuration.md

+
+**Example:**
+For an environment containing a SQL cluster with two nodes (`SQLNode1` and `SQLNode2`):  
+- Update the "hosts" section for each node by:


Formatting:
Update the hosts section for each node by:

Specify the correct host name

Set the enabled flag to true

Include the appropriate SQL cluster name (clusterVirtualName)

Provide the corresponding instance name (instanceName)

KarunaDhawan · 2026-01-08T20:30:47Z

docs/troubleshooting/custom-json-troubleshooting.md

+
+**1.4 Update the Environment Watch Windows Service to the latest version.**
+
+- Verify the version of the Environment Watch Windows Service.


Verify the installed version of the Environment Watch Windows Service

Ensure the service is updated to version 100.0.21 or later, as custom JSON support was introduced in this version.

If the service is running an earlier version, upgrade it to the latest available version

KarunaDhawan · 2026-01-08T20:51:49Z

docs/troubleshooting/custom-json-troubleshooting.md

+
+**3.3 Always include service name in the custom JSON**
+
+- Ensure you are using the correct service names (not display names) in the `include` section of the custom JSON configuration.


Avoid using 'you' in documentation - Ensure that the correct service names (not display names) are used in the include section of the custom JSON configuration.

santhoshjattappa added 2 commits December 8, 2025 18:54

REL-1212267: Custom JSON Documentation.

aaec0c7

REL-1212267: Folder change and link the page in install other configu…

5b55eba

…ration

santhoshjattappa requested a review from a team as a code owner December 9, 2025 04:17

santhoshjattappa requested review from Divyavenkataraju, amithshet, anujavinash, satishdayala-relativity, scott-parillo and shalinisundarpraksh December 9, 2025 04:30

REL-1212267: Troubleshooting for Certificates.

cd9a634

santhoshjattappa requested a review from KarunaDhawan December 9, 2025 11:24

amithshet reviewed Dec 10, 2025

View reviewed changes

docs/custom-json-configuration/environment_watch_configuration.md Outdated Show resolved Hide resolved

santhoshjattappa and others added 11 commits December 11, 2025 16:57

REL-1212267 : Slack configuration details added

ac9d2cc

REL-1212267: Slack information added.

05032eb

REL-1212267: Corrected Slack Example image

440abb7

REL-1212267: Seperate Files for Windows Service, Certificates and Ale…

f631c73

…rt Notification.

REL-1212267: Certificates Get certificates added and link is added in…

dfbab21

… main json.

REL-1212267: sql cluster changes pushed.

cca4abd

REL-1212267: Commit regarding re-structuring of the documents and pla…

9f8d7dc

…cements.

REL-1212267 commit: Updated docs to have same consistency related to …

f7e9481

…the structure of the documents

REL-1212267 commit: push related to consistency in all documents.

24cbb4e

REL-1212267 commit: fixed typo in slack doc

0d21e61

REL-1212267 commit: updated correct json.

12f6747

shalinisundarpraksh approved these changes Dec 15, 2025

View reviewed changes

amithshet changed the title ~~Rel 1212267 ew document json configuration~~ Rel 1212267 EW Documents - Custom JSON Related Configurations Dec 15, 2025

REL-1212267 commit: addressed internal feedback of including only one…

b53b57e

… link in the install integration page.

amithshet requested a review from SridharChiguru December 15, 2025 12:13

amithshet changed the title ~~Rel 1212267 EW Documents - Custom JSON Related Configurations~~ REL-1212267 EW Documents - Custom JSON Related Configurations Dec 15, 2025

amithshet marked this pull request as draft December 15, 2025 15:50

REL-1212267: Addressed PM feedback.

843ba94

anujavinash approved these changes Dec 17, 2025

View reviewed changes

REL-1212267: updated one feedback duering proof read.

0eca81c

amithshet added 2 commits December 17, 2025 18:26

REL-1212267: updated feedbacks

9af74a1

REL-1212267: updated

1bdfa7e

satishdayala-relativity approved these changes Dec 17, 2025

View reviewed changes

amithshet requested a review from KarunaDhawan December 17, 2025 13:18

KarunaDhawan reviewed Dec 19, 2025

View reviewed changes

docs/custom-json-configuration/alert_notification_handlers_configuration.md Outdated Show resolved Hide resolved

anujavinash changed the base branch from main to REL-1238635-cumulative-cum-folder-hierarchy-change December 22, 2025 10:33

Incorporating the review comments by PM.

84a7248

anujavinash requested a review from KarunaDhawan December 22, 2025 12:43

Merge branch 'REL-1238635-cumulative-cum-folder-hierarchy-change' int…

342b71d

…o REL-1212267-EW--Document-JSON-Configuration

KarunaDhawan reviewed Jan 5, 2026

View reviewed changes

docs/custom-json-configuration/alert_notification_handlers_configuration.md Outdated Show resolved Hide resolved

KarunaDhawan reviewed Jan 5, 2026

View reviewed changes

docs/custom-json-configuration/alert_notification_handlers_configuration.md Outdated Show resolved Hide resolved

KarunaDhawan requested changes Jan 5, 2026

View reviewed changes

Divyavenkataraju approved these changes Jan 6, 2026

View reviewed changes

REL-1212267: addressed second round feedbacks.

e8f26f2

amithshet requested a review from KarunaDhawan January 6, 2026 12:29

KarunaDhawan requested changes Jan 6, 2026

View reviewed changes

docs/custom-json-configuration/alert_notification_handlers_configuration.md Show resolved Hide resolved

docs/custom-json-configuration/certificates_configuration.md Outdated Show resolved Hide resolved

amithshet added 4 commits January 7, 2026 16:14

REL-1212267: addressed the comment.

c6b20c7

REL-1212267: troubleshooting guide document pushed to the same PR, fr…

741cbfc

…om PR 55

REL-1212267: pushed a commit related to providing troubleshooting gui…

260b508

…de link for all custom json use case documents.

REL-1212267: commit

3e07ee8

amithshet mentioned this pull request Jan 7, 2026

REL-1233187 : Custom JSON Troubleshooting Doc #55

Closed

anujavinash requested a review from KarunaDhawan January 8, 2026 05:10

KarunaDhawan approved these changes Jan 8, 2026

View reviewed changes

KarunaDhawan reviewed Jan 8, 2026

View reviewed changes

KarunaDhawan requested changes Jan 8, 2026

View reviewed changes


		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.

		@@ -0,0 +1,83 @@
		# Windows Service Configuration

		This section describes how to configure Windows service monitoring using the `environmentWatchConfiguration` JSON object.


		## Configure SQL Cluster Instances

		To configure SQL cluster instances in the Custom JSON file, the "hosts" section needs to be updated.


		1.4 Update the Environment Watch Windows Service to the latest version.

		- Verify the version of the Environment Watch Windows Service.


		3.3 Always include service name in the custom JSON

		- Ensure you are using the correct service names (not display names) in the `include` section of the custom JSON configuration.

REL-1212267 EW Documents - Custom JSON Related Configurations #45

Are you sure you want to change the base?

REL-1212267 EW Documents - Custom JSON Related Configurations #45

Uh oh!

Conversation

santhoshjattappa commented Dec 9, 2025 • edited by amithshet Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

amithshet commented Dec 17, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

KarunaDhawan left a comment

Choose a reason for hiding this comment

Uh oh!

amithshet commented Jan 6, 2026

Uh oh!

Uh oh!

Uh oh!

KarunaDhawan left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KarunaDhawan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

santhoshjattappa commented Dec 9, 2025 •

edited by amithshet

Loading

KarunaDhawan left a comment •

edited

Loading