docs(go.d): add UI configuration instructions and restructure Configuration section (#20975)
Ilya Mashchenko committed
Sep 14, 2025 at 13:17 UTC
83c2d214d859115f5d6d89b8df27290d75e0ac16
1 file changed
+47
-31
integrations/templates/setup.md
+47
-31
@@ -30,7 +30,51 @@ No action required.
30
[% endif %]
31
### Configuration
32
33
-#### File
33
+#### Options
34
+
35
+[[ entry.setup.configuration.options.description ]]
36
+
37
+[% if entry.setup.configuration.options.list %]
38
+[% if entry.setup.configuration.options.folding.enabled and not clean %]
39
+{% details open=true summary="[[ entry.setup.configuration.options.folding.title ]]" %}
40
+[% endif %]
41
+| Name | Description | Default | Required |
42
+|:----|:-----------|:-------|:--------:|
43
+[% for item in entry.setup.configuration.options.list %]
44
+| [[ strfy(item.name) ]] | [[ strfy(item.description) ]] | [[ strfy(item.default_value) ]] | [[ strfy(item.required) ]] |
45
+[% endfor %]
46
+
47
+[% for item in entry.setup.configuration.options.list %]
48
+[% if 'detailed_description' in item %]
49
+##### [[ item.name ]]
50
+
51
+[[ item.detailed_description ]]
52
+
53
+[% endif %]
54
+[% endfor %]
55
+[% if entry.setup.configuration.options.folding.enabled and not clean %]
56
+{% /details %}
57
+[% endif %]
58
+[% elif not entry.setup.configuration.options.description %]
59
+There are no configuration options.
60
+
61
+[% endif %]
62
+
63
+[% if entry.meta.plugin_name == 'go.d.plugin' %]
64
+#### via UI
65
+
66
+The **[[ entry.meta.module_name ]]** collector can be configured directly through the Netdata web interface:
67
+
68
+1. Go to **Nodes**.
69
+2. Select the node **where you want the [[ entry.meta.module_name ]] data-collection job to run** and click the :gear: (**Configure this node**). This node will be responsible for collecting metrics.
70
+3. The **Collectors → Jobs** view opens by default.
71
+4. In the Search box, type _[[ entry.meta.module_name ]]_ (or scroll the list) to locate the **[[ entry.meta.module_name ]]** collector.
72
+5. Click the **+** next to the **[[ entry.meta.module_name ]]** collector to add a new job.
73
+6. Fill in the job fields, then **Test** the configuration and **Submit**.
74
+
75
+[% endif %]
76
+
77
+#### via File
78
79
[% if entry.setup.configuration.file.name %]
80
The configuration file name for this integration is `[[ entry.setup.configuration.file.name ]]`.
@@ -64,40 +108,12 @@ sudo ./edit-config [[ entry.setup.configuration.file.name ]]
108
[% else %]
109
There is no configuration file.
110
[% endif %]
67
-#### Options
68
-
69
-[[ entry.setup.configuration.options.description ]]
70
-
71
-[% if entry.setup.configuration.options.list %]
72
-[% if entry.setup.configuration.options.folding.enabled and not clean %]
73
-{% details open=true summary="[[ entry.setup.configuration.options.folding.title ]]" %}
74
-[% endif %]
75
-| Name | Description | Default | Required |
76
-|:----|:-----------|:-------|:--------:|
77
-[% for item in entry.setup.configuration.options.list %]
78
-| [[ strfy(item.name) ]] | [[ strfy(item.description) ]] | [[ strfy(item.default_value) ]] | [[ strfy(item.required) ]] |
79
-[% endfor %]
80
-
81
-[% for item in entry.setup.configuration.options.list %]
82
-[% if 'detailed_description' in item %]
83
-##### [[ item.name ]]
84
-
85
-[[ item.detailed_description ]]
86
-
87
-[% endif %]
88
-[% endfor %]
89
-[% if entry.setup.configuration.options.folding.enabled and not clean %]
90
-{% /details %}
91
-[% endif %]
92
-[% elif not entry.setup.configuration.options.description %]
93
-There are no configuration options.
111
95
-[% endif %]
96
-#### Examples
112
+##### Examples
113
[% if entry.setup.configuration.examples.list %]
114
115
[% for example in entry.setup.configuration.examples.list %]
100
-##### [[ example.name ]]
116
+###### [[ example.name ]]
117
118
[[ example.description ]]
119