feat(tools/readme_linter): Check for global configuration section

.gitignore

@@ -6,6 +6,7 @@
 /tools/package_lxd_test/package_lxd_test
 /tools/license_checker/license_checker*
 /tools/readme_config_includer/generator*
+/tools/readme_linter/readme_linter*
 /tools/custom_builder/custom_builder*
 /vendor
 .DS_Store

docs/includes/plugin_config.md

@@ -3,4 +3,4 @@ additional global and plugin configuration settings. These settings are used to
 modify metrics, tags, and field or create aliases and configure ordering, etc.
 See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 
-[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md
+[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins

plugins/inputs/example/README.md

@@ -13,7 +13,7 @@ additional global and plugin configuration settings. These settings are used to
 modify metrics, tags, and field or create aliases and configure ordering, etc.
 See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 
-[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md
+[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins
 
 ## Configuration
 
@@ -75,13 +75,13 @@ SELECT max(field1), mean(field1), min(field1) FROM measurement1 WHERE tag1=bar A
 This optional section can provide basic troubleshooting steps that a user can
 perform.
 
-## Example
+## Example Output
 
 This section shows example output in Line Protocol format.  You can often use
 `telegraf --input-filter <plugin-name> --test` or use the `file` output to get
 this information.
 
-```shell
+```text
 measurement1,tag1=foo,tag2=bar field1=1i,field2=2.1 1453831884664956455
 measurement2,tag1=foo,tag2=bar,tag3=baz field3=1i 1453831884664956455
 ```

plugins/inputs/netflow/README.md

@@ -15,6 +15,15 @@ Definitions for IPFIX are according to [IANA assignement document][IPFIX doc].
 [ASA extensions]:   https://www.cisco.com/c/en/us/td/docs/security/asa/special/netflow/asa_netflow.html
 [IPFIX doc]:        https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-nat-type
 
+## Global configuration options <!-- @/docs/includes/plugin_config.md -->
+
+In addition to the plugin-specific configuration settings, plugins support
+additional global and plugin configuration settings. These settings are used to
+modify metrics, tags, and field or create aliases and configure ordering, etc.
+See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
+
+[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins
+
 ## Configuration
 
 ```toml @sample.conf

tools/readme_linter/main.go

@@ -43,7 +43,7 @@ var rules rulesMap
 func init() {
 	rules = make(rulesMap)
 
-	//rules for all plugin types
+	// Rules for all plugin types
 	all := []ruleFunc{
 		firstSection,
 		noLongLinesInParagraphs(80),
@@ -54,13 +54,35 @@ func init() {
 		rules[i] = all
 	}
 
-	inputRules := []ruleFunc{
+	// Rules for input plugins
+	rules[pluginInput] = append(rules[pluginInput], []ruleFunc{
 		requiredSectionsClose([]string{
 			"Example Output",
 			"Metrics",
+			"Global configuration options",
 		}),
-	}
-	rules[pluginInput] = append(rules[pluginInput], inputRules...)
+	}...)
+
+	// Rules for output plugins
+	rules[pluginOutput] = append(rules[pluginOutput], []ruleFunc{
+		requiredSectionsClose([]string{
+			"Global configuration options",
+		}),
+	}...)
+
+	// Rules for processor pluings
+	rules[pluginProcessor] = append(rules[pluginProcessor], []ruleFunc{
+		requiredSectionsClose([]string{
+			"Global configuration options",
+		}),
+	}...)
+
+	// Rules for aggregator pluings
+	rules[pluginAggregator] = append(rules[pluginAggregator], []ruleFunc{
+		requiredSectionsClose([]string{
+			"Global configuration options",
+		}),
+	}...)
 }
 
 func checkFile(filename string, pluginType plugin, sourceFlag bool) (bool, error) {

tools/readme_linter/rules.go

@@ -52,9 +52,9 @@ func requiredSections(t *T, root ast.Node, headings []string) error {
 		if child == nil {
 			continue
 		}
-		title := string(child.Text(t.markdown))
+		title := strings.TrimSpace(string(child.Text(t.markdown)))
 		if headingsSet.has(title) && h.Level != expectedLevel {
-			t.assertNodef(n, "has required section '%s' but wrong heading level. Expected level %d, found %d",
+			t.assertNodef(n, "has required section %q but wrong heading level. Expected level %d, found %d",
 				title, expectedLevel, h.Level)
 		}
 
@@ -63,7 +63,7 @@ func requiredSections(t *T, root ast.Node, headings []string) error {
 
 	headingsSet.forEach(func(title string) {
 		if _, exists := titleCounts[title]; !exists {
-			t.assertf("missing required section '%s'", title)
+			t.assertf("missing required section %q", title)
 		}
 	})
 
@@ -157,7 +157,7 @@ func configSection(t *T, root ast.Node) error {
 	}
 
 	if config == nil {
-		t.assertf("missing section '%s'", expectedTitle)
+		t.assertf("missing required section %q", expectedTitle)
 		return nil
 	}