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

Update Readme with influxdbv2 compatibility info #238

Merged
merged 2 commits into from
May 11, 2022

Conversation

jspaleta
Copy link
Contributor

No description provided.

@jspaleta jspaleta self-assigned this Apr 28, 2022
Copy link
Contributor

@asachs01 asachs01 left a comment

Choose a reason for hiding this comment

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

@jspaleta would it be worth adding more explicit instructions for folks to know what they need to configure with buckets and such?

@calebhailey calebhailey requested a review from thoward May 4, 2022 22:44
@jspaleta
Copy link
Contributor Author

@asachs01
You have a pointer to more explicitly instructions than the reference I've added?

@asachs01
Copy link
Contributor

@jspaleta this issue in the Unpoller repo covers creating the bucket and the requisite Influx config. I think the more detail we add here, the better. This way, users won't have to try and hunt down something when we could have a tailored example ready.

@jspaleta
Copy link
Contributor Author

@asachs01
That issue you point to references the official documentation I've added.

I'm not sure pointing to an explicit example of how to configure an external service is going to add any value for a new Sensu user beyond the reference to documentation written and supported by the external technology maintainers.

For example: the desired explicit instructions make reference to the influx cli executables sensu does not provide. I guess we'd also have to add cross platform instructions for the influx cli tool so they could use the explicit example verbatim.

If we followed this as a common practice for all integrations that require an external service to be pre-configured a specific way...we'd be on the hook for a significant amount of documentation material for technology we interact with. There is a level of detail for configuring an external service that is out of scope for an integration readme.

I think pointing to official documentation for high profile "gotcha" external service configuration issues is the right balance.

@jspaleta jspaleta merged commit 277ea58 into main May 11, 2022
@jspaleta jspaleta deleted the js/influxdbv2-compat-info branch May 11, 2022 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants