search

sensu / catalog

Monitoring as code for Sensu Go. "There's a template for that!"
8 stars 4 forks source link

Update Readme with influxdbv2 compatibility info #238

Closed jspaleta closed 2 years ago

jspaleta commented 2 years ago

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

asachs01 commented 2 years ago

@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 commented 2 years ago

@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.