diff options
Diffstat (limited to 'collectors/python.d.plugin/alarms/integrations/netdata_agent_alarms.md')
| -rw-r--r-- | collectors/python.d.plugin/alarms/integrations/netdata_agent_alarms.md | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/collectors/python.d.plugin/alarms/integrations/netdata_agent_alarms.md b/collectors/python.d.plugin/alarms/integrations/netdata_agent_alarms.md index 95e4a4a3b..9fb69878a 100644 --- a/collectors/python.d.plugin/alarms/integrations/netdata_agent_alarms.md +++ b/collectors/python.d.plugin/alarms/integrations/netdata_agent_alarms.md @@ -4,6 +4,7 @@ meta_yaml: "https://github.com/netdata/netdata/edit/master/collectors/python.d.p sidebar_label: "Netdata Agent alarms" learn_status: "Published" learn_rel_path: "Data Collection/Other" +most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> @@ -110,17 +111,17 @@ Every configuration JOB starts with a `job_name` value which will appear in the | Name | Description | Default | Required | |:----|:-----------|:-------|:--------:| -| url | Netdata agent alarms endpoint to collect from. Can be local or remote so long as reachable by agent. | http://127.0.0.1:19999/api/v1/alarms?all | True | -| status_map | Mapping of alarm status to integer number that will be the metric value collected. | {"CLEAR": 0, "WARNING": 1, "CRITICAL": 2} | True | -| collect_alarm_values | set to true to include a chart with calculated alarm values over time. | False | True | -| alarm_status_chart_type | define the type of chart for plotting status over time e.g. 'line' or 'stacked'. | line | True | -| alarm_contains_words | A "," separated list of words you want to filter alarm names for. For example 'cpu,load' would filter for only alarms with "cpu" or "load" in alarm name. Default includes all. | | True | -| alarm_excludes_words | A "," separated list of words you want to exclude based on alarm name. For example 'cpu,load' would exclude all alarms with "cpu" or "load" in alarm name. Default excludes None. | | True | -| update_every | Sets the default data collection frequency. | 10 | False | -| priority | Controls the order of charts at the netdata dashboard. | 60000 | False | -| autodetection_retry | Sets the job re-check interval in seconds. | 0 | False | -| penalty | Indicates whether to apply penalty to update_every in case of failures. | yes | False | -| name | Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works. | | False | +| url | Netdata agent alarms endpoint to collect from. Can be local or remote so long as reachable by agent. | http://127.0.0.1:19999/api/v1/alarms?all | yes | +| status_map | Mapping of alarm status to integer number that will be the metric value collected. | {"CLEAR": 0, "WARNING": 1, "CRITICAL": 2} | yes | +| collect_alarm_values | set to true to include a chart with calculated alarm values over time. | no | yes | +| alarm_status_chart_type | define the type of chart for plotting status over time e.g. 'line' or 'stacked'. | line | yes | +| alarm_contains_words | A "," separated list of words you want to filter alarm names for. For example 'cpu,load' would filter for only alarms with "cpu" or "load" in alarm name. Default includes all. | | yes | +| alarm_excludes_words | A "," separated list of words you want to exclude based on alarm name. For example 'cpu,load' would exclude all alarms with "cpu" or "load" in alarm name. Default excludes None. | | yes | +| update_every | Sets the default data collection frequency. | 10 | no | +| priority | Controls the order of charts at the netdata dashboard. | 60000 | no | +| autodetection_retry | Sets the job re-check interval in seconds. | 0 | no | +| penalty | Indicates whether to apply penalty to update_every in case of failures. | yes | no | +| name | Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works. | | no | </details> |