Import notifications packages #145

yhabteab · 2025-08-06T15:45:08Z

This PR introduces a new notifications package. The package is designed to handle common Icinga Notifications related tasks, as follows.

notifications/event contains Icinga Notification events, to be used both in Icinga Notifications as well as in sources, such as Icinga DB.
Parts were imported from Icinga Notifications. Other code is generated by stringer, as indicated in the file headers.
notifications/plugin and notifications/rpc was imported from Icinga Notifications, allowing future Icinga Notifications channels to import this code from here.
References Dual-License pkg/plugin and cmd/channels icinga-notifications#304.
notifications/source was also imported from Icinga Notifications, allowing future Icinga Notifications sources - like Icinga DB - to import this code.
types: Helper functions for types.Bool were added.
utils: The very important and useful RawUrlEncode function was imported from Icinga Notifications' deprecated and removed Icinga 2 Event Stream code.

This PR is required by

julianbrost · 2025-08-06T16:40:17Z

I'm not sure if this is the right place to add this. The reasoning probably is similar to Icinga/icinga-notifications#304. One thing to consider here: do we expect external projects using this eventually? In this case, this would create dependency updates for them even though if nothing relevant to them changed. So I think having a separate repository with independent versioning for this is also worth considering.

lippserd · 2025-08-19T11:54:15Z

I'm not sure if this is the right place to add this. The reasoning probably is similar to Icinga/icinga-notifications#304. One thing to consider here: do we expect external projects using this eventually? In this case, this would create dependency updates for them even though if nothing relevant to them changed. So I think having a separate repository with independent versioning for this is also worth considering.

I like this idea. How about a MIT licensed go-icinga-notifications project with this code, and the channel base?

oxzi · 2025-09-02T13:50:26Z

After today's discussion to keep these changes in the IGL, I have skimmed the PR once again. In general, it looks good to me. However, it should be merged together with its sibling PRs as otherwise fix-up PRs would follow here.

notifications/client.go

notifications/event/event_test.go

notifications/event/type.go

notifications/source/client.go

yhabteab · 2025-09-05T11:10:52Z

Changed the tabular test cases to use testutils.TestCase instead of a custom one!

- Bump IGL to latest changes in Icinga/icinga-go-library#145. - Allow specifying which pipeline keys are relevant, ignore others. - Allow specifying which pipeline key should be parsed in which type. - Create history.DowntimeHistoryMeta as a chimera combining history.DowntimeHistory and history.HistoryDowntime to allow access event_type, distinguishing between downtime_start and downtime_end. - Trace times for submission steps in the worker. Turns out, the single threaded worker blocks roughly two seconds for each Client.ProcessEvent method call. This might sum up to minutes if lots of events are processed at once. My current theory is that the delay results in the expensive bcrypt hash comparison on Notifications.

Synchronize codebase against latest version of Icinga/icinga-go-library#145, containing package changes.

- Bump IGL to latest changes in Icinga/icinga-go-library#145. - Allow specifying which pipeline keys are relevant, ignore others. - Allow specifying which pipeline key should be parsed in which type. - Create history.DowntimeHistoryMeta as a chimera combining history.DowntimeHistory and history.HistoryDowntime to allow access event_type, distinguishing between downtime_start and downtime_end. - Trace times for submission steps in the worker. Turns out, the single threaded worker blocks roughly two seconds for each Client.ProcessEvent method call. This might sum up to minutes if lots of events are processed at once. My current theory is that the delay results in the expensive bcrypt hash comparison on Notifications.

oxzi · 2025-09-09T09:51:15Z

Removed the custom HTTP headers and moved the rules to the Event struct to address Icinga/icinga-notifications#324 (comment).

- Bump IGL to latest changes in Icinga/icinga-go-library#145. - Allow specifying which pipeline keys are relevant, ignore others. - Allow specifying which pipeline key should be parsed in which type. - Create history.DowntimeHistoryMeta as a chimera combining history.DowntimeHistory and history.HistoryDowntime to allow access event_type, distinguishing between downtime_start and downtime_end. - Trace times for submission steps in the worker. Turns out, the single threaded worker blocks roughly two seconds for each Client.ProcessEvent method call. This might sum up to minutes if lots of events are processed at once. My current theory is that the delay results in the expensive bcrypt hash comparison on Notifications.

Synchronize codebase against latest version of Icinga/icinga-go-library#145, containing package changes.

The "Tags" and "Extra Tags" printed in the plugin.FormatMessage were directly read from their map, thus having no order. This resulted in the same NotificationRequest being represented by different messages due to the unordered map. This change was the result of investigating Go's new rangefunc experiment[0]. The utilization of this novel language feature - which can also be indirectly used in the absence of `GOEXPERIMENT=rangefunc` - ensures that the map is traversed in key order. Closes #177. [0]: https://go.dev/wiki/RangefuncExperiment

In a nutshell, the newly introduced plugin.PopulateDefaults function populates all fields of a Plugin-implementing struct with those fields from Info.ConfigAttributes where ConfigOption.Default is set. Thus, a single function call before parsing the user-submitted configuration within the Plugin.SetConfig method sets default values. As a result of the discussion between the Go and the Web team, summarized in #205, Web does not store key-value pairs to be omitted. Prior, an already JSON-encoded version of the ConfigOption slice was present in plugin.Info. Thus, this data wasn't easily available anymore. As the new code now needs to access this field, it was changed and a custom sql driver.Valuer was implemented for a slice type. While working on this, all ConfigOptions were put in the same order as the struct fields. Requires <Icinga/icinga-notifications-web#230>. Closes #205.

