CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve eventhub_consumer input documentation (#8731)

This commit is contained in:
Victor Marinsky 2021-05-20 16:37:01 -04:00 committed by GitHub
parent 468e7e1650
commit 0e55eedd7e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
plugins/inputs/eventhub_consumer/README.md
View File

@ -18,8 +18,6 @@ The main focus for development of this plugin is Azure IoT hub:
## This requires one of the following sets of environment variables to be set: ## This requires one of the following sets of environment variables to be set:
## ##
## 1) Expected Environment Variables: ## 1) Expected Environment Variables:
## - "EVENTHUB_NAMESPACE"
## - "EVENTHUB_NAME"
## - "EVENTHUB_CONNECTION_STRING" ## - "EVENTHUB_CONNECTION_STRING"
## ##
## 2) Expected Environment Variables: ## 2) Expected Environment Variables:
@ -28,8 +26,17 @@ The main focus for development of this plugin is Azure IoT hub:
## - "EVENTHUB_KEY_NAME" ## - "EVENTHUB_KEY_NAME"
## - "EVENTHUB_KEY_VALUE" ## - "EVENTHUB_KEY_VALUE"
## 3) Expected Environment Variables:
## - "EVENTHUB_NAMESPACE"
## - "EVENTHUB_NAME"
## - "AZURE_TENANT_ID"
## - "AZURE_CLIENT_ID"
## - "AZURE_CLIENT_SECRET"
## Uncommenting the option below will create an Event Hub client based solely on the connection string. ## Uncommenting the option below will create an Event Hub client based solely on the connection string.
## This can either be the associated environment variable or hard coded directly. ## This can either be the associated environment variable or hard coded directly.
## If this option is uncommented, environment variables will be ignored.
## Connection string should contain EventHubName (EntityPath)
# connection_string = "" # connection_string = ""
## Set persistence directory to a valid folder to use a file persister instead of an in-memory persister ## Set persistence directory to a valid folder to use a file persister instead of an in-memory persister

11
plugins/inputs/eventhub_consumer/eventhub_consumer.go
View File

@ -69,8 +69,6 @@ func (*EventHub) SampleConfig() string {
## This requires one of the following sets of environment variables to be set: ## This requires one of the following sets of environment variables to be set:
## ##
## 1) Expected Environment Variables: ## 1) Expected Environment Variables:
## - "EVENTHUB_NAMESPACE"
## - "EVENTHUB_NAME"
## - "EVENTHUB_CONNECTION_STRING" ## - "EVENTHUB_CONNECTION_STRING"
## ##
## 2) Expected Environment Variables: ## 2) Expected Environment Variables:
@ -79,8 +77,17 @@ func (*EventHub) SampleConfig() string {
## - "EVENTHUB_KEY_NAME" ## - "EVENTHUB_KEY_NAME"
## - "EVENTHUB_KEY_VALUE" ## - "EVENTHUB_KEY_VALUE"
## 3) Expected Environment Variables:
## - "EVENTHUB_NAMESPACE"
## - "EVENTHUB_NAME"
## - "AZURE_TENANT_ID"
## - "AZURE_CLIENT_ID"
## - "AZURE_CLIENT_SECRET"
## Uncommenting the option below will create an Event Hub client based solely on the connection string. ## Uncommenting the option below will create an Event Hub client based solely on the connection string.
## This can either be the associated environment variable or hard coded directly. ## This can either be the associated environment variable or hard coded directly.
## If this option is uncommented, environment variables will be ignored.
## Connection string should contain EventHubName (EntityPath)
# connection_string = "" # connection_string = ""
## Set persistence directory to a valid folder to use a file persister instead of an in-memory persister ## Set persistence directory to a valid folder to use a file persister instead of an in-memory persister