Cleanup config file

closes #199

internal/config/config.go

@@ -22,6 +22,15 @@ import (
 	"github.com/influxdata/toml/ast"
 )
 
+var (
+	// Default input plugins
+	inputDefaults = []string{"cpu", "mem", "swap", "system", "kernel",
+		"processes", "disk", "diskio"}
+
+	// Default output plugins
+	outputDefaults = []string{"influxdb"}
+)
+
 // Config specifies the URL/user/password for the database that telegraf
 // will be logging to, as well as all the plugins that the user has
 // specified
@@ -135,21 +144,23 @@ func (c *Config) ListTags() string {
 }
 
 var header = `# Telegraf Configuration
-
+#
 # Telegraf is entirely plugin driven. All metrics are gathered from the
 # declared inputs, and sent to the declared outputs.
-
+#
 # Plugins must be declared in here to be active.
 # To deactivate a plugin, comment out the name and any variables.
-
+#
 # Use 'telegraf -config telegraf.conf -test' to see what metrics a config
 # file would generate.
 
+
 # Global tags can be specified here in key="value" format.
 [global_tags]
   # dc = "us-east-1" # will tag all metrics with dc=us-east-1
   # rack = "1a"
 
+
 # Configuration for telegraf agent
 [agent]
   ## Default data collection interval for all inputs
@@ -188,55 +199,72 @@ var header = `# Telegraf Configuration
   omit_hostname = false
 
 
-#
-# OUTPUTS:
-#
-
+###############################################################################
+#                            OUTPUT PLUGINS                                   #
+###############################################################################
 `
 
-var pluginHeader = `
-#
-# INPUTS:
-#
+var inputHeader = `
+
+###############################################################################
+#                            INPUT PLUGINS                                    #
+###############################################################################
 `
 
 var serviceInputHeader = `
-#
-# SERVICE INPUTS:
-#
+
+###############################################################################
+#                            SERVICE INPUT PLUGINS                            #
+###############################################################################
 `
 
 // PrintSampleConfig prints the sample config
