Skip to content

Commit 50b3653

Browse files
github-actions[bot]netdatabot
github-actions[bot]
and
netdatabot
authored
Ingest New Documentation (#2950)
Co-authored-by: netdatabot <43409846+netdatabot@users.noreply.github.com>
1 parent 6e7e8c8 commit 50b3653

1,514 files changed

Lines changed: 14304 additions & 10265 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/Collecting Metrics/AWS CloudWatch Profile Format.mdx‎

Lines changed: 95 additions & 135 deletions
Large diffs are not rendered by default.

‎docs/Collecting Metrics/Chart Template Format.mdx‎

Lines changed: 52 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,15 @@ groups:
247247
| [**engine**](#3-engine) | Engine-level policy (selectors, autogeneration). |
248248
| [**groups**](#4-groups) | Recursive chart groups — the core of the template. |
249249

250+
> [!NOTE]
251+
> Some consumers embed a chart template as a **single group** instead of a full spec — for example a
252+
> [Prometheus profile](/docs/collecting-metrics/prometheus-profile-format)'s `template:` key holds one item of
253+
> the `groups` list above (written without the leading dash), and the collector supplies `version` and `engine` itself.
254+
> All group and chart fields documented below apply unchanged; the spec-level `version`, top-level `context_namespace`,
255+
> and `engine` fields do not. Use the consumer's own policy surface for engine behavior. Prometheus profiles expose
256+
> `autogen.selector` at the profile root to constrain fallback charts inside that profile's `match` scope while
257+
> retaining samples; use the job `selector` or a relabeling `drop` rule when the samples themselves must be discarded.
258+
250259
---
251260

252261
## Field Reference
@@ -305,19 +314,47 @@ engine:
305314
deny: ["cpu_guest_*"]
306315
autogen:
307316
enabled: true
317+
rules:
318+
- scope: "app_*"
319+
selector:
320+
deny: ["app_debug_*", "app_internal_*"]
308321
expire_after_success_cycles: 50
309322
```
310323

311-
| Field | Type | Default | Description |
312-
|---------------------------------------|---------------|-------------|----------------------------------------------------------------------------------------|
313-
| `selector.allow` | array[string] | _(empty)_ | Include only metrics matching these patterns (simple patterns: `*` and `?` wildcards). |
314-
| `selector.deny` | array[string] | _(empty)_ | Exclude metrics matching these patterns (simple patterns: `*` and `?` wildcards). |
315-
| `autogen.enabled` | bool | `false` | Create charts for metrics not matched by any template dimension. |
316-
| `autogen.max_type_id_len` | int | `0` (=1200) | Max full `type.id` length. Must be `0` or `>= 4`. |
317-
| `autogen.expire_after_success_cycles` | uint64 | `0` | Remove autogenerated charts not seen for N successful cycles (`0` = never). |
324+
| Field | Type | Default | Description |
325+
|---------------------------------------|---------------|-------------|-----------------------------------------------------------------------------------------------|
326+
| `selector.allow` | array[string] | _(empty)_ | Include only metrics matching these patterns (simple patterns: `*` and `?` wildcards). |
327+
| `selector.deny` | array[string] | _(empty)_ | Exclude metrics matching these patterns (simple patterns: `*` and `?` wildcards). |
328+
| `autogen.enabled` | bool | `false` | Create charts for metrics not matched by any template dimension. |
329+
| `autogen.rules` | array[rule] | _(absent)_ | Conditional fallback selectors. Each rule requires `scope` and non-empty `selector`. |
330+
| `autogen.max_type_id_len` | int | `0` (=1200) | Max full `type.id` length. Must be `0` or `>= 4`. |
331+
| `autogen.expire_after_success_cycles` | uint64 | `0` | Remove autogenerated charts not seen for N successful cycles (`0` = never). |
318332

319333
**When to use autogen**: For collectors like Nagios plugins where the set of metrics is unpredictable and user-defined. The engine creates a chart for every unmatched metric automatically.
320334

335+
Each `autogen.rules[]` item has this shape:
336+
337+
```yaml
338+
scope: "app_*" # Netdata simple-pattern expression over source families
339+
selector:
340+
allow: ['{environment="prod"}']
341+
deny: ["app_debug_*"]
342+
```
343+
344+
An absent, null, or empty `autogen.rules` value means no conditional fallback rules.
345+
346+
Rules run only after every authored dimension selector has had a chance to route the flattened series. A rule applies
347+
when `scope` matches the resolved source family. If no rule applies, fallback is permitted. When several rules apply,
348+
every selector must accept the series; one rejection suppresses fallback, independent of rule order. Within one
349+
selector, `allow` defaults to all, `deny` defaults to none, and the result is `allow AND NOT deny`.
350+
351+
The selector receives the source family as `__name__` plus the flattened series' complete label view. Histogram and
352+
summary components use their base family (`foo`, not `foo_bucket`/`foo_sum`/`foo_count`) and preserve structural labels
353+
such as `le` and `quantile`; StateSet state labels and MeasureSet `measure_field` are also visible. Therefore, an
354+
authored heatmap for `foo_bucket` still materializes when a rule rejects `foo`, while unmatched `foo_sum` and
355+
`foo_count` fallback charts are suppressed. Rules change chart generation only; the series remains in the metric
356+
store.
357+
321358
**Example: Nagios collector with autogeneration**
322359

323360
```yaml
@@ -1059,6 +1096,8 @@ All rules below produce semantic validation errors unless noted:
10591096
| `label_promotion[]` entries must not be empty or whitespace-only | semantic |
10601097
| Lifecycle numeric fields must be `>= 0` | semantic |
10611098
| `engine.autogen.max_type_id_len` must be `0` or `>= 4` | semantic |
1099+
| Every autogen rule requires a non-empty valid `scope` simple pattern | semantic |
1100+
| Every autogen rule selector requires at least one non-empty valid `allow`/`deny` entry | semantic |
10621101
| Unknown YAML fields | decode error (strict unmarshal) |
10631102

10641103
## Compiler-Derived Behavior
@@ -1082,11 +1121,12 @@ All rules below produce semantic validation errors unless noted:
10821121

10831122
The package exposes a small Go surface for decoding, cloning, and re-emitting templates:
10841123

1085-
| Function | Purpose |
1086-
|------------------------------------------|------------------------------------------------------------------------------------|
1087-
| `DecodeYAML([]byte) (*Spec, error)` | Strict parse, apply decode-time defaults, then validate. The canonical read path. |
1088-
| `Group.Clone() Group` | Typed deep copy of a group and everything nested under it. |
1089-
| `Spec.MarshalTemplate() (string, error)` | Validate (only) and serialize a runtime-built template to YAML. |
1124+
| Function | Purpose |
1125+
|----------------------------------------------------|-------------------------------------------------------------------------------------------------|
1126+
| `DecodeYAML([]byte) (*Spec, error)` | Strict parse, apply decode-time defaults, then validate. The canonical read path. |
1127+
| `DecodeYAMLValidated([]byte) (*Spec, Validation, error)` | Decode plus immutable derived validation artifacts for runtime consumers such as chartengine. |
1128+
| `Group.Clone() Group` | Typed deep copy of a group and everything nested under it. |
1129+
| `Spec.MarshalTemplate() (string, error)` | Validate (only) and serialize a runtime-built template to YAML. |
10901130

10911131
### Building a template at runtime
10921132

‎docs/Collecting Metrics/Collectors/Applications/Active Directory Certificate Service.mdx‎

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ There are no configuration examples.
109109
There are no alerts configured by default for this integration.
110110

111111

112+
112113
## Metrics
113114

114115
Metrics grouped by *scope*.
@@ -117,6 +118,7 @@ The scope defines the instance that the metric belongs to. An instance is unique
117118

118119

119120

121+
120122
### Per Certificate Service Certificate
121123

122124
These metrics refer to the Certificate instances defined on host.
@@ -129,21 +131,21 @@ Labels:
129131

130132
Metrics:
131133

132-
| Metric | Dimensions | Unit |
133-
|:------|:----------|:----|
134-
| adcs.cert_requests | requests | requests/s |
135-
| adcs.cert_request_processing_time | processing_times | seconds |
136-
| adcs.cert_retrievals | retrievals | retrievals/s |
137-
| adcs.cert_failed_requests | failed | requests/s |
138-
| adcs.cert_issued_requests | issued | requests/s |
139-
| adcs.cert_pending_requests | pending | requests/s |
140-
| adcs.cert_challenge_responses | challenge | responses/s |
141-
| adcs.cert_retrieval_processing_time | processing_time | seconds |
142-
| adcs.cert_request_cryptographic_signing_time | singing_time | seconds |
143-
| adcs.cert_request_policy_module_processing | processing_time | seconds |
144-
| adcs.cert_request_policy_module_processing | processing_time | seconds |
145-
| adcs.cert_challenge_response_processing_time | processing_time | seconds |
146-
| adcs.cert_signed_certificate_timestamp_lists | processing_time | lists/s |
147-
| adcs.cert_signed_certificate_timestamp_lists | lists | lists/s |
148-
| adcs.cert_signed_certificate_timestamp_list_processing_time | processing_time | seconds |
149-
| adcs.cert_retrieval_processing_time | processing_time | seconds |
134+
| Metric | Description | Dimensions | Unit |
135+
|:------|:------------|:----------|:----|
136+
| adcs.cert_requests | Certificate requests processed | requests | requests/s |
137+
| adcs.cert_request_processing_time | Certificate last request processing time | processing_times | seconds |
138+
| adcs.cert_retrievals | Total of certificate retrievals | retrievals | retrievals/s |
139+
| adcs.cert_failed_requests | Certificate failed requests processed | failed | requests/s |
140+
| adcs.cert_issued_requests | Certificate issued requests processed | issued | requests/s |
141+
| adcs.cert_pending_requests | Certificate pending requests processed | pending | requests/s |
142+
| adcs.cert_challenge_responses | Certificate challenge responses | challenge | responses/s |
143+
| adcs.cert_retrieval_processing_time | Certificate last retrieval processing time | processing_time | seconds |
144+
| adcs.cert_request_cryptographic_signing_time | Certificate last signing operation request time | singing_time | seconds |
145+
| adcs.cert_request_policy_module_processing | Certificate last policy module processing request time | processing_time | seconds |
146+
| adcs.cert_request_policy_module_processing | Certificate last policy module processing request time | processing_time | seconds |
147+
| adcs.cert_challenge_response_processing_time | Certificate last challenge response time | processing_time | seconds |
148+
| adcs.cert_signed_certificate_timestamp_lists | Certificate Signed Certificate Timestamp Lists processed | processing_time | lists/s |
149+
| adcs.cert_signed_certificate_timestamp_lists | Certificate Signed Certificate Timestamp Lists processed | lists | lists/s |
150+
| adcs.cert_signed_certificate_timestamp_list_processing_time | Certificate last Signed Certificate Timestamp List process time | processing_time | seconds |
151+
| adcs.cert_retrieval_processing_time | Certificate last retrieval processing time | processing_time | seconds |

‎docs/Collecting Metrics/Collectors/Applications/Active Directory Federation Service.mdx‎

Lines changed: 36 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ There are no configuration examples.
109109
There are no alerts configured by default for this integration.
110110

111111

112+
112113
## Metrics
113114

114115
Metrics grouped by *scope*.
@@ -117,6 +118,7 @@ The scope defines the instance that the metric belongs to. An instance is unique
117118

118119

119120

121+
120122
### Per Federation Service
121123

122124
These metrics refer to the Federated Identity and Access Management on host.
@@ -125,37 +127,37 @@ This scope has no labels.
125127

126128
Metrics:
127129

128-
| Metric | Dimensions | Unit |
129-
|:------|:----------|:----|
130-
| adfs.ad_login_connection_failures | connection | failures/s |
131-
| adfs.certificate_authentications | authentications | authentications/s |
132-
| adfs.db_artifact_failures | connection | failures/s |
133-
| adfs.db_artifact_query_time_seconds | query_time | seconds/s |
134-
| adfs.db_config_failures | connection | failures/s |
135-
| adfs.db_config_query_time_seconds | query_time | seconds/s |
136-
| adfs.device_authentications | authentications | authentications/s |
137-
| adfs.extranet_account_lockouts | lockouts | lockouts/s |
138-
| adfs.external_authentications | success, failure | authentications/s |
139-
| adfs.federated_authentications | authentications | authentications/s |
140-
| adfs.federation_metadata_requests | requests | requests/s |
141-
| adfs.oauth_authorization_requests | requests | requests/s |
142-
| adfs.oauth_client_authentications | success, failure | authentications/s |
143-
| adfs.oauth_client_credentials_requests | success, failure | requests/s |
144-
| adfs.oauth_client_privkey_jwt_authentications | success, failure | authentications/s |
145-
| adfs.oauth_client_secret_basic_authentications | success, failure | authentications/s |
146-
| adfs.oauth_client_secret_basic_authentications | success, failure | authentications/s |
147-
| adfs.oauth_client_secret_post_authentications | success, failure | authentications/s |
148-
| adfs.oauth_client_windows_authentications | success, failure | requests/s |
149-
| adfs.oauth_logon_certificate_requests | success, failure | requests/s |
150-
| adfs.oauth_password_grant_requests | success, failure | requests/s |
151-
| adfs.oauth_token_requests_success | success | requests/s |
152-
| adfs.passive_requests | passive | requests/s |
153-
| adfs.passport_authentications | passport | authentications/s |
154-
| adfs.password_change_requests | success, failure | requests/s |
155-
| adfs.samlp_token_requests_success | success | requests/s |
156-
| adfs.sso_authentications | success, failure | authentications/s |
157-
| adfs.token_requests | requests | requests/s |
158-
| adfs.userpassword_authentications | success, failure | authentications/s |
159-
| adfs.windows_integrated_authentications | authentications | authentications/s |
160-
| adfs.wsfed_token_requests_success | success | requests/s |
161-
| adfs.wstrust_token_requests_success | success | requests/s |
130+
| Metric | Description | Dimensions | Unit |
131+
|:------|:------------|:----------|:----|
132+
| adfs.ad_login_connection_failures | Connection failures | connection | failures/s |
133+
| adfs.certificate_authentications | User Certificate authentications | authentications | authentications/s |
134+
| adfs.db_artifact_failures | Connection failures to the artifact database | connection | failures/s |
135+
| adfs.db_artifact_query_time_seconds | Time taken for an artifact database query | query_time | seconds/s |
136+
| adfs.db_config_failures | Connection failures to the configuration database | connection | failures/s |
137+
| adfs.db_config_query_time_seconds | Time taken for a configuration database query | query_time | seconds/s |
138+
| adfs.device_authentications | Device authentications | authentications | authentications/s |
139+
| adfs.extranet_account_lockouts | Extranet account lockouts | lockouts | lockouts/s |
140+
| adfs.external_authentications | Authentications from external MFA providers | success, failure | authentications/s |
141+
| adfs.federated_authentications | Authentications from Federated Sources | authentications | authentications/s |
142+
| adfs.federation_metadata_requests | Federation Metadata requests | requests | requests/s |
143+
| adfs.oauth_authorization_requests | Incoming requests to the OAuth Authorization endpoint | requests | requests/s |
144+
| adfs.oauth_client_authentications | OAuth client credentials requests | success, failure | authentications/s |
145+
| adfs.oauth_client_credentials_requests | OAuth client credentials requests | success, failure | requests/s |
146+
| adfs.oauth_client_privkey_jwt_authentications | OAuth client private key JWT authentications | success, failure | authentications/s |
147+
| adfs.oauth_client_secret_basic_authentications | OAuth client secret basic authentications | success, failure | authentications/s |
148+
| adfs.oauth_client_secret_basic_authentications | OAuth client secret basic authentications | success, failure | authentications/s |
149+
| adfs.oauth_client_secret_post_authentications | OAuth client secret post authentications | success, failure | authentications/s |
150+
| adfs.oauth_client_windows_authentications | OAuth client windows integrated authentications | success, failure | requests/s |
151+
| adfs.oauth_logon_certificate_requests | OAuth logon certificate requests | success, failure | requests/s |
152+
| adfs.oauth_password_grant_requests | OAuth password grant requests | success, failure | requests/s |
153+
| adfs.oauth_token_requests_success | Successful RP token requests over OAuth protocol | success | requests/s |
154+
| adfs.passive_requests | Passive requests | passive | requests/s |
155+
| adfs.passport_authentications | Microsoft Passport SSO authentications | passport | authentications/s |
156+
| adfs.password_change_requests | Password change requests | success, failure | requests/s |
157+
| adfs.samlp_token_requests_success | Successful RP token requests over SAML-P protocol | success | requests/s |
158+
| adfs.sso_authentications | SSO authentications | success, failure | authentications/s |
159+
| adfs.token_requests | Token access requests | requests | requests/s |
160+
| adfs.userpassword_authentications | AD U/P authentications | success, failure | authentications/s |
161+
| adfs.windows_integrated_authentications | Windows integrated authentications using Kerberos or NTLM | authentications | authentications/s |
162+
| adfs.wsfed_token_requests_success | Successful RP token requests over WS-Fed protocol | success | requests/s |
163+
| adfs.wstrust_token_requests_success | Successful RP token requests over WS-Trust protocol | success | requests/s |

0 commit comments

Comments
 (0)