Skip to content

NMS-8517: Notification docs - #8993

Closed
joseanesONMS wants to merge 4 commits into
developfrom
jira/NMS-8517-notification-docs-smoke
Closed

joseanesONMS wants to merge 4 commits into
developfrom
jira/NMS-8517-notification-docs-smoke

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-18229 PagerDuty through the Webhook strategy operation/…/strategies/webhook.adoc WebhookNotificationStrategy.java
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 (plugin part): publishing the PagerDuty plugin's own 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.
@joseanesONMS

Copy link
Copy Markdown
Contributor Author

Reopened as #9003 from a branch without the -smoke suffix; this PR is docs-only, so it doesn't need a smoke run.

@joseanesONMS
joseanesONMS deleted the jira/NMS-8517-notification-docs-smoke branch October 22, 2026 12:45
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.

1 participant