Comment optional fields in http_listener sample config

This commit is contained in:
Daniel Nelson 2018-10-12 14:23:29 -07:00
parent 2d8cda02df
commit 37fd99abb9
No known key found for this signature in database
GPG Key ID: CAAD59C9444F6155
2 changed files with 20 additions and 20 deletions

View File

@ -17,32 +17,32 @@ This is a sample configuration for the plugin.
service_address = ":8080" service_address = ":8080"
## Path to listen to. ## Path to listen to.
path = "/telegraf" # path = "/telegraf"
## HTTP methods to accept. ## HTTP methods to accept.
methods = ["POST", "PUT"] # methods = ["POST", "PUT"]
## maximum duration before timing out read of the request ## maximum duration before timing out read of the request
read_timeout = "10s" # read_timeout = "10s"
## maximum duration before timing out write of the response ## maximum duration before timing out write of the response
write_timeout = "10s" # write_timeout = "10s"
## Maximum allowed http request body size in bytes. ## Maximum allowed http request body size in bytes.
## 0 means to use the default of 536,870,912 bytes (500 mebibytes) ## 0 means to use the default of 536,870,912 bytes (500 mebibytes)
max_body_size = 0 # max_body_size = 0
## Set one or more allowed client CA certificate file names to ## Set one or more allowed client CA certificate file names to
## enable mutually authenticated TLS connections ## enable mutually authenticated TLS connections
tls_allowed_cacerts = ["/etc/telegraf/clientca.pem"] # tls_allowed_cacerts = ["/etc/telegraf/clientca.pem"]
## Add service certificate and key ## Add service certificate and key
tls_cert = "/etc/telegraf/cert.pem" # tls_cert = "/etc/telegraf/cert.pem"
tls_key = "/etc/telegraf/key.pem" # tls_key = "/etc/telegraf/key.pem"
## Optional username and password to accept for HTTP basic authentication. ## Optional username and password to accept for HTTP basic authentication.
## You probably want to make sure you have TLS configured above for this. ## You probably want to make sure you have TLS configured above for this.
basic_username = "foobar" # basic_username = "foobar"
basic_password = "barfoo" # basic_password = "barfoo"
## Data format to consume. ## Data format to consume.
## Each data format has its own unique set of configuration options, read ## Each data format has its own unique set of configuration options, read

View File

@ -54,32 +54,32 @@ const sampleConfig = `
service_address = ":8080" service_address = ":8080"
## Path to listen to. ## Path to listen to.
path = "/telegraf" # path = "/telegraf"
## HTTP methods to accept. ## HTTP methods to accept.
methods = ["POST", "PUT"] # methods = ["POST", "PUT"]
## maximum duration before timing out read of the request ## maximum duration before timing out read of the request
read_timeout = "10s" # read_timeout = "10s"
## maximum duration before timing out write of the response ## maximum duration before timing out write of the response
write_timeout = "10s" # write_timeout = "10s"
## Maximum allowed http request body size in bytes. ## Maximum allowed http request body size in bytes.
## 0 means to use the default of 536,870,912 bytes (500 mebibytes) ## 0 means to use the default of 536,870,912 bytes (500 mebibytes)
max_body_size = 0 # max_body_size = 0
## Set one or more allowed client CA certificate file names to ## Set one or more allowed client CA certificate file names to
## enable mutually authenticated TLS connections ## enable mutually authenticated TLS connections
tls_allowed_cacerts = ["/etc/telegraf/clientca.pem"] # tls_allowed_cacerts = ["/etc/telegraf/clientca.pem"]
## Add service certificate and key ## Add service certificate and key
tls_cert = "/etc/telegraf/cert.pem" # tls_cert = "/etc/telegraf/cert.pem"
tls_key = "/etc/telegraf/key.pem" # tls_key = "/etc/telegraf/key.pem"
## Optional username and password to accept for HTTP basic authentication. ## Optional username and password to accept for HTTP basic authentication.
## You probably want to make sure you have TLS configured above for this. ## You probably want to make sure you have TLS configured above for this.
basic_username = "foobar" # basic_username = "foobar"
basic_password = "barfoo" # basic_password = "barfoo"
## Data format to consume. ## Data format to consume.
## Each data format has its own unique set of configuration options, read ## Each data format has its own unique set of configuration options, read