Skip to content

NMS-8517: Notification docs - #9003

Merged
joseanesONMS merged 5 commits into
developfrom
jira/NMS-8517-notification-docs
Oct 23, 2026
Merged

joseanesONMS merged 5 commits into
developfrom
jira/NMS-8517-notification-docs

Conversation

@joseanesONMS

@joseanesONMS joseanesONMS commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Documents the notification strategies and routing, split out of #8984; content checked against the code on develop, one commit per ticket.

Ticket Topic Page(s) added/changed Source of truth
NMS-8517 Notification strategies operation/…/notifications/strategies/{javamail,http,snmp-trap,browser}.adoc (new), commands.adoc opennms-services/…/notifd/*NotificationStrategy.java, notificationCommands.xml
NMS-13290 Notifd event matching and automatic acknowledgment operation/…/notifications/concepts.adoc, reference/…/notifd.adoc BroadcastEventProcessor.java, NotificationManager.java, notifd-configuration.xsd
NMS-15583 Notifications for specific nodes to specific users operation/…/notifications/route-by-node.adoc (new) JdbcFilterDao.java

The SnmpTrap command example is also corrected.

Not addressed

  • NMS-18229: no PagerDuty example on the webhook page; PagerDuty is covered by the PagerDuty plugin, and publishing that plugin's docs is a docs-site playbook change outside this repository.

The docs build adds no warnings (develop's two existing ones remain).

External References

Only the scripting, ticket, and webhook strategies had pages; JavaMail, browser, HTTP, SNMP trap, and null were undocumented or only shown by example. The pages follow the strategy classes in opennms-services and the shipped notificationCommands.xml and javamail-configuration.properties.
The docs did not explain how notifd matches events to notifications, what match-all does, or how auto-acknowledge rules and resolution notices behave. The text follows BroadcastEventProcessor, NotificationManager, and the notifd-configuration.xsd model and shipped defaults.
Adds a PagerDuty Events API v2 example to the webhook strategy page, with trigger and resolve commands tied together by a dedup key. It uses only the existing WebhookNotificationStrategy switches and notification parameters.
…fic users

The reference material for rules, groups, and destination paths existed, but nothing showed how to combine them for this common task. The procedure uses the filter rule syntax in JdbcFilterDao and the shipped notifications.xml and notifd-configuration.xml defaults.

Discord replies with `204` and an empty body on success.

[[pagerduty]]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree with documenting this in detail at this location. We have a PagerDuty plugin that handles all this transparently.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. We don't want PagerDuty here for webhooks. I tried to leave the examples here as mostly generic as possible.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed in 2f13cab, which reverts the PagerDuty commit; webhook.adoc is back to its develop content.

@marshallmassengill marshallmassengill left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than the pagerduty thing, this is good I think.

This reverts ee59bc1. PagerDuty is covered by the PagerDuty plugin, and
the webhook page keeps its examples generic, so webhook.adoc is back to
its develop content.

@marshallmassengill marshallmassengill left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@joseanesONMS

Copy link
Copy Markdown
Contributor Author

@dino2gnt The PagerDuty section is gone in 2f13cab, and webhook.adoc matches develop again. Marshall has approved, but your earlier change request still blocks the merge. Could you take another look when you have a minute?

@dino2gnt dino2gnt left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@joseanesONMS
joseanesONMS merged commit 4e02d6d into develop Oct 23, 2026
6 checks passed
@joseanesONMS
joseanesONMS deleted the jira/NMS-8517-notification-docs branch October 23, 2026 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants