| 1 | ## Setup |
| 2 | |
| 3 | [% if entry.meta.plugin_name == 'go.d.plugin' %] |
| 4 | |
| 5 | You can configure the **[[ entry.meta.module_name ]]** collector in two ways: |
| 6 | |
| 7 | | Method | Best for | How to | |
| 8 | |-----------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| |
| 9 | | [**UI**](#via-ui) | Fast setup without editing files | Go to **Nodes → Configure this node → Collectors → Jobs**, search for **[[ entry.meta.module_name ]]**, then click **+** to add a job. | |
| 10 | | [**File**](#via-file) | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit `[[ entry.setup.configuration.file.name ]]` and add a job. | |
| 11 | |
| 12 | :::important |
| 13 | |
| 14 | UI configuration requires paid Netdata Cloud plan. |
| 15 | |
| 16 | ::: |
| 17 | |
| 18 | [% endif %] |
| 19 | |
| 20 | [% if entry.setup.description %] |
| 21 | [[ entry.setup.description ]] |
| 22 | [% else %] |
| 23 | ### Prerequisites |
| 24 | [% if entry.setup.prerequisites.list %] |
| 25 | |
| 26 | [% for prereq in entry.setup.prerequisites.list %] |
| 27 | #### [[ prereq.title ]] |
| 28 | |
| 29 | [[ prereq.description ]] |
| 30 | |
| 31 | [% endfor %] |
| 32 | |
| 33 | [% else %] |
| 34 | |
| 35 | No action required. |
| 36 | |
| 37 | [% endif %] |
| 38 | ### Configuration |
| 39 | |
| 40 | #### Options |
| 41 | |
| 42 | [[ entry.setup.configuration.options.description ]] |
| 43 | |
| 44 | [% if entry.setup.configuration.options.list %] |
| 45 | [% if entry.setup.configuration.options.folding.enabled and not clean %] |
| 46 | {% details open=true summary="[[ entry.setup.configuration.options.folding.title or 'Config options' ]]" %} |
| 47 | [% endif %] |
| 48 | |
| 49 | [% set has_groups = entry.setup.configuration.options.list | selectattr("group","defined") | list | length > 0 %] |
| 50 | |
| 51 | [% if has_groups %] |
| 52 | | Group | Option | Description | Default | Required | |
| 53 | |:------|:-----|:------------|:--------|:---------:| |
| 54 | [% set ns = namespace(last_group=None) %] |
| 55 | [% for item in entry.setup.configuration.options.list %] |
| 56 | [% set anchor_source = (item.group ~ "-" ~ item.name) if (item.group is defined and item.group) else item.name %] |
| 57 | [% set item_anchor = "option-" ~ anchorfy(anchor_source) %] |
| 58 | | [[ ("**" ~ item.group ~ "**") if (item.group is defined and item.group != ns.last_group) else "" ]] | [[ ("[" ~ strfy(item.name) ~ "](#" ~ item_anchor ~ ")") if ('detailed_description' in item) else strfy(item.name) ]] | [[ strfy(item.description) ]] | [[ strfy(item.default_value) ]] | [[ strfy(item.required) ]] | |
| 59 | [% set ns.last_group = item.group if item.group is defined else ns.last_group %] |
| 60 | [% endfor %] |
| 61 | [% else %] |
| 62 | | Option | Description | Default | Required | |
| 63 | |:-----|:------------|:--------|:---------:| |
| 64 | [% for item in entry.setup.configuration.options.list %] |
| 65 | [% set anchor_source = (item.group ~ "-" ~ item.name) if (item.group is defined and item.group) else item.name %] |
| 66 | [% set item_anchor = "option-" ~ anchorfy(anchor_source) %] |
| 67 | | [[ ("[" ~ strfy(item.name) ~ "](#" ~ item_anchor ~ ")") if ('detailed_description' in item) else strfy(item.name) ]] | [[ strfy(item.description) ]] | [[ strfy(item.default_value) ]] | [[ strfy(item.required) ]] | |
| 68 | [% endfor %] |
| 69 | [% endif %] |
| 70 | |
| 71 | [% for item in entry.setup.configuration.options.list %] |
| 72 | [% if 'detailed_description' in item %] |
| 73 | [% set anchor_source = (item.group ~ "-" ~ item.name) if (item.group is defined and item.group) else item.name %] |
| 74 | <a id="[[ "option-" ~ anchorfy(anchor_source) ]]"></a> |
| 75 | ##### [[ item.name ]] |
| 76 | |
| 77 | [[ item.detailed_description ]] |
| 78 | |
| 79 | [% endif %] |
| 80 | [% endfor %] |
| 81 | |
| 82 | [% if entry.setup.configuration.options.folding.enabled and not clean %] |
| 83 | {% /details %} |
| 84 | [% endif %] |
| 85 | [% elif not entry.setup.configuration.options.description %] |
| 86 | There are no configuration options. |
| 87 | |
| 88 | [% endif %] |
| 89 | |
| 90 | [% if entry.meta.plugin_name == 'go.d.plugin' %] |
| 91 | #### via UI |
| 92 | |
| 93 | Configure the **[[ entry.meta.module_name ]]** collector from the Netdata web interface: |
| 94 | |
| 95 | 1. Go to **Nodes**. |
| 96 | 2. Select the node **where you want the [[ entry.meta.module_name ]] data-collection job to run** and click the :gear: (**Configure this node**). That node will run the data collection. |
| 97 | 3. The **Collectors → Jobs** view opens by default. |
| 98 | 4. In the Search box, type _[[ entry.meta.module_name ]]_ (or scroll the list) to locate the **[[ entry.meta.module_name ]]** collector. |
| 99 | 5. Click the **+** next to the **[[ entry.meta.module_name ]]** collector to add a new job. |
| 100 | 6. Fill in the job fields, then click **Test** to verify the configuration and **Submit** to save. |
| 101 | - **Test** runs the job with the provided settings and shows whether data can be collected. |
| 102 | - If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest. |
| 103 | |
| 104 | [% endif %] |
| 105 | |
| 106 | #### via File |
| 107 | |
| 108 | [% if entry.setup.configuration.file.name %] |
| 109 | The configuration file name for this integration is `[[ entry.setup.configuration.file.name ]]`. |
| 110 | [% if 'section_name' in entry.setup.configuration.file %] |
| 111 | Configuration for this specific integration is located in the `[[ entry.setup.configuration.file.section_name ]]` section within that file. |
| 112 | [% endif %] |
| 113 | |
| 114 | [% if entry.meta.plugin_name == 'go.d.plugin' %] |
| 115 | [% include 'setup/sample-go-config.md' %] |
| 116 | [% elif entry.meta.plugin_name == 'python.d.plugin' %] |
| 117 | [% include 'setup/sample-python-config.md' %] |
| 118 | [% elif entry.meta.plugin_name == 'charts.d.plugin' %] |
| 119 | [% include 'setup/sample-charts-config.md' %] |
| 120 | [% elif entry.meta.plugin_name == 'ioping.plugin' %] |
| 121 | [% include 'setup/sample-charts-config.md' %] |
| 122 | [% elif entry.meta.plugin_name == 'apps.plugin' %] |
| 123 | [% include 'setup/sample-apps-config.md' %] |
| 124 | [% elif entry.meta.plugin_name == 'ebpf.plugin' %] |
| 125 | [% include 'setup/sample-netdata-config.md' %] |
| 126 | [% elif entry.setup.configuration.file.name == 'netdata.conf' %] |
| 127 | [% include 'setup/sample-netdata-config.md' %] |
| 128 | [% endif %] |
| 129 | |
| 130 | You can edit the configuration file using the [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the |
| 131 | Netdata [config directory](/docs/netdata-agent/configuration/README.md#locate-your-config-directory). |
| 132 | |
| 133 | ```bash |
| 134 | cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata |
| 135 | sudo ./edit-config [[ entry.setup.configuration.file.name ]] |
| 136 | ``` |
| 137 | [% else %] |
| 138 | There is no configuration file. |
| 139 | [% endif %] |
| 140 | |
| 141 | ##### Examples |
| 142 | [% if entry.setup.configuration.examples.list %] |
| 143 | |
| 144 | [% for example in entry.setup.configuration.examples.list %] |
| 145 | ###### [[ example.name ]] |
| 146 | |
| 147 | [[ example.description ]] |
| 148 | |
| 149 | [% if example.folding.enabled and not clean %] |
| 150 | {% details open=true summary="[[ entry.setup.configuration.examples.folding.title ]]" %} |
| 151 | [% endif %] |
| 152 | ```yaml |
| 153 | [[ example.config ]] |
| 154 | ``` |
| 155 | [% if example.folding.enabled and not clean %] |
| 156 | {% /details %} |
| 157 | [% endif %] |
| 158 | [% endfor %] |
| 159 | [% else%] |
| 160 | There are no configuration examples. |
| 161 | |
| 162 | [% endif %] |
| 163 | [% endif %] |