archive/netdata_netdata
0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-04-13 17:19:11 +00:00
Code Issues Projects Releases Wiki Activity

Dyncfg doc ()

Browse source 
Co-authored-by: ilyam8 <ilya@netdata.cloud>
This commit is contained in:
Fotis Voutsas 2024-06-07 12:37:41 +03:00 • committed by GitHub
parent 485aa79fb7
commit ef347a2405
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 60 additions and 0 deletions

60
docs/netdata-agent/configuration/dynamic-configuration.md Normal file
View file

@ -0,0 +1,60 @@
# Dynamic Configuration Manager
**Netdata Cloud paid subscription required.**
The Dynamic Configuration Manager allows direct configuration of collectors and alerts through the Netdata UI. This feature allows users to:
- **Create, test, and deploy configurations** for one or more nodes directly within the UI.
- **Eliminate the need for manual command-line edits and node access**, enhancing workflow efficiency.
**Cloud Connection and Security**: Nodes using Dynamic Configuration Manager require a connection to Netdata Cloud. This ensures proper permission handling and data security.
**Permissions**: Admins and Managers can view, edit, and submit configurations within the UI.
## Collectors
### Module
A module represents a specific data collector, such as Apache, MySQL, or Redis. Think of modules as templates for data collection.
Each module can have multiple jobs, which are unique configurations of that template tailored to your specific needs.
You can manage individual modules using the following actions:
| Action | Description |
|--------------------|---------------------------------------------------------------------------------------------------------------------------|
| **Add job** | Create new configuration instances (jobs) for a particular module. |
| **Enable/Disable** | Disabling a module deactivates all currently running jobs and prevents any future jobs from being created for that module |
### Job
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.
Every job has a designated "source type" indicating its origin:
- **Stock**: Pre-installed with Netdata and provides basic data collection for common services.
- **User**: Originates from user-created files on the node.
- **Discovered**: Automatically generated by Netdata upon discovering a service running on the node.
- **Dynamic Configuration**: Created and managed using the Dynamic Configuration Manager.
You can manage individual jobs using the following actions:
| Action | Description |
|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Restart** | This restarts a job's data collection, useful if a job encounters a "Failed" state. Upon restart, a notification with the failure message will be displayed. |
| **Remove** | Delete a job configuration entirely. Note that only jobs created through Dynamic Configuration can be removed. Other job types originate from files on the node and cannot be deleted here. |
| **Enable/Disable** | Control the job's activity. Disabling a running job stops data collection. |
| **Edit** | Modify an existing job's configuration. |
| **Test** | Validate newly created or edited configurations before applying them permanently. |
## Health
Each entry in the Health tab contains an Alert template, that then is used to create Alerts.
The functionality in the main view is the same as with the [Collectors tab](#collectors).
### Health entry configuration
You can create new configurations both for templates or individual Alerts.
Each template can have multiple items which resemble Alerts that either apply to a certain [instance](/docs/dashboards-and-charts/netdata-charts.md#instances-dropdown), or all instances under a specific [context](/docs/dashboards-and-charts/netdata-charts.md#contexts)