-func PrintSampleConfig(pluginFilters []string, outputFilters []string) {
+func PrintSampleConfig(inputFilters []string, outputFilters []string) {
 	fmt.Printf(header)
 
-	// Filter outputs
-	var onames []string
-	for oname := range outputs.Outputs {
-		if len(outputFilters) == 0 || sliceContains(oname, outputFilters) {
-			onames = append(onames, oname)
+	if len(outputFilters) != 0 {
+		printFilteredOutputs(outputFilters, false)
+	} else {
+		printFilteredOutputs(outputDefaults, false)
+		// Print non-default outputs, commented
+		var pnames []string
+		for pname := range outputs.Outputs {
+			if !sliceContains(pname, outputDefaults) {
+				pnames = append(pnames, pname)
+			}
 		}
+		sort.Strings(pnames)
+		printFilteredOutputs(pnames, true)
 	}
-	sort.Strings(onames)
 
-	// Print Outputs
-	for _, oname := range onames {
-		creator := outputs.Outputs[oname]
-		output := creator()
-		printConfig(oname, output, "outputs")
+	fmt.Printf(inputHeader)
+	if len(inputFilters) != 0 {
+		printFilteredInputs(inputFilters, false)
+	} else {
+		printFilteredInputs(inputDefaults, false)
+		// Print non-default inputs, commented
+		var pnames []string
+		for pname := range inputs.Inputs {
+			if !sliceContains(pname, inputDefaults) {
+				pnames = append(pnames, pname)
+			}
+		}
+		sort.Strings(pnames)
+		printFilteredInputs(pnames, true)
 	}
+}
 
+func printFilteredInputs(inputFilters []string, commented bool) {
 	// Filter inputs
 	var pnames []string
 	for pname := range inputs.Inputs {
-		if len(pluginFilters) == 0 || sliceContains(pname, pluginFilters) {
+		if sliceContains(pname, inputFilters) {
 			pnames = append(pnames, pname)
 		}
 	}
 	sort.Strings(pnames)
 
 	// Print Inputs
-	fmt.Printf(pluginHeader)
 	servInputs := make(map[string]telegraf.ServiceInput)
 	for _, pname := range pnames {
 		creator := inputs.Inputs[pname]
@@ -248,13 +276,34 @@ func PrintSampleConfig(pluginFilters []string, outputFilters []string) {
 			continue
 		}
 
-		printConfig(pname, input, "inputs")
+		printConfig(pname, input, "inputs", commented)
 	}
 
 	// Print Service Inputs
+	if len(servInputs) == 0 {
+		return
+	}
 	fmt.Printf(serviceInputHeader)
 	for name, input := range servInputs {
-		printConfig(name, input, "inputs")
+		printConfig(name, input, "inputs", commented)
+	}
+}
+
+func printFilteredOutputs(outputFilters []string, commented bool) {
+	// Filter outputs
+	var onames []string
+	for oname := range outputs.Outputs {
+		if sliceContains(oname, outputFilters) {
+			onames = append(onames, oname)
+		}
+	}
+	sort.Strings(onames)
+
+	// Print Outputs
+	for _, oname := range onames {
+		creator := outputs.Outputs[oname]
+		output := creator()
+		printConfig(oname, output, "outputs", commented)
 	}
 }
 
@@ -263,13 +312,26 @@ type printer interface {
 	SampleConfig() string
 }
 
-func printConfig(name string, p printer, op string) {
-	fmt.Printf("\n# %s\n[[%s.%s]]", p.Description(), op, name)
+func printConfig(name string, p printer, op string, commented bool) {
+	comment := ""
+	if commented {
+		comment = "# "
+	}
+	fmt.Printf("\n%s# %s\n%s[[%s.%s]]", comment, p.Description(), comment,
+		op, name)
+
 	config := p.SampleConfig()
 	if config == "" {
-		fmt.Printf("\n  # no configuration\n")
+		fmt.Printf("\n%s  # no configuration\n\n", comment)
 	} else {
-		fmt.Printf(config)
+		lines := strings.Split(config, "\n")
+		for i, line := range lines {
+			if i == 0 || i == len(lines)-1 {
+				fmt.Print("\n")
+				continue
+			}
+			fmt.Print(comment + line + "\n")
+		}
 	}
 }
 
@@ -285,7 +347,7 @@ func sliceContains(name string, list []string) bool {
 // PrintInputConfig prints the config usage of a single input.
 func PrintInputConfig(name string) error {
 	if creator, ok := inputs.Inputs[name]; ok {
-		printConfig(name, creator(), "inputs")
+		printConfig(name, creator(), "inputs", false)
 	} else {
 		return errors.New(fmt.Sprintf("Input %s not found", name))
 	}
@@ -295,7 +357,7 @@ func PrintInputConfig(name string) error {
 // PrintOutputConfig prints the config usage of a single output.
 func PrintOutputConfig(name string) error {
 	if creator, ok := outputs.Outputs[name]; ok {
-		printConfig(name, creator(), "outputs")
+		printConfig(name, creator(), "outputs", false)
 	} else {
 		return errors.New(fmt.Sprintf("Output %s not found", name))
 	}

plugins/inputs/disque/disque.go

@@ -24,9 +24,8 @@ type Disque struct {
 
 var sampleConfig = `
   ## An array of URI to gather stats about. Specify an ip or hostname
-  ## with optional port and password. ie disque://localhost, disque://10.10.3.33:18832,
-  ## 10.0.0.1:10000, etc.
-
+  ## with optional port and password.
+  ## ie disque://localhost, disque://10.10.3.33:18832, 10.0.0.1:10000, etc.
   ## If no servers are specified, then localhost is used as the host.
   servers = ["localhost"]
 `

plugins/inputs/dns_query/dns_query.go

@@ -35,7 +35,8 @@ var sampleConfig = `
   ## Domains or subdomains to query. "."(root) is default
   domains = ["."] # optional
 
-  ## Query record type. Posible values: A, AAAA, CNAME, MX,  NS, PTR, TXT, SOA, SPF, SRV. Default is "NS"
+  ## Query record type. Default is "A"
+  ## Posible values: A, AAAA, CNAME, MX, NS, PTR, TXT, SOA, SPF, SRV.
   record_type = "A" # optional
 
   ## Dns server port. 53 is default

plugins/inputs/mesos/mesos.go

@@ -34,7 +34,16 @@ var sampleConfig = `
   # A list of Mesos masters, default value is localhost:5050.
   masters = ["localhost:5050"]
   # Metrics groups to be collected, by default, all enabled.
-  master_collections = ["resources","master","system","slaves","frameworks","messages","evqueue","registrar"]
+  master_collections = [
+    "resources",
+    "master",
+    "system",
+    "slaves",
+    "frameworks",
+    "messages",
+    "evqueue",
+    "registrar",
+  ]
 `
 
 // SampleConfig returns a sample configuration block

plugins/inputs/postgresql/postgresql.go

@@ -26,7 +26,8 @@ var ignoredColumns = map[string]bool{"datid": true, "datname": true, "stats_rese
 
 var sampleConfig = `
   ## specify address via a url matching:
-  ##   postgres://[pqgotest[:password]]@localhost[/dbname]?sslmode=[disable|verify-ca|verify-full]
+  ##   postgres://[pqgotest[:password]]@localhost[/dbname]\
+  ##       ?sslmode=[disable|verify-ca|verify-full]
   ## or a simple string:
   ##   host=localhost user=pqotest password=... sslmode=... dbname=app_production
   ##

plugins/inputs/postgresql_extensible/postgresql_extensible.go

@@ -38,38 +38,41 @@ type query []struct {
 var ignoredColumns = map[string]bool{"datid": true, "datname": true, "stats_reset": true}
 
 var sampleConfig = `
-  # specify address via a url matching:
-  #   postgres://[pqgotest[:password]]@localhost[/dbname]?sslmode=[disable|verify-ca|verify-full]
-  # or a simple string:
-  #   host=localhost user=pqotest password=... sslmode=... dbname=app_production
+  ## specify address via a url matching:
+  ##   postgres://[pqgotest[:password]]@localhost[/dbname]\
+  ##       ?sslmode=[disable|verify-ca|verify-full]
+  ## or a simple string:
+  ##   host=localhost user=pqotest password=... sslmode=... dbname=app_production
   #
-  # All connection parameters are optional.  #
-  # Without the dbname parameter, the driver will default to a database
-  # with the same name as the user. This dbname is just for instantiating a
-  # connection with the server and doesn't restrict the databases we are trying
-  # to grab metrics for.
+  ## All connection parameters are optional.  #
+  ## Without the dbname parameter, the driver will default to a database
+  ## with the same name as the user. This dbname is just for instantiating a
+  ## connection with the server and doesn't restrict the databases we are trying
+  ## to grab metrics for.
   #
   address = "host=localhost user=postgres sslmode=disable"
-  # A list of databases to pull metrics about. If not specified, metrics for all
-  # databases are gathered.
-  # databases = ["app_production", "testing"]
+  ## A list of databases to pull metrics about. If not specified, metrics for all
+  ## databases are gathered.
+  ## databases = ["app_production", "testing"]
   #
-  # Define the toml config where the sql queries are stored
-  # New queries can be added, if the withdbname is set to true and there is no databases defined
-  # in the 'databases field', the sql query is ended by a 'is not null' in order to make the query
-  # succeed.
-  # Example :
-  # The sqlquery : "SELECT * FROM pg_stat_database where datname" become "SELECT * FROM pg_stat_database where datname IN ('postgres', 'pgbench')"
-  # because the databases variable was set to ['postgres', 'pgbench' ] and the withdbname was true.
-  # Be careful that if the withdbname is set to false you d'ont have to define the where clause (aka with the dbname)
-  # the tagvalue field is used to define custom tags (separated by comas)
+  ## Define the toml config where the sql queries are stored
+  ## New queries can be added, if the withdbname is set to true and there is no
+  ## databases defined in the 'databases field', the sql query is ended by a
+  ## 'is not null' in order to make the query succeed.
+  ## Example :
+  ## The sqlquery : "SELECT * FROM pg_stat_database where datname" become
+  ## "SELECT * FROM pg_stat_database where datname IN ('postgres', 'pgbench')"
+  ## because the databases variable was set to ['postgres', 'pgbench' ] and the
+  ## withdbname was true. Be careful that if the withdbname is set to false you
+  ## don't have to define the where clause (aka with the dbname) the tagvalue
+  ## field is used to define custom tags (separated by comas)
   #
-  # Structure :
-  # [[inputs.postgresql_extensible.query]]
-  #   sqlquery string
-  #   version string
-  #   withdbname boolean
-  #   tagvalue string (coma separated)
+  ## Structure :
+  ## [[inputs.postgresql_extensible.query]]
+  ##   sqlquery string
+  ##   version string
+  ##   withdbname boolean
+  ##   tagvalue string (coma separated)
   [[inputs.postgresql_extensible.query]]
     sqlquery="SELECT * FROM pg_stat_database"
     version=901

plugins/inputs/prometheus/prometheus.go

@@ -26,10 +26,10 @@ var sampleConfig = `
   ## An array of urls to scrape metrics from.
   urls = ["http://localhost:9100/metrics"]
 
-	### Use SSL but skip chain & host verification
-	# insecure_skip_verify = false
-	### Use bearer token for authorization
-	# bearer_token = /path/to/bearer/token
+  ## Use SSL but skip chain & host verification
+  # insecure_skip_verify = false
+  ## Use bearer token for authorization
+  # bearer_token = /path/to/bearer/token
 `
 
 func (p *Prometheus) SampleConfig() string {