REL-1212267 EW Documents - Custom JSON Related Configurations

[santhoshjattappa]

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

[KarunaDhawan]

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

[amithshet]

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.

[KarunaDhawan]

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

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

[amithshet]

@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 file'

Could you please re-review and approve the PR.

[KarunaDhawan]

For the Custom JSON Configuration Troubleshooting file, the content is good and detailed, but the overall structure doesn’t consistently feel like a troubleshooting guide. A lot of the sections jump straight into configuration steps without first describing the issue or symptom that would lead someone there.

Some parts do this well (especially the early Common Issues tied to a missing log message), but that pattern isn’t consistent throughout the doc. In a few places—Slack Notifications is a good example—the headings read more like general guidance or setup tasks rather than problems a user is trying to solve, which makes it harder to scan and find the right section quickly.

It might help to rework the sections, so they start with what the user is seeing (or what’s broken), then explain the cause and the fix.

[amithshet]

For the Custom JSON Configuration Troubleshooting file, the content is good and detailed, but the overall structure doesn’t consistently feel like a troubleshooting guide. A lot of the sections jump straight into configuration steps without first describing the issue or symptom that would lead someone there.

Some parts do this well (especially the early Common Issues tied to a missing log message), but that pattern isn’t consistent throughout the doc. In a few places—Slack Notifications is a good example—the headings read more like general guidance or setup tasks rather than problems a user is trying to solve, which makes it harder to scan and find the right section quickly.

It might help to rework the sections, so they start with what the user is seeing (or what’s broken), then explain the cause and the fix.

@KarunaDhawan - I have revised the troubleshooting guide across all sections, providing a thorough explanation of potential issues in the order they are most likely to be encountered. Could you please re-review and approve if all are fine.

[KarunaDhawan]

Approving this PR, but the subsection numbering needs to be flattened in this PR to align with the SOP before publishing https://relativity-oda.atlassian.net/wiki/spaces/SDE/pages/487294046/Public+Documentation+SOP