Improve eventhub_consumer input documentation#8731
Improve eventhub_consumer input documentation#8731ssoroka merged 4 commits intoinfluxdata:masterfrom
Conversation
- keep only EVENTHUB_CONNECTION_STRING in set influxdata#1 as name and namespace are taken from connection string - add env vars set influxdata#3 to show how to connect to eventhub using service principal - comment that env vars are ignored when connection_string option is specified - comment on importance of EntityPath in connection_string - use json as default data format, as it's used more often with eventhubs
- Addresses issues issues like influxdata#8643
There was a problem hiding this comment.
Thanks so much for the pull request!
🤝 ✒️ Just a reminder that the CLA has not yet been signed, and we'll need it before merging. Please sign the CLA when you get a chance, then post a comment here saying !signed-cla
|
!signed-cla |
| ## Each data format has its own unique set of configuration options, read | ||
| ## more about them here: | ||
| ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md | ||
| data_format = "influx" |
There was a problem hiding this comment.
default should probably be left at influx.
There was a problem hiding this comment.
Thank you for a quick and thorough review!
No problem, I can change it back, but are you absolutely sure about it? influx format is not what you see every day in kafka topics, json from the other side is one of the most popular options. The most popular should probably be default.
That line was the main reason of spending 2h investigating what's going on when I started using the plugin. The same line is the main reason #8643 was opened, because if the format is not correct, the message silently disappears.
Please, consider and let me know.
There was a problem hiding this comment.
Nvm, I moved back to influx, json docs have enough examples and there is a clear link to other data formats above this line.
To address issues like #8643 I will open another PR to improve logging when received data doesn't correspond to the specified format.
|
|
||
| 1. Create an Azure IoT Hub by following any of the guides provided here: https://docs.microsoft.com/en-us/azure/iot-hub/ | ||
| 2. Create a device, for example a [simulated Raspberry Pi](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-raspberry-pi-web-simulator-get-started) | ||
| 3. The connection string needed for the plugin is located under *Shared access policies*, both the *iothubowner* and *service* policies should work |
There was a problem hiding this comment.
this change is missing from sampleConfig, they should match.
ssoroka
left a comment
There was a problem hiding this comment.
JSON example probably doesn't belong here and is better off with the json configuration documentation. We could link there instead.
- remove json example - revert md format change in Readme - revent default format change
61a3bb6 to
5c84c15
Compare
|
@ssoroka Can we please find time to re-review this. Should be quick. Just a documentation improvement. I have another eventhub improvement coming. Thanks. |
|
Thanks for the contribution :) |
This PR improves documentation (README and sample config) for eventhub_consumer input plugin: