Update config file installed by packages

This updates the config file to: * Have all config options that do not change the default to be commented out * Removes old config options that are no longer available * Updates config options to new defaults based on prior bugs and tuning recommendations Fixes #7320 Fixes #7504
2016-10-24 15:16:29 -06:00 · 2016-10-24 15:16:29 -06:00 · eb3b45d3c7
parent 6fa145943a
commit eb3b45d3c7
1 changed files with 220 additions and 98 deletions
--- a/etc/config.sample.toml
+++ b/etc/config.sample.toml
@ -1,10 +1,15 @@
 ### Welcome to the InfluxDB configuration file.

+# The values in this file override the default values used by the system if
+# a config option is not specified.  The commented out lines are the the configuration
+# field and the default value used.  Uncommentting a line and changing the value
+# will change the value used at runtime when the process is restarted.
+
 # Once every 24 hours InfluxDB will report usage data to usage.influxdata.com
 # The data includes a random ID, os, arch, version, the number of series and other
 # usage data. No data from user databases is ever transmitted.
 # Change this option to true to disable reporting.
-reporting-disabled = false
+# reporting-disabled = false

 # we'll try to get the hostname automatically, but if it the os returns something
 # that isn't resolvable by other servers in the cluster, use this option to
@ -22,14 +27,11 @@ reporting-disabled = false
  # Where the metadata/raft database is stored
  dir = "/var/lib/influxdb/meta"

-  retention-autocreate = true
+  # Automatically create a default retention policy when creating a database.
+  # retention-autocreate = true

  # If log messages are printed for the meta service
-  logging-enabled = true
-  pprof-enabled = false
-
-  # The default duration for leases.
-  lease-duration = "1m0s"
+  # logging-enabled = true

 ###
 ### [data]
@ -41,14 +43,11 @@ reporting-disabled = false
 ###

 [data]
-  # Controls if this node holds time series data shards in the cluster
-  enabled = true
-
+  # The directory where the TSM storage engine stores TSM files.
  dir = "/var/lib/influxdb/data"

-  # These are the WAL settings for the storage engine >= 0.9.3
+  # The directory where the TSM storage engine stores WAL files.
  wal-dir = "/var/lib/influxdb/wal"
-  wal-logging-enabled = true

  # Trace logging provides more verbose output around the tsm engine. Turning
  # this on can provide more useful output for debugging tsm engine issues.
@ -62,7 +61,7 @@ reporting-disabled = false

  # CacheMaxMemorySize is the maximum size a shard's cache can
  # reach before it starts rejecting writes.
-  # cache-max-memory-size = 524288000
+  # cache-max-memory-size = 1048576000

  # CacheSnapshotMemorySize is the size at which the engine will
  # snapshot the cache and write it to a TSM file, freeing up memory
@ -71,21 +70,22 @@ reporting-disabled = false
  # CacheSnapshotWriteColdDuration is the length of time at
  # which the engine will snapshot the cache and write it to
  # a new TSM file if the shard hasn't received writes or deletes
-  # cache-snapshot-write-cold-duration = "1h"
-
-  # MinCompactionFileCount is the minimum number of TSM files
-  # that need to exist before a compaction cycle will run
-  # compact-min-file-count = 3
+  # cache-snapshot-write-cold-duration = "10m"

  # CompactFullWriteColdDuration is the duration at which the engine
  # will compact all TSM files in a shard if it hasn't received a
  # write or delete
-  # compact-full-write-cold-duration = "24h"
+  # compact-full-write-cold-duration = "4h"

-  # MaxPointsPerBlock is the maximum number of points in an encoded
-  # block in a TSM file. Larger numbers may yield better compression
-  # but could incur a performance penalty when querying
-  # max-points-per-block = 1000
+  # The maximum series allowed per database before writes are dropped.  This limit can prevent
+  # high cardinality issues at the database level.  This limit can be disabled by setting it to
+  # 0.
+  # max-series-per-database = 1000000
+
+  # The maximum number of tag values per tag that are allowed before writes are dropped.  This limit
+  # can prevent high cardinality tag values from being written to a measurement.  This limit can be
+  # disabled by setting it to 0.
+  # max-values-per-tag = 100000

 ###
 ### [coordinator]
@ -93,14 +93,37 @@ reporting-disabled = false
 ### Controls the clustering service configuration.
 ###

-[coordinator]
-  write-timeout = "10s"
-  max-concurrent-queries = 0
-  query-timeout = "0"
-  log-queries-after = "0"
-  max-select-point = 0
-  max-select-series = 0
-  max-select-buckets = 0
+# [coordinator]
+  # The default time a write request will wait until a "timeout" error is returned to the caller.
+  # write-timeout = "10s"
+
+  # The maximum number of concurrent queries allowed to be executing at one time.  If a query is
+  # executed and exceeds this limit, an error is returned to the caller.  This limit can be disabled
+  # by setting it to 0.
+  # max-concurrent-queries = 0
+
+  # The maximum time a query will is allowed to execute before being killed by the system.  This limit
+  # can help prevent run away queries.  Setting the value to 0 disables the limit.
+  # query-timeout = "0s"
+
+  # The the time threshold when a query will be logged as a slow query.  This limit can be set to help
+  # discover slow or resource intensive queries.  Setting the value to 0 disables the slow query logging.
+  # log-queries-after = "0s"
+
+  # The maximum number of points a SELECT can process.  A value of 0 will make the maximum
+  # point count unlimited.
+  # max-select-point = 0
+
+  # The maximum number of series a SELECT can run.  A value of 0 will make the maximum series
+  # count unlimited.
+
+  # The maximum number of series a SELECT can run. A value of zero will make the maximum series
+  # count unlimited.
+  # max-select-series = 0
+
+  # The maxium number of group by time bucket a SELECt can create.  A value of zero will max the maximum
+  # number of buckets unlimited.
+  # max-select-buckets = 0

 ###
 ### [retention]
@ -108,9 +131,12 @@ reporting-disabled = false
 ### Controls the enforcement of retention policies for evicting old data.
 ###

-[retention]
-  enabled = true
-  check-interval = "30m"
+# [retention]
+  # Determines whether retention policy enforcment enabled.
+  # enabled = true
+
+  # The interval of time when retention policy enforcement checks run.
+  # check-interval = "30m"

 ###
 ### [shard-precreation]
@ -120,10 +146,16 @@ reporting-disabled = false
 ### future, will ever be created. Shards are never precreated that would be wholly
 ### or partially in the past.

-[shard-precreation]
-  enabled = true
-  check-interval = "10m"
-  advance-period = "30m"
+# [shard-precreation]
+  # Determines whether shard pre-creation service is enabled.
+  # enabled = true
+
+  # The interval of time when the check to pre-create new shards runs.
+  # check-interval = "10m"
+
+  # The default period ahead of the endtime of a shard group that its successor
+  # group is created.
+  # advance-period = "30m"

 ###
 ### Controls the system self-monitoring, statistics and diagnostics.
@ -134,10 +166,15 @@ reporting-disabled = false
 ### and a replication factor of 1, if it does not exist. In all cases the
 ### this retention policy is configured as the default for the database.

-[monitor]
-  store-enabled = true # Whether to record statistics internally.
-  store-database = "_internal" # The destination database for recorded statistics
-  store-interval = "10s" # The interval at which to record statistics
+# [monitor]
+  # Whether to record statistics internally.
+  # store-enabled = true
+
+  # The destination database for recorded statistics
+  # store-database = "_internal"
+
+  # The interval at which to record statistics
+  # store-interval = "10s"

 ###
 ### [admin]
@ -146,11 +183,18 @@ reporting-disabled = false
 ### enabled for the admin interface, HTTPS must also be enabled on the [http] service.
 ###

-[admin]
-  enabled = true
-  bind-address = ":8083"
-  https-enabled = false
-  https-certificate = "/etc/ssl/influxdb.pem"
+# [admin]
+  # Determines whether the admin service is enabled.
+  # enabled = true
+
+  # The default bind address used by the admin service.
+  # bind-address = ":8083"
+
+  # Whether the admin service should use HTTPS.
+  # https-enabled = false
+
+  # The SSL certificate used when HTTPS is enabled.
+  # https-certificate = "/etc/ssl/influxdb.pem"

 ###
 ### [http]
@ -159,21 +203,52 @@ reporting-disabled = false
 ### mechanism for getting data into and out of InfluxDB.
 ###

-[http]
-  enabled = true
-  bind-address = ":8086"
-  auth-enabled = false
-  log-enabled = true
-  write-tracing = false
-  pprof-enabled = false
-  https-enabled = false
-  https-certificate = "/etc/ssl/influxdb.pem"
-  ### Use a separate private key location.
-  # https-private-key = ""
-  max-row-limit = 10000
-  realm = "InfluxDB"
+# [http]
+  # Determines whether HTTP endpoint is enabled.
+  # enabled = true

-  unix-socket-enabled = false # enable http service over unix domain socket
+  # The bind address used by the HTTP service.
+  # bind-address = ":8086"
+
+  # Determines whether HTTP authentication is enabled.
+  # auth-enabled = false
+
+  # The default realm sent back when issuing a basic auth challenge.
+  # realm = "InfluxDB"
+
+  # Determines whether HTTP request logging is enable.d
+  # log-enabled = true
+
+  # Determines whether detailed write logging is enabled.
+  # write-tracing = false
+
+  # Determines whether the pprof endpoint is enabled.  This endpoint is used for
+  # troubleshooting and monitoring.
+  # pprof-enabled = true
+
+  # Determines whether HTTPS is enabled.
+  # https-enabled = false
+
+  # The SSL certificate to use when HTTPS is enabled.
+  # https-certificate = "/etc/ssl/influxdb.pem"
+
+  # Use a separate private key location.
+  # https-private-key = ""
+
+  # The JWT auth shared secret to validate requests using JSON web tokens.
+  # shared-sercret = ""
+
+  # The default chunk size for result sets that should be chunked.
+  # max-row-limit = 10000
+
+  # The maximum number of HTTP connections that may be open at once.  New connections that
+  # would exceed this limit are dropped.  Setting this value to 0 disables the limit.
+  # max-connection-limit = 0
+
+  # Enable http service over unix domain socket
+  # unix-socket-enabled = false
+
+  # The path of the unix domain socket.
  # bind-socket = "/var/run/influxdb.sock"

 ###
@ -183,10 +258,24 @@ reporting-disabled = false
 ### received by the InfluxDB host.
 ###

-[subscriber]
-  enabled = true
+# [subscriber]
+  # Determines whether the subscriber service is enabled.
+  # enabled = true
+
+  # The default timeout for HTTP writes to subscribers.
  # http-timeout = "30s"
+
+  # Allows insecure HTTPS connections to subscribers.  This is useful when testing with self-
+  # signed certificates.
+  # insecure-skip-verify = false
+
+  # The path to the PEM encoded CA certs file. If the empty string, the default system certs will be used
+  # ca-certs = ""
+
+  # The number of writer goroutines processing the write channel.
  # write-concurrency = 40
+
+  # The number of in-flight writes buffered in the write channel.
  # write-buffer-size = 1000


@ -196,9 +285,11 @@ reporting-disabled = false
 ### Controls one or many listeners for Graphite data.
 ###

-[[graphite]]
-  enabled = false
+# [[graphite]]
+  # Determines whether the graphite endpoint is enabled.
+  # enabled = false
  # database = "graphite"
+  # retention-policy = ""
  # bind-address = ":2003"
  # protocol = "tcp"
  # consistency-level = "one"
@ -207,10 +298,17 @@ reporting-disabled = false
  # otherwise you could get dropped metrics or poor performance. Batching
  # will buffer points in memory if you have many coming in.

-  # batch-size = 5000 # will flush if this many points get buffered
-  # batch-pending = 10 # number of batches that may be pending in memory
-  # batch-timeout = "1s" # will flush at least this often even if we haven't hit buffer limit
-  # udp-read-buffer = 0 # UDP Read buffer size, 0 means OS default. UDP listener will fail if set above OS max.
+  # Flush if this many points get buffered
+  # batch-size = 5000
+
+  # number of batches that may be pending in memory
+  # batch-pending = 10
+
+  # Flush at least this often even if we haven't hit buffer limit
+  # batch-timeout = "1s"
+
+  # UDP Read buffer size, 0 means OS default. UDP listener will fail if set above OS max.
+  # udp-read-buffer = 0

  ### This string joins multiple matching 'measurement' values providing more control over the final measurement name.
  # separator = "."
@ -235,20 +333,28 @@ reporting-disabled = false
 ### Controls one or many listeners for collectd data.
 ###

