Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix PluginOutputHookImplementation gets called twice #5271 #5272

Merged
merged 4 commits into from
Oct 8, 2024

Conversation

moreamazingnick
Copy link
Contributor

Concatenate Output.

This might break workarounds used implemented in a PluginOutputHookImplementation but I haven't found any out in the wild.

This removes the annoying space between the first line and the other lines in the monitoring module plugin output

Alternatives :
Introduce a monitoring setting that disables this fix for a fast switch back in case this breaks something

Best Regards
Nicolas

@cla-bot cla-bot bot added the cla/signed label Oct 7, 2024
@nilmerg
Copy link
Member

nilmerg commented Oct 7, 2024

This might break workarounds used implemented in a PluginOutputHookImplementation but I haven't found any out in the wild.

Yeah. Though, I think mentioning this in the upgrade documentation should suffice. Please adjust this as well.

@moreamazingnick
Copy link
Contributor Author

@nilmerg do you mean I should edit this as well?
https://github.com/Icinga/icingaweb2/blob/main/CHANGELOG.md

@nilmerg
Copy link
Member

nilmerg commented Oct 7, 2024

No, the upgrade documentation. You can refer to the 2.11.x framework changes to get an idea how.

@moreamazingnick
Copy link
Contributor Author

Something like that:

Upgrading to Icinga Web 2.12.2

Framework changes affecting third-party code

  • (monitoring/ido) When rendering the Icinga check output, the output and long_output fields are now concatenated with a newline (\n) before any post-processing occurs, such as through a PluginOutputHook

@nilmerg
Copy link
Member

nilmerg commented Oct 7, 2024

Yep. But instead of (monitoring/ido), mention the absolute class path of the hook. (With code highlighting using single backticks)

doc/80-Upgrading.md Outdated Show resolved Hide resolved
Copy link
Member

@nilmerg nilmerg left a comment

Choose a reason for hiding this comment

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

LGTM!

@nilmerg nilmerg linked an issue Oct 8, 2024 that may be closed by this pull request
@nilmerg nilmerg added this to the 2.12.2 milestone Oct 8, 2024
@nilmerg nilmerg added enhancement New feature or improvement area/framework Affects third party integration/development labels Oct 8, 2024
@nilmerg nilmerg merged commit bc47867 into Icinga:main Oct 8, 2024
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/framework Affects third party integration/development cla/signed enhancement New feature or improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PluginOutputRenderer gets called twice in monitoring module
2 participants