From dcfdce56a167beba9840251313804f392ef299c1 Mon Sep 17 00:00:00 2001 From: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> Date: Mon, 27 Nov 2023 11:46:56 -0800 Subject: [PATCH] Update shared content topics (#5845) * Update layout and syntax in shared topics * Updates to language passive voice use etc * General updates to words syntax and voice * Fix sorting in table * Fix table spacing * Correct capitalization of boolean * Apply suggestions from code review Co-authored-by: Robert Fratto * Update docs/sources/shared/flow/reference/components/otelcol-debug-metrics-block.md --------- Co-authored-by: Robert Fratto --- .../components/authorization-block.md | 13 +++--- .../reference/components/azuread-block.md | 6 +-- .../reference/components/basic-auth-block.md | 13 +++--- .../components/exporter-component-exports.md | 9 ++-- .../components/extract-field-block.md | 33 ++++++------- .../components/field-filter-block.md | 18 ++++---- .../components/http-client-config-block.md | 18 ++++---- .../components/local-file-arguments-text.md | 25 ++++------ .../reference/components/loki-server-grpc.md | 25 +++++----- .../reference/components/loki-server-http.md | 19 ++++---- .../components/managed_identity-block.md | 10 ++-- .../components/match-properties-block.md | 18 ++++---- .../flow/reference/components/oauth2-block.md | 23 +++++----- .../components/otelcol-compression-field.md | 7 ++- .../components/otelcol-debug-metrics-block.md | 12 ++--- .../otelcol-filter-attribute-block.md | 10 ++-- .../otelcol-filter-library-block.md | 12 ++--- .../otelcol-filter-log-severity-block.md | 13 +++--- .../components/otelcol-filter-regexp-block.md | 8 ++-- .../otelcol-filter-resource-block.md | 12 ++--- .../components/otelcol-grpc-authority.md | 7 ++- .../components/otelcol-grpc-balancer-name.md | 8 ++-- .../components/otelcol-queue-block.md | 29 +++++------- .../components/otelcol-retry-block.md | 34 ++++++-------- .../components/otelcol-tls-config-block.md | 41 ++++++++--------- .../reference/components/output-block-logs.md | 15 +++--- .../components/output-block-metrics.md | 9 ++-- .../components/output-block-traces.md | 15 +++--- .../flow/reference/components/output-block.md | 19 ++++---- .../components/prom-operator-scrape.md | 8 ++-- .../reference/components/rule-block-logs.md | 46 +++++++++---------- .../flow/reference/components/rule-block.md | 42 ++++++++--------- .../flow/reference/components/sigv4-block.md | 14 +++--- .../reference/components/tls-config-block.md | 25 +++++----- 34 files changed, 286 insertions(+), 330 deletions(-) diff --git a/docs/sources/shared/flow/reference/components/authorization-block.md b/docs/sources/shared/flow/reference/components/authorization-block.md index 190cd11f8bb9..11a74326f997 100644 --- a/docs/sources/shared/flow/reference/components/authorization-block.md +++ b/docs/sources/shared/flow/reference/components/authorization-block.md @@ -10,11 +10,10 @@ description: Shared content, authorization block headless: true --- -Name | Type | Description | Default | Required ----- | ---- | ----------- | ------- | -------- -`type` | `string` | Authorization type, for example, "Bearer". | | no -`credentials` | `secret` | Secret value. | | no -`credentials_file` | `string` | File containing the secret value. | | no +Name | Type | Description | Default | Required +-------------------|----------|--------------------------------------------|---------|--------- +`credentials_file` | `string` | File containing the secret value. | | no +`credentials` | `secret` | Secret value. | | no +`type` | `string` | Authorization type, for example, "Bearer". | | no -`credential` and `credentials_file` are mutually exclusive and only one can be -provided inside of an `authorization` block. +`credential` and `credentials_file` are mutually exclusive, and only one can be provided inside an `authorization` block. diff --git a/docs/sources/shared/flow/reference/components/azuread-block.md b/docs/sources/shared/flow/reference/components/azuread-block.md index ebdf436d02fe..07d974385134 100644 --- a/docs/sources/shared/flow/reference/components/azuread-block.md +++ b/docs/sources/shared/flow/reference/components/azuread-block.md @@ -10,11 +10,11 @@ description: Shared content, azuread block headless: true --- -Name | Type | Description | Default | Required ----- | ---- | ----------- | ------- | -------- +Name | Type | Description | Default | Required +--------|----------|------------------|-----------------|--------- `cloud` | `string` | The Azure Cloud. | `"AzurePublic"` | no The supported values for `cloud` are: * `"AzurePublic"` * `"AzureChina"` -* `"AzureGovernment"` \ No newline at end of file +* `"AzureGovernment"` diff --git a/docs/sources/shared/flow/reference/components/basic-auth-block.md b/docs/sources/shared/flow/reference/components/basic-auth-block.md index 06c81f660e3c..62f7e0a25d61 100644 --- a/docs/sources/shared/flow/reference/components/basic-auth-block.md +++ b/docs/sources/shared/flow/reference/components/basic-auth-block.md @@ -10,11 +10,10 @@ description: Shared content, basic auth block headless: true --- -Name | Type | Description | Default | Required ----- | ---- | ----------- | ------- | -------- -`username` | `string` | Basic auth username. | | no -`password` | `secret` | Basic auth password. | | no -`password_file` | `string` | File containing the basic auth password. | | no +Name | Type | Description | Default | Required +----------------|----------|------------------------------------------|---------|--------- +`password_file` | `string` | File containing the basic auth password. | | no +`password` | `secret` | Basic auth password. | | no +`username` | `string` | Basic auth username. | | no -`password` and `password_file` are mutually exclusive and only one can be -provided inside of a `basic_auth` block. +`password` and `password_file` are mutually exclusive, and only one can be provided inside a `basic_auth` block. diff --git a/docs/sources/shared/flow/reference/components/exporter-component-exports.md b/docs/sources/shared/flow/reference/components/exporter-component-exports.md index beb717a13fae..f1a8ca440cd9 100644 --- a/docs/sources/shared/flow/reference/components/exporter-component-exports.md +++ b/docs/sources/shared/flow/reference/components/exporter-component-exports.md @@ -13,15 +13,12 @@ headless: true The following fields are exported and can be referenced by other components. Name | Type | Description ---------- | ------------------- | ----------- +----------|---------------------|---------------------------------------------------------- `targets` | `list(map(string))` | The targets that can be used to collect exporter metrics. -For example, the `targets` can either be passed to a `discovery.relabel` -component to rewrite the targets' label sets, or to a `prometheus.scrape` -component that collects the exposed metrics. +For example, the `targets` can either be passed to a `discovery.relabel` component to rewrite the targets' label sets or to a `prometheus.scrape` component that collects the exposed metrics. -The exported targets will use the configured [in-memory traffic][] address -specified by the [run command][]. +The exported targets use the configured [in-memory traffic][] address specified by the [run command][]. [in-memory traffic]: {{< relref "../../../../flow/concepts/component_controller.md#in-memory-traffic" >}} [run command]: {{< relref "../../../../flow/reference/cli/run.md" >}} diff --git a/docs/sources/shared/flow/reference/components/extract-field-block.md b/docs/sources/shared/flow/reference/components/extract-field-block.md index 5036097d155f..207f2bc6053d 100644 --- a/docs/sources/shared/flow/reference/components/extract-field-block.md +++ b/docs/sources/shared/flow/reference/components/extract-field-block.md @@ -12,31 +12,28 @@ headless: true The following attributes are supported: -Name | Type | Description | Default | Required ----- |----------------|----------------------------------------------------------------------------------------------------------|---------| -------- -`tag_name` | `string` | The name of the resource attribute that will be added to logs, metrics, or spans. | `""` | no -`key` | `string` | The annotation (or label) name. This must exactly match an annotation (or label) name. | `""` | no -`key_regex` | `string` | A regular expression used to extract a key that matches the regex. | `""` | no -`regex` | `string` | An optional field used to extract a sub-string from a complex field value. | `""` | no -`from` | `string` | The source of the labels or annotations. Allowed values are `pod` and `namespace`. | `pod` | no - -When `tag_name` is not specified, a default tag name will be used with the format: +Name | Type | Description | Default | Required +------------|----------|----------------------------------------------------------------------------------------|---------|--------- +`from` | `string` | The source of the labels or annotations. Allowed values are `pod` and `namespace`. | `pod` | no +`key_regex` | `string` | A regular expression used to extract a key that matches the regular expression. | `""` | no +`key` | `string` | The annotation or label name. This key must exactly match an annotation or label name. | `""` | no +`regex` | `string` | An optional field used to extract a sub-string from a complex field value. | `""` | no +`tag_name` | `string` | The name of the resource attribute added to logs, metrics, or spans. | `""` | no + +When you don't specify the `tag_name`, a default tag name is used with the format: * `k8s.pod.annotations.` * `k8s.pod.labels.