| 1 | # Dynamic Configuration Manager |
| 2 | |
| 3 | ## Overview |
| 4 | |
| 5 | :::important |
| 6 | |
| 7 | Netdata Cloud paid plan is required. |
| 8 | |
| 9 | ::: |
| 10 | |
| 11 | :::tip |
| 12 | |
| 13 | **What You'll Learn** |
| 14 | |
| 15 | How to access the Dynamic Configuration Manager and understand its key features for managing your monitoring infrastructure. |
| 16 | |
| 17 | ::: |
| 18 | |
| 19 | The Dynamic Configuration Manager allows you to configure collectors and alerts directly through the Netdata UI. This feature enables you to: |
| 20 | |
| 21 | - **Create, test, and deploy configurations** for one or more nodes directly within the UI |
| 22 | - **Eliminate manual command-line edits and node access**, enhancing your workflow efficiency |
| 23 | |
| 24 | :::note |
| 25 | |
| 26 | **Cloud Connection and Security** |
| 27 | |
| 28 | Your nodes using Dynamic Configuration Manager require a connection to Netdata Cloud. This ensures proper permission handling and data security. |
| 29 | |
| 30 | ::: |
| 31 | |
| 32 | **Key Features:** |
| 33 | |
| 34 | | Feature | Purpose | |
| 35 | |------------------------------------------|-----------------------------------------------------------------------------------------------| |
| 36 | | Configure collector parameters | Set up data collection settings directly in the UI | |
| 37 | | Fill out configuration forms | Use guided interfaces instead of editing config files | |
| 38 | | Test configurations before deployment | Validate settings to prevent errors | |
| 39 | | Create alert templates | Build reusable alert definitions | |
| 40 | | Apply templates to instances or contexts | Target specific services or apply broadly | |
| 41 | | Deploy to multiple nodes simultaneously | Ensure consistency across your infrastructure | |
| 42 | | Manage Health tab alert templates | Create configurations for templates and individual alerts that apply to instances or contexts | |
| 43 | |
| 44 | :::info |
| 45 | |
| 46 | To understand what actions you can perform based on your role, refer to the [Role-Based Access documentation](/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md). |
| 47 | |
| 48 | ::: |
| 49 | |
| 50 | ## Quick Access Methods |
| 51 | |
| 52 | :::tip |
| 53 | |
| 54 | **What You'll Learn** |
| 55 | |
| 56 | Four different ways to access the Dynamic Configuration Manager, each optimized for different workflows. |
| 57 | |
| 58 | ::: |
| 59 | |
| 60 | You can access the Dynamic Configuration Manager in multiple ways: |
| 61 | |
| 62 | <details> |
| 63 | <summary><strong>From Any Chart</strong></summary><br/> |
| 64 | |
| 65 | 1. Navigate to any chart on your dashboard |
| 66 | 2. Click the **Alert icon (bell icon)** at the top of the chart |
| 67 | 3. Choose to edit an existing alert or create a new one |
| 68 | 4. Configure your alert parameters and submit changes |
| 69 | |
| 70 | <br/> |
| 71 | </details> |
| 72 | |
| 73 | <details> |
| 74 | <summary><strong>From the Alerts Tab</strong></summary><br/> |
| 75 | |
| 76 | 1. Go to the **Alerts tab** on your Netdata dashboard |
| 77 | 2. Locate the alert you want to modify and click on it |
| 78 | 3. Adjust thresholds and parameters to match your needs |
| 79 | 4. Save your changes |
| 80 | |
| 81 | <br/> |
| 82 | </details> |
| 83 | |
| 84 | <details> |
| 85 | <summary><strong>From the Integrations Section</strong></summary><br/> |
| 86 | |
| 87 | 1. Navigate to the **Integrations section** on your dashboard |
| 88 | 2. Browse through the available collectors |
| 89 | 3. Click on the **Configure** button for the collector you want to set up |
| 90 | 4. Once configured, they will start collecting data as specified |
| 91 | |
| 92 | <br/> |
| 93 | </details> |
| 94 | |
| 95 | <details> |
| 96 | <summary><strong>From Space Settings</strong></summary><br/> |
| 97 | |
| 98 | 1. Go to **Space Settings** on your Dashboard |
| 99 | 2. Navigate to the **Configurations** section |
| 100 | 3. Explore, create, and edit collector, health and logs configurations |
| 101 | |
| 102 | <br/> |
| 103 | </details><br/> |
| 104 | |
| 105 | :::tip |
| 106 | |
| 107 | Currently available for go.d collectors, you can configure collectors straight from the Integrations section. This means you can quickly identify what Netdata can monitor and set up your configurations in one go. |
| 108 | |
| 109 | ::: |
| 110 | |
| 111 | ## Getting Started |
| 112 | |
| 113 | :::tip |
| 114 | |
| 115 | **What You'll Learn** |
| 116 | |
| 117 | How to use each of the four access methods with practical step-by-step workflows. |
| 118 | |
| 119 | ::: |
| 120 | |
| 121 | :::tip |
| 122 | |
| 123 | To help you get started with the Dynamic Configuration Manager, try using the Netdata demo environment to explore these capabilities firsthand and see how they can enhance your monitoring workflows. |
| 124 | |
| 125 | ::: |
| 126 | |
| 127 | ### Step-by-Step Walkthrough |
| 128 | |
| 129 | <details> |
| 130 | <summary><strong>Creating Alerts from Charts</strong></summary><br/> |
| 131 | |
| 132 | Learn more about this access method: [From Any Chart](#quick-access-methods) |
| 133 | |
| 134 | 1. Navigate to the chart (context) you want to create an alert for |
| 135 | 2. Click on the Alert icon (bell icon) on top of the chart to edit an existing alert or create a new one |
| 136 | 3. Configure your alert parameters, such as rules, instances, thresholds, etc. |
| 137 | 4. Submit your changes |
| 138 | |
| 139 | <br/> |
| 140 | </details> |
| 141 | |
| 142 | <details> |
| 143 | <summary><strong>Managing Alerts from the Alerts Tab</strong></summary><br/> |
| 144 | |
| 145 | Learn more about this access method: [From the Alerts Tab](#quick-access-methods) |
| 146 | |
| 147 | 1. Go to the Alerts tab on your Netdata dashboard |
| 148 | 2. Locate the alert you wish to modify and click on it |
| 149 | 3. Adjust the thresholds and other parameters to match your specific needs |
| 150 | 4. Save the changes |
| 151 | |
| 152 | <br/> |
| 153 | </details> |
| 154 | |
| 155 | <details> |
| 156 | <summary><strong>Configuring Collectors from Integrations</strong></summary><br/> |
| 157 | |
| 158 | Learn more about this access method: [From the Integrations Section](#quick-access-methods) |
| 159 | |
| 160 | 1. Navigate to the Integrations section on the dashboard |
| 161 | 2. Browse through the available collectors |
| 162 | 3. Click on the **Configure** button for the collector you want to set up |
| 163 | 4. Once configured, they will start collecting data as specified |
| 164 | |
| 165 | <br/> |
| 166 | </details> |
| 167 | |
| 168 | <details> |
| 169 | <summary><strong>Managing Configurations from Space Settings</strong></summary><br/> |
| 170 | |
| 171 | Learn more about this access method: [From Space Settings](#quick-access-methods) |
| 172 | |
| 173 | 1. Go to **Space Settings** on your Dashboard |
| 174 | 2. Navigate to the **Configurations** section |
| 175 | 3. Explore, create, and edit collector, health and logs configurations |
| 176 | |
| 177 | <br/> |
| 178 | </details> |
| 179 | |
| 180 | ## Collectors |
| 181 | |
| 182 | :::tip |
| 183 | |
| 184 | **What You'll Learn** |
| 185 | |
| 186 | How modules and jobs work together to collect data, and the specific actions you can perform on each. |
| 187 | |
| 188 | ::: |
| 189 | |
| 190 | ### Module |
| 191 | |
| 192 | A module represents a specific data collector, such as Apache, MySQL, or Redis. Think of modules as templates for data collection. |
| 193 | |
| 194 | Each module can have multiple jobs, which are unique configurations of that template tailored to your specific needs. |
| 195 | |
| 196 | **Module Management Actions:** |
| 197 | |
| 198 | | Action | Description | |
| 199 | |--------------------|---------------------------------------------------------------------------------------------------------------------------| |
| 200 | | **Add job** | Create new configuration instances (jobs) for a particular module | |
| 201 | | **Enable/Disable** | Disabling a module deactivates all currently running jobs and prevents any future jobs from being created for that module | |
| 202 | |
| 203 | ### Job |
| 204 | |
| 205 | A job represents a running instance of a module with a specific configuration. Think of it as a customized data collection task based on a module template. |
| 206 | |
| 207 | **Job Source Types:** |
| 208 | |
| 209 | Every job has a designated "source type" indicating its origin: |
| 210 | |
| 211 | | Source Type | Description | |
| 212 | |---------------------------|-----------------------------------------------------------------------------------| |
| 213 | | **Stock** | Pre-installed with Netdata and provides basic data collection for common services | |
| 214 | | **User** | Created from user-defined configuration files on the node | |
| 215 | | **Discovered** | Automatically generated by Netdata upon discovering a service running on the node | |
| 216 | | **Dynamic Configuration** | Managed and created through the Dynamic Configuration Manager | |
| 217 | |
| 218 | **Job Management Actions:** |
| 219 | |
| 220 | | Category | Action | Description | |
| 221 | |-------------------|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
| 222 | | **Configuration** | **Edit** | Modify an existing job's configuration | |
| 223 | | **Configuration** | **Test** | Validate newly created or edited configurations before applying them permanently | |
| 224 | | **Management** | **Enable/Disable** | Control the job's activity. Disabling a running job stops data collection | |
| 225 | | **Management** | **Restart** | Restart a job's data collection, useful if a job encounters a "Failed" state. Upon restart, you'll see a notification with the failure message | |
| 226 | | **Management** | **Remove** | Delete a job configuration entirely. Note that you can only remove jobs created through Dynamic Configuration. Other job types originate from files on the node and cannot be deleted here | |
| 227 | |
| 228 | :::important |
| 229 | |
| 230 | Only jobs created through Dynamic Configuration can be removed. Other job types originate from files on the node and can’t be deleted through the UI. |
| 231 | |
| 232 | ::: |
| 233 | |
| 234 | ## Multi-Node Deployment |
| 235 | |
| 236 | :::tip |
| 237 | |
| 238 | **What You'll Learn** |
| 239 | |
| 240 | How to deploy configurations to multiple nodes simultaneously, saving time and ensuring consistency across your infrastructure. |
| 241 | |
| 242 | ::: |
| 243 | |
| 244 | The Dynamic Configuration Manager allows you to submit configurations to multiple nodes with just one click, eliminating the need to configure each node individually. |
| 245 | |
| 246 | :::note |
| 247 | For teams using Infrastructure as Code solutions, the Dynamic Configuration Manager allows you to construct and copy configurations easily, integrating them into your IaC workflows. This ensures your configurations are consistent and reproducible across different environments. |
| 248 | ::: |
| 249 | |
| 250 | ### Multi-Node Deployment Process |
| 251 | |
| 252 | <details> |
| 253 | <summary><strong>Deploy to Multiple Nodes</strong></summary><br/> |
| 254 | |
| 255 | 1. Configure your collectors or alerts using any of the methods described above |
| 256 | 2. Use the multi-node feature to select your target nodes |
| 257 | 3. Submit your configuration, and it will be applied to all selected nodes instantly |
| 258 | |
| 259 | <br/> |
| 260 | </details><br/> |
| 261 | |
| 262 | :::note |
| 263 | |
| 264 | This feature is particularly valuable for managing large infrastructures where manual configuration of individual nodes would be time-consuming and error-prone. |
| 265 | |
| 266 | ::: |
| 267 | |
| 268 | ## Troubleshooting |
| 269 | |
| 270 | ### HTTP 412 Error When Editing Alert Configurations |
| 271 | |
| 272 | If you receive an **HTTP 412 error** with a message like "Request failed with status 412" when editing alert configurations, this indicates an **authentication issue**, not a schema validation error. |
| 273 | |
| 274 | :::important |
| 275 | |
| 276 | In Netdata, HTTP 412 is used to indicate that an authorization bearer token was required but was not present in the request. This differs from the generic HTTP 412 "Precondition Failed" response. |
| 277 | |
| 278 | ::: |
| 279 | |
| 280 | **Common causes:** |
| 281 | |
| 282 | 1. **Bearer token protection enabled** - Your agent requires Cloud authentication for API access |
| 283 | 2. **Cloud connection lost** - Agent disconnected from Netdata Cloud |
| 284 | 3. **Session expired** - Bearer token has expired (tokens expire after 24 hours) |
| 285 | 4. **Missing browser authentication state** - Your browser is no longer sending a valid Cloud bearer token with the request |
| 286 | |
| 287 | **Resolution steps:** |
| 288 | |
| 289 | 1. **Verify claim and Cloud connection**: Check `http://IP:19999/api/v3/info` and inspect the `cloud` section. Use `cloud.status` to verify whether the Agent is connected to Netdata Cloud, and if it is not `online`, inspect `cloud.reason` for the failure details. |
| 290 | 2. **Re-authenticate**: Log out and log back into Netdata Cloud to refresh your bearer token. |
| 291 | 3. **Verify bearer token protection setting**: If enabled in `netdata.conf`, ensure you're accessing the agent through a Cloud-authenticated session. |
| 292 | 4. **Check permissions only if you get HTTP 403**: If the request changes from HTTP 412 to HTTP 403 after re-authenticating, ensure you have Admin or Manager role in the space containing the agent. |
| 293 | |
| 294 | For more information, see [Secure Your Netdata Agent with Bearer Token Protection](/docs/netdata-agent/configuration/secure-your-netdata-agent-with-bearer-token.md). |
| 295 | |
| 296 | --- |
| 297 | |
| 298 | Experience the efficiency and power of the Dynamic Configuration Manager in Netdata today. Whether you're managing a handful of nodes or a vast infrastructure, this feature will make your monitoring and alerting tasks smoother and more intuitive. |
| 299 | |
| 300 | Developing with dynamic configuration? [Click here](https://learn.netdata.cloud/docs/developer-and-contributor-corner/dynamic-configuration/). |