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

Guidance on writing an internal vs external plugin #15880

Open
smithjw opened this issue Sep 14, 2024 · 1 comment
Open

Guidance on writing an internal vs external plugin #15880

smithjw opened this issue Sep 14, 2024 · 1 comment
Labels
feature request Requests for new plugin and for new features to existing plugins

Comments

@smithjw
Copy link

smithjw commented Sep 14, 2024

Use Case

I've started (and almost completed) a new Webhook plugin for Telegraf (based on the existing webhook plugins) that will receive requests from Jamf Pro (a device management framework - info on their webhooks here). From an ease of consumption point of view, raising a PR to have this included in the main project would mean that other Systems Engineers could easily consume this data but I'm unsure whether this Input is too niche for the project.

There is already some great documentation around writing new plugins (even using the existing Webhook inputs as a template to create new ones), but there isn't clear guidance on whether this sort of niche plugin should be merged into the main project.

Expected behavior

Clear guidance on what makes a good plugin to be included in the main project.

Actual behavior

N/A

Additional info

My initial work on the new Webhook plugins can be found here https://github.com/smithjw/telegraf/tree/feat/jamf_webhooks/plugins/inputs/webhooks/jamf

@smithjw smithjw added the feature request Requests for new plugin and for new features to existing plugins label Sep 14, 2024
@srebhan
Copy link
Member

srebhan commented Oct 2, 2024

@smithjw your question is not easy to answer and I think it's a case-by-case decision. I tend to accepting such a plugin upstream as I do see a clear use-case on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Requests for new plugin and for new features to existing plugins
Projects
None yet
Development

No branches or pull requests

2 participants