Dyncfg doc (#17832)
Co-authored-by: ilyam8 <ilya@netdata.cloud>
Fotis Voutsas committed
Jun 7, 2024 at 12:37 UTC
ef347a2405ba23f87680d580072cab4e6788cc54
1 file changed
+60
docs/netdata-agent/configuration/dynamic-configuration.md
new
+60
@@ -0,0 +1,60 @@
1
+# Dynamic Configuration Manager
2
+
3
+**Netdata Cloud paid subscription required.**
4
+
5
+The Dynamic Configuration Manager allows direct configuration of collectors and alerts through the Netdata UI. This feature allows users to:
6
+
7
+- **Create, test, and deploy configurations** for one or more nodes directly within the UI.
8
+- **Eliminate the need for manual command-line edits and node access**, enhancing workflow efficiency.
9
+
10
+**Cloud Connection and Security**: Nodes using Dynamic Configuration Manager require a connection to Netdata Cloud. This ensures proper permission handling and data security.
11
+
12
+**Permissions**: Admins and Managers can view, edit, and submit configurations within the UI.
13
+
14
+## Collectors
15
+
16
+### Module
17
+
18
+A module represents a specific data collector, such as Apache, MySQL, or Redis. Think of modules as templates for data collection.
19
+
20
+Each module can have multiple jobs, which are unique configurations of that template tailored to your specific needs.
21
+
22
+You can manage individual modules using the following actions:
23
+
24
+| Action | Description |
25
+|--------------------|---------------------------------------------------------------------------------------------------------------------------|
26
+| **Add job** | Create new configuration instances (jobs) for a particular module. |
27
+| **Enable/Disable** | Disabling a module deactivates all currently running jobs and prevents any future jobs from being created for that module |
28
+
29
+### Job
30
+
31
+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.
32
+
33
+Every job has a designated "source type" indicating its origin:
34
+
35
+- **Stock**: Pre-installed with Netdata and provides basic data collection for common services.
36
+- **User**: Originates from user-created files on the node.
37
+- **Discovered**: Automatically generated by Netdata upon discovering a service running on the node.
38
+- **Dynamic Configuration**: Created and managed using the Dynamic Configuration Manager.
39
+
40
+You can manage individual jobs using the following actions:
41
+
42
+| Action | Description |
43
+|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
44
+| **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. |
45
+| **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. |
46
+| **Enable/Disable** | Control the job's activity. Disabling a running job stops data collection. |
47
+| **Edit** | Modify an existing job's configuration. |
48
+| **Test** | Validate newly created or edited configurations before applying them permanently. |
49
+
50
+## Health
51
+
52
+Each entry in the Health tab contains an Alert template, that then is used to create Alerts.
53
+
54
+The functionality in the main view is the same as with the [Collectors tab](#collectors).
55
+
56
+### Health entry configuration
57
+
58
+You can create new configurations both for templates or individual Alerts.
59
+
60
+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)