With a release approaching, the Channels documentation got more information about how the Channel system actually work and how to build your own channels. The internal/changes/examples JSON files were inlined to ease the readability and updated, as they contained partially outdated information. For the pkg/plugin part, some API documentation was added as this might get used by external users.

… 1.23)

With #64 and #127 being merged, most of the internal/utils package is moved to the IGL and can be removed here. This is another step to unify our Go codebase.

This reverts commit 89dce8b and adds ExtraTags to event.Event, which was not yet imported here at the time of the commit.

cla-bot bot added the cla/signed CLA is signed by all contributors of a PR label Aug 6, 2025

yhabteab force-pushed the notifications branch 2 times, most recently from 609ec3f to 82eff34 Compare August 6, 2025 16:06

yhabteab force-pushed the notifications branch 2 times, most recently from e4215c5 to 55c038b Compare August 7, 2025 15:16

oxzi added this to the 0.8.0 milestone Aug 28, 2025

yhabteab force-pushed the notifications branch from 55c038b to 641e970 Compare September 2, 2025 14:53

julianbrost reviewed Sep 3, 2025

View reviewed changes

yhabteab force-pushed the notifications branch from 641e970 to 5032573 Compare September 4, 2025 13:06

yhabteab requested a review from julianbrost September 4, 2025 13:24

oxzi reviewed Sep 5, 2025

View reviewed changes

notifications/source/client.go Outdated Show resolved Hide resolved

yhabteab force-pushed the notifications branch 2 times, most recently from 64209e7 to f54aa70 Compare September 5, 2025 11:08

oxzi added a commit to Icinga/icinga-notifications that referenced this pull request Sep 5, 2025

Update IGL for Notifications Changes

408690d

Synchronize codebase against latest version of Icinga/icinga-go-library#145, containing package changes.

oxzi self-assigned this Sep 9, 2025

oxzi force-pushed the notifications branch from f54aa70 to 41693c5 Compare September 9, 2025 09:50

oxzi force-pushed the notifications branch from 41693c5 to 20db236 Compare September 9, 2025 10:01

oxzi added a commit to Icinga/icinga-notifications that referenced this pull request Sep 9, 2025

Update IGL for Notifications Changes

8a80ed9

Synchronize codebase against latest version of Icinga/icinga-go-library#145, containing package changes.

oxzi removed their assignment Sep 9, 2025

oxzi mentioned this pull request Sep 9, 2025

Move Rule evaluation to Source Icinga/icinga-notifications#324

Draft

yhabteab self-assigned this Sep 10, 2025

sukhwinder33445 and others added 21 commits October 21, 2025 17:00

pkg/rpc/rpc.go: Remove unused variable from RPC struct

b6a6da1

pkg/plugin/plugin.go: Plugin shutdown should wait for pending resposes

0d7cda4

pkg/rpc/rpc.go: rpc.Close() should not cause rpc.Done()

dfc046c

pkg/rpc/rpc.go: SetErr() calls rpc.Close()

97a5c49

pkg/rpc/rpc.go: Remove method SetErr as it is only used once

1058736

pkg/rpc/rpc.go: Rename err variables

a1770aa

pkg/rpc/rpc.go: Add helper function to avoid multiple unlock calls

ee03f11

channels: Use incident.severity instead of event.severity

854eb38

Plugin#ConfigOptions: Remove placeholder and use default instead

e7892c5

plugin: Document ConfigOption's Help field

7e4e265

Format notification subject and message depending on event type

6e557fe

Switch to icinga-go-library

731aab7

Use utils.IterateOrderedMap() as intended, via for:=range (require Go…

9630e82

… 1.23)

internal/utils: Cleanup and IGL unification

8c3cc2d

With #64 and #127 being merged, most of the internal/utils package is moved to the IGL and can be removed here. This is another step to unify our Go codebase.

Drop object_extra_tags & all its references

89dce8b

Use the newly introduced notifications event utils from igl

e2de424

notifications: Fix import after IGL import

2bf06de

notifications.source.Client: Remove unused cfg

f684950

oxzi force-pushed the notifications branch from 6d45c75 to f684950 Compare October 21, 2025 15:00

oxzi changed the title ~~Add a common notifications client & its utilities~~ Import notifications packages Oct 21, 2025

oxzi requested a review from julianbrost October 21, 2025 15:12

oxzi marked this pull request as draft October 22, 2025 11:27

notifications: Reintroduce Extra Tags

6600889

This reverts commit 89dce8b and adds ExtraTags to event.Event, which was not yet imported here at the time of the commit.

oxzi marked this pull request as ready for review October 22, 2025 16:05

julianbrost approved these changes Oct 27, 2025

View reviewed changes

julianbrost merged commit 1f5f18e into main Oct 27, 2025
15 checks passed

julianbrost deleted the notifications branch October 27, 2025 14:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Import notifications packages #145

Import notifications packages #145

yhabteab commented Aug 6, 2025 •

edited by oxzi

Loading

Uh oh!

julianbrost commented Aug 6, 2025

Uh oh!

lippserd commented Aug 19, 2025

Uh oh!

oxzi commented Sep 2, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yhabteab commented Sep 5, 2025

Uh oh!

oxzi commented Sep 9, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Import notifications packages #145

Import notifications packages #145

Conversation

yhabteab commented Aug 6, 2025 • edited by oxzi Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

julianbrost commented Aug 6, 2025

Uh oh!

lippserd commented Aug 19, 2025

Uh oh!

oxzi commented Sep 2, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yhabteab commented Sep 5, 2025

Uh oh!

oxzi commented Sep 9, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

yhabteab commented Aug 6, 2025 •

edited by oxzi

Loading