From 4b59550b039f02114ffaabc59dadeca2804cb523 Mon Sep 17 00:00:00 2001 From: Dmitry Volodin Date: Mon, 10 May 2021 07:06:42 +0300 Subject: [PATCH] noc-agent: Document `service` parameter --- .../reference/agent/collectors/block_io.md | 13 +++++----- .../admin/reference/agent/collectors/cpu.md | 13 +++++----- .../admin/reference/agent/collectors/dns.md | 21 ++++++++-------- .../admin/reference/agent/collectors/fs.md | 13 +++++----- .../reference/agent/collectors/memory.md | 13 +++++----- .../reference/agent/collectors/network.md | 13 +++++----- .../admin/reference/agent/collectors/test.md | 13 +++++----- .../agent/collectors/twamp_sender.md | 25 ++++++++++--------- .../reference/agent/collectors/uptime.md | 13 +++++----- 9 files changed, 73 insertions(+), 64 deletions(-) diff --git a/docs/en/docs/admin/reference/agent/collectors/block_io.md b/docs/en/docs/admin/reference/agent/collectors/block_io.md index a5982ab4ac..fa13236855 100644 --- a/docs/en/docs/admin/reference/agent/collectors/block_io.md +++ b/docs/en/docs/admin/reference/agent/collectors/block_io.md @@ -4,12 +4,13 @@ ## Configuration -| Parameter | Type | Default | Description | -| ---------- | ---------------- | ------- | ------------------------------------------------------------------------------------------- | -| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | -| `type` | String | | Must be `block_io` | -| `interval` | Integer | | Repetition interval in seconds | -| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | +| Parameter | Type | Default | Description | +| ---------- | ---------------- | ------------- | ------------------------------------------------------------------------------------------- | +| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | +| `type` | String | | Must be `block_io` | +| `service` | String | Equal to `id` | Service id for output metrics | +| `interval` | Integer | | Repetition interval in seconds | +| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | ## Collected Metrics diff --git a/docs/en/docs/admin/reference/agent/collectors/cpu.md b/docs/en/docs/admin/reference/agent/collectors/cpu.md index 489a80232f..7612596c96 100644 --- a/docs/en/docs/admin/reference/agent/collectors/cpu.md +++ b/docs/en/docs/admin/reference/agent/collectors/cpu.md @@ -4,12 +4,13 @@ ## Configuration -| Parameter | Type | Default | Description | -| ---------- | ---------------- | ------- | ------------------------------------------------------------------------------------------- | -| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | -| `type` | String | | Must be `cpu` | -| `interval` | Integer | | Repetition interval in seconds | -| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | +| Parameter | Type | Default | Description | +| ---------- | ---------------- | ------------- | ------------------------------------------------------------------------------------------- | +| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | +| `type` | String | | Must be `cpu` | +| `service` | String | Equal to `id` | Service id for output metrics | +| `interval` | Integer | | Repetition interval in seconds | +| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | ## Collected Metrics diff --git a/docs/en/docs/admin/reference/agent/collectors/dns.md b/docs/en/docs/admin/reference/agent/collectors/dns.md index a79e3c5bd1..ac3dd9ef23 100644 --- a/docs/en/docs/admin/reference/agent/collectors/dns.md +++ b/docs/en/docs/admin/reference/agent/collectors/dns.md @@ -4,16 +4,17 @@ ## Configuration -| Parameter | Type | Default | Description | -| ------------- | ---------------- | ------- | ------------------------------------------------------------------------------------------- | -| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | -| `type` | String | | Must be `dns` | -| `interval` | Integer | | Repetition interval in seconds | -| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | -| `query` | String | | -| `query_type` | String | `A` | -| `n` | Integer | `1` | -| `min_success` | Integer | `1` | +| Parameter | Type | Default | Description | +| ------------- | ---------------- | ------------- | ------------------------------------------------------------------------------------------- | +| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | +| `type` | String | | Must be `dns` | +| `service` | String | Equal to `id` | Service id for output metrics | +| `interval` | Integer | | Repetition interval in seconds | +| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | +| `query` | String | | +| `query_type` | String | `A` | +| `n` | Integer | `1` | +| `min_success` | Integer | `1` | ## Collected Metrics diff --git a/docs/en/docs/admin/reference/agent/collectors/fs.md b/docs/en/docs/admin/reference/agent/collectors/fs.md index cc356ca7a6..3f7a54ad46 100644 --- a/docs/en/docs/admin/reference/agent/collectors/fs.md +++ b/docs/en/docs/admin/reference/agent/collectors/fs.md @@ -4,12 +4,13 @@ ## Configuration -| Parameter | Type | Default | Description | -| ---------- | ---------------- | ------- | ------------------------------------------------------------------------------------------- | -| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | -| `type` | String | | Must be `fs` | -| `interval` | Integer | | Repetition interval in seconds | -| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | +| Parameter | Type | Default | Description | +| ---------- | ---------------- | ------------- | ------------------------------------------------------------------------------------------- | +| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | +| `type` | String | | Must be `fs` | +| `service` | String | Equal to `id` | Service id for output metrics | +| `interval` | Integer | | Repetition interval in seconds | +| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | ## Collected Metrics diff --git a/docs/en/docs/admin/reference/agent/collectors/memory.md b/docs/en/docs/admin/reference/agent/collectors/memory.md index 8e6c5b5158..7cc78f1f6a 100644 --- a/docs/en/docs/admin/reference/agent/collectors/memory.md +++ b/docs/en/docs/admin/reference/agent/collectors/memory.md @@ -4,12 +4,13 @@ ## Configuration -| Parameter | Type | Default | Description | -| ---------- | ---------------- | ------- | ------------------------------------------------------------------------------------------- | -| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | -| `type` | String | | Must be `memory` | -| `interval` | Integer | | Repetition interval in seconds | -| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | +| Parameter | Type | Default | Description | +| ---------- | ---------------- | ------------- | ------------------------------------------------------------------------------------------- | +| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | +| `type` | String | | Must be `memory` | +| `service` | String | Equal to `id` | Service id for output metrics | +| `interval` | Integer | | Repetition interval in seconds | +| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | ## Collected Metrics diff --git a/docs/en/docs/admin/reference/agent/collectors/network.md b/docs/en/docs/admin/reference/agent/collectors/network.md index 9941e8d91b..6de8e8bf5b 100644 --- a/docs/en/docs/admin/reference/agent/collectors/network.md +++ b/docs/en/docs/admin/reference/agent/collectors/network.md @@ -4,12 +4,13 @@ ## Configuration -| Parameter | Type | Default | Description | -| ---------- | ---------------- | ------- | ------------------------------------------------------------------------------------------- | -| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | -| `type` | String | | Must be `network` | -| `interval` | Integer | | Repetition interval in seconds | -| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | +| Parameter | Type | Default | Description | +| ---------- | ---------------- | ------------- | ------------------------------------------------------------------------------------------- | +| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | +| `type` | String | | Must be `network` | +| `service` | String | Equal to `id` | Service id for output metrics | +| `interval` | Integer | | Repetition interval in seconds | +| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | ## Collected Metrics diff --git a/docs/en/docs/admin/reference/agent/collectors/test.md b/docs/en/docs/admin/reference/agent/collectors/test.md index 7c0a28937d..29e7a9de52 100644 --- a/docs/en/docs/admin/reference/agent/collectors/test.md +++ b/docs/en/docs/admin/reference/agent/collectors/test.md @@ -5,12 +5,13 @@ Every run completes with success and no metrics are produced. ## Configuration -| Parameter | Type | Default | Description | -| ---------- | ---------------- | ------- | ------------------------------------------------------------------------------------------- | -| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | -| `type` | String | | Must be `test` | -| `interval` | Integer | | Repetition interval in seconds | -| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | +| Parameter | Type | Default | Description | +| ---------- | ---------------- | ------------- | ------------------------------------------------------------------------------------------- | +| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | +| `type` | String | | Must be `test` | +| `service` | String | Equal to `id` | Service id for output metrics | +| `interval` | Integer | | Repetition interval in seconds | +| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | ## Compilation Features diff --git a/docs/en/docs/admin/reference/agent/collectors/twamp_sender.md b/docs/en/docs/admin/reference/agent/collectors/twamp_sender.md index 25717addf5..8360155516 100644 --- a/docs/en/docs/admin/reference/agent/collectors/twamp_sender.md +++ b/docs/en/docs/admin/reference/agent/collectors/twamp_sender.md @@ -5,18 +5,19 @@ TWAMP SLA probe using one of the predefined [packet models](#packet-models). ## Configuration -| Parameter | Type | Default | Description | -| ----------- | ---------------- | ------- | ------------------------------------------------------------------------------------------- | -| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | -| `type` | String | | Must be `twamp_sender` | -| `interval` | Integer | | Repetition interval in seconds | -| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | -| | | | | -| `server` | String | | | -| `port` | Integer | `862` | | -| `dscp` | String | `be` | | -| `n_packets` | Integer | | | -| `model` | String | | Name of the [packet model](#packet-models) | +| Parameter | Type | Default | Description | +| ----------- | ---------------- | ------------- | ------------------------------------------------------------------------------------------- | +| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | +| `type` | String | | Must be `twamp_sender` | +| `service` | String | Equal to `id` | Service id for output metrics | +| `interval` | Integer | | Repetition interval in seconds | +| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | +| | | | | +| `server` | String | | | +| `port` | Integer | `862` | | +| `dscp` | String | `be` | | +| `n_packets` | Integer | | | +| `model` | String | | Name of the [packet model](#packet-models) | ### Packet Models diff --git a/docs/en/docs/admin/reference/agent/collectors/uptime.md b/docs/en/docs/admin/reference/agent/collectors/uptime.md index 525055a9ec..cf34765748 100644 --- a/docs/en/docs/admin/reference/agent/collectors/uptime.md +++ b/docs/en/docs/admin/reference/agent/collectors/uptime.md @@ -4,12 +4,13 @@ ## Configuration -| Parameter | Type | Default | Description | -| ---------- | ---------------- | ------- | ------------------------------------------------------------------------------------------- | -| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | -| `type` | String | | Must be `uptime` | -| `interval` | Integer | | Repetition interval in seconds | -| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | +| Parameter | Type | Default | Description | +| ---------- | ---------------- | ------------- | ------------------------------------------------------------------------------------------- | +| `id` | String | | Collector's ID. Must be unique per agent instance. Will be returned along with the metrics. | +| `type` | String | | Must be `uptime` | +| `service` | String | Equal to `id` | Service id for output metrics | +| `interval` | Integer | | Repetition interval in seconds | +| `labels` | Array of Strings | | List of additional labels. Will be returned along with metrics | ## Collected Metrics -- GitLab