-[[collectd]]
-  enabled = false
-  # bind-address = ""
-  # database = ""
-  # typesdb = ""
+# [[collectd]]
+  # enabled = false
+  # bind-address = ":25826"
+  # database = "collectd"
+  # retention-policy = ""
+  # typesdb = "/usr/share/collectd/types.db"

  # These next lines control how batching works. You should have this enabled
  # otherwise you could get dropped metrics or poor performance. Batching
  # will buffer points in memory if you have many coming in.

-  # batch-size = 1000 # will flush if this many points get buffered
-  # batch-pending = 5 # number of batches that may be pending in memory
-  # batch-timeout = "1s" # will flush at least this often even if we haven't hit buffer limit
-  # read-buffer = 0 # UDP Read buffer size, 0 means OS default. UDP listener will fail if set above OS max.
+  # Flush if this many points get buffered
+  # batch-size = 5000
+
+  # Number of batches that may be pending in memory
+  # batch-pending = 10
+
+  # Flush at least this often even if we haven't hit buffer limit
+  # batch-timeout = "10s"
+
+  # UDP Read buffer size, 0 means OS default. UDP listener will fail if set above OS max.
+  # read-buffer = 0

 ###
 ### [opentsdb]
@ -256,23 +362,30 @@ reporting-disabled = false
 ### Controls one or many listeners for OpenTSDB data.
 ###

-[[opentsdb]]
-  enabled = false
+# [[opentsdb]]
+  # enabled = false
  # bind-address = ":4242"
  # database = "opentsdb"
  # retention-policy = ""
  # consistency-level = "one"
  # tls-enabled = false
-  # certificate= ""
-  # log-point-errors = true # Log an error for every malformed point.
+  # certificate= "/etc/ssl/influxdb.pem"
+
+  # Log an error for every malformed point.
+  # log-point-errors = true

  # These next lines control how batching works. You should have this enabled
  # otherwise you could get dropped metrics or poor performance. Only points
  # metrics received over the telnet protocol undergo batching.

-  # batch-size = 1000 # will flush if this many points get buffered
-  # batch-pending = 5 # number of batches that may be pending in memory
-  # batch-timeout = "1s" # will flush at least this often even if we haven't hit buffer limit
+  # Flush if this many points get buffered
+  # batch-size = 1000
+
+  # Number of batches that may be pending in memory
+  # batch-pending = 5
+
+  # Flush at least this often even if we haven't hit buffer limit
+  # batch-timeout = "1s"

 ###
 ### [[udp]]
@ -280,9 +393,9 @@ reporting-disabled = false
 ### Controls the listeners for InfluxDB line protocol data via UDP.
 ###

-[[udp]]
-  enabled = false
-  # bind-address = ""
+# [[udp]]
+  # enabled = false
+  # bind-address = ":8089"
  # database = "udp"
  # retention-policy = ""

@ -290,13 +403,17 @@ reporting-disabled = false
  # otherwise you could get dropped metrics or poor performance. Batching
  # will buffer points in memory if you have many coming in.

-  # batch-size = 1000 # will flush if this many points get buffered
-  # batch-pending = 5 # number of batches that may be pending in memory
-  # batch-timeout = "1s" # will flush at least this often even if we haven't hit buffer limit
-  # read-buffer = 0 # UDP Read buffer size, 0 means OS default. UDP listener will fail if set above OS max.
+  # Flush if this many points get buffered
+  # batch-size = 5000

-  # set the expected UDP payload size; lower values tend to yield better performance, default is max UDP size 65536
-  # udp-payload-size = 65536
+  # Number of batches that may be pending in memory
+  # batch-pending = 10
+
+  # Will flush at least this often even if we haven't hit buffer limit
+  # batch-timeout = "1s"
+
+  # UDP Read buffer size, 0 means OS default. UDP listener will fail if set above OS max.
+  # read-buffer = 0

 ###
 ### [continuous_queries]
@ -304,7 +421,12 @@ reporting-disabled = false
 ### Controls how continuous queries are run within InfluxDB.
 ###

-[continuous_queries]
-  log-enabled = true
-  enabled = true
-  # run-interval = "1s" # interval for how often continuous queries will be checked if they need to run
+# [continuous_queries]
+  # Determiens whether the continuous query service is enabled.
+  # enabled = true
+
+  # Controls whether queries are logged when executed by the CQ service.
+  # log-enabled = true
+
+  # interval for how often continuous queries will be checked if they need to run
+  # run-interval = "1s"