From d3ed6e168c8dc02bee7dac92eff1230b588fc57d Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Fri, 3 Jan 2025 15:40:24 -0500 Subject: [PATCH 01/18] link: full list of `ServerConfig` Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/zipkinreceiver/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/receiver/zipkinreceiver/README.md b/receiver/zipkinreceiver/README.md index 0fc0939be843..58477402adaf 100644 --- a/receiver/zipkinreceiver/README.md +++ b/receiver/zipkinreceiver/README.md @@ -28,7 +28,7 @@ receivers: The following settings are configurable: -- `endpoint` (default = localhost:9411): host:port on which the receiver is going to receive data.See our [security best practices doc](https://opentelemetry.io/docs/security/config-best-practices/#protect-against-denial-of-service-attacks) to understand how to set the endpoint in different environments. For full list of `ServerConfig` refer [here](https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/confighttp). +- `endpoint` (default = localhost:9411): host:port on which the receiver is going to receive data.See our [security best practices doc](https://opentelemetry.io/docs/security/config-best-practices/#protect-against-denial-of-service-attacks) to understand how to set the endpoint in different environments. You can review the [full list of `ServerConfig`](https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/confighttp). - `parse_string_tags` (default = false): if enabled, the receiver will attempt to parse string tags/binary annotations into int/bool/float. ## Advanced Configuration From e9936d33d8f4a305ed6047d54a87bfbd9ef8d828 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 5 Jan 2025 16:50:50 -0500 Subject: [PATCH 02/18] link: By default, insecure settings are rejected and certificate verification is on Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/bigipreceiver/README.md | 2 +- receiver/flinkmetricsreceiver/README.md | 2 +- receiver/mongodbreceiver/README.md | 2 +- receiver/rabbitmqreceiver/README.md | 2 +- receiver/riakreceiver/README.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/receiver/bigipreceiver/README.md b/receiver/bigipreceiver/README.md index b1c80a18042b..49aa27eadb61 100644 --- a/receiver/bigipreceiver/README.md +++ b/receiver/bigipreceiver/README.md @@ -29,7 +29,7 @@ The following settings are optional: - `endpoint` (default: `https://localhost:443`): The URL of the Big-IP environment. - `collection_interval` (default = `10s`): This receiver collects metrics on an interval. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. -- `tls` (defaults defined [here](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md)): TLS control. By default insecure settings are rejected and certificate verification is on. +- `tls`: TLS control. [By default, insecure settings are rejected and certificate verification is on](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). ### Example Configuration diff --git a/receiver/flinkmetricsreceiver/README.md b/receiver/flinkmetricsreceiver/README.md index 1ba5e7f198de..2c7859062eb7 100644 --- a/receiver/flinkmetricsreceiver/README.md +++ b/receiver/flinkmetricsreceiver/README.md @@ -28,7 +28,7 @@ The following settings are optional: - `endpoint` (default: `http://localhost:15672`): The URL of the node to be monitored. - `collection_interval` (default = `10s`): This receiver collects metrics on an interval. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. -- `tls` (defaults defined [here](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md)): TLS control. By default insecure settings are rejected and certificate verification is on. +- `tls`: TLS control. [By default, insecure settings are rejected and certificate verification is on](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). - `initial_delay` (default = `1s`): defines how long this receiver waits before starting. ### Example Configuration diff --git a/receiver/mongodbreceiver/README.md b/receiver/mongodbreceiver/README.md index 1ffaba9f6fbc..f872f48a9783 100644 --- a/receiver/mongodbreceiver/README.md +++ b/receiver/mongodbreceiver/README.md @@ -45,7 +45,7 @@ The following settings are optional: - `initial_delay` (default = `1s`): defines how long this receiver waits before starting. - `replica_set`: If the deployment of MongoDB is a replica set then this allows users to specify the replica set name which allows for autodiscovery of other nodes in the replica set. - `timeout`: (default = `1m`) The timeout of running commands against mongo. -- `tls`: (defaults defined [here](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md)): TLS control. By default insecure settings are rejected and certificate verification is on. +- `tls`: TLS control. [By default, insecure settings are rejected and certificate verification is on](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). - `direct_connection`: If true, then the driver will not try to autodiscover other nodes, and perform instead a direct connection o the host. ### Example Configuration diff --git a/receiver/rabbitmqreceiver/README.md b/receiver/rabbitmqreceiver/README.md index 4d6bc771f30c..9adda8eca2e7 100644 --- a/receiver/rabbitmqreceiver/README.md +++ b/receiver/rabbitmqreceiver/README.md @@ -34,7 +34,7 @@ The following settings are optional: - `endpoint` (default: `http://localhost:15672`): The URL of the node to be monitored. - `collection_interval` (default = `10s`): This receiver collects metrics on an interval. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. -- `tls` (defaults defined [here](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md)): TLS control. By default insecure settings are rejected and certificate verification is on. +- `tls`: TLS control. [By default, insecure settings are rejected and certificate verification is on](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). ### Example Configuration diff --git a/receiver/riakreceiver/README.md b/receiver/riakreceiver/README.md index a04f763b1968..1d235fa25c82 100644 --- a/receiver/riakreceiver/README.md +++ b/receiver/riakreceiver/README.md @@ -30,7 +30,7 @@ The following configuration settings are optional: - `endpoint` (default: `http://localhost:8098`): The URL of the node to be monitored. - `collection_interval` (default = `60s`): This receiver collects metrics on an interval. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. - `initial_delay` (default = `1s`): defines how long this receiver waits before starting. -- `tls` (defaults defined [here](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md)): TLS control. By default insecure settings are rejected and certificate verification is on. +- `tls`: TLS control. [By default, insecure settings are rejected and certificate verification is on](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). ### Example Configuration From 9fab1a32c3c0221de93705fd18df1218a8ebbdb2 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 5 Jan 2025 13:51:10 -0500 Subject: [PATCH 03/18] link: DefaultMetricSettings Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/snowflakereceiver/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/receiver/snowflakereceiver/README.md b/receiver/snowflakereceiver/README.md index 380e29f11239..ae4d8c22e7e2 100644 --- a/receiver/snowflakereceiver/README.md +++ b/receiver/snowflakereceiver/README.md @@ -24,7 +24,7 @@ The following settings are required: The following settings are optional: -* `metrics` (default: see `DefaultMetricSettings` [here](./internal/metadata/generated_metrics.go)): Controls the enabling/disabling of specific metrics. For in depth documentation on the allowable metrics see [here](./documentation.md). +* `metrics` (default: see [`DefaultMetricSettings`](./internal/metadata/generated_metrics.go)): Controls the enabling/disabling of specific metrics. For in depth documentation on the allowable metrics see [here](./documentation.md). * `schema` (default: 'ACCOUNT_USAGE'): Snowflake DB schema containing usage statistics and metadata to be monitored. * `database` (default: 'SNOWFLAKE'): Snowflake DB containing schema with usage statistics and metadata to be monitored. * `role` (default: 'ACCOUNTADMIN'): Role associated with the username designated above. By default admin privileges are required to access most/all of the usage data. From 5f44ea6780226dd1e1cc395079dc4529533e86b1 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sat, 4 Jan 2025 23:04:03 -0500 Subject: [PATCH 04/18] link: DefaultMetricsSettings Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/activedirectorydsreceiver/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/receiver/activedirectorydsreceiver/README.md b/receiver/activedirectorydsreceiver/README.md index 1730b5d5fa61..4bdad762d1a1 100644 --- a/receiver/activedirectorydsreceiver/README.md +++ b/receiver/activedirectorydsreceiver/README.md @@ -17,7 +17,7 @@ The `active_directory_ds` receiver scrapes metrics relating to an Active Directo ## Configuration The following settings are optional: -- `metrics` (default: see `DefaultMetricsSettings` [here](./internal/metadata/generated_metrics.go)): Allows enabling and disabling specific metrics from being collected in this receiver. +- `metrics` (default: see [`DefaultMetricsSettings`](./internal/metadata/generated_metrics.go)): Allows enabling and disabling specific metrics from being collected in this receiver. - `collection_interval` (default = `10s`): The interval at which metrics are emitted by this receiver. - `initial_delay` (default = `1s`): defines how long this receiver waits before starting. From 76d057f124e0a0797547df88e71b26a5ca8d8fcb Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 5 Jan 2025 13:45:31 -0500 Subject: [PATCH 05/18] link: Grafana Dashboard for metrics from this receiver is on the marketplace Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/githubreceiver/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/receiver/githubreceiver/README.md b/receiver/githubreceiver/README.md index ecff5133e990..f3009100b517 100644 --- a/receiver/githubreceiver/README.md +++ b/receiver/githubreceiver/README.md @@ -73,9 +73,7 @@ service: exporters: [...] ``` -A Grafana Dashboard exists on the marketplace for metrics from this receiver -and can be found -[here](https://grafana.com/grafana/dashboards/20976-engineering-effectiveness-metrics/). +A [Grafana Dashboard for metrics from this receiver is on the marketplace](https://grafana.com/grafana/dashboards/20976-engineering-effectiveness-metrics/). ## Scraping From 03b4d16a0fa8585fff209bb30bddccfe78c1b8bd Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 5 Jan 2025 13:48:55 -0500 Subject: [PATCH 06/18] link: Huawei Cloud region Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/huaweicloudcesreceiver/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/receiver/huaweicloudcesreceiver/README.md b/receiver/huaweicloudcesreceiver/README.md index 28e006ebe991..3541e1f9355f 100644 --- a/receiver/huaweicloudcesreceiver/README.md +++ b/receiver/huaweicloudcesreceiver/README.md @@ -17,7 +17,7 @@ This receiver contains the implementation of the Huawei Cloud [Cloud Eye Service The following settings are required: -- `region_id`: The ID of the Huawei Cloud region from which metrics are collected. For example, `eu-west-101`. The full list of the available regions can be found [here](https://pkg.go.dev/github.com/huaweicloud/huaweicloud-sdk-go-v3@v0.1.104/services/ces/v1/region). +- `region_id`: The ID of the [Huawei Cloud region](https://pkg.go.dev/github.com/huaweicloud/huaweicloud-sdk-go-v3@v0.1.104/services/ces/v1/region) from which metrics are collected. For example, `eu-west-101`. - `project_id`: The ID of the project in Huawei Cloud. This is used to identify which project's metrics are to be collected. See [Obtaining a Project ID](https://support.huaweicloud.com/intl/en-us/devg-apisign/api-sign-provide-proid.html). From 678c07bfbb4770f3f33294c95fffe6e6f7bdab87 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 5 Jan 2025 17:01:47 -0500 Subject: [PATCH 07/18] link: Loki HTTP API: Ingest logs Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/lokireceiver/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/receiver/lokireceiver/README.md b/receiver/lokireceiver/README.md index 7786ce40873d..0e91c527e204 100644 --- a/receiver/lokireceiver/README.md +++ b/receiver/lokireceiver/README.md @@ -12,7 +12,7 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -The Loki receiver implements the [Loki push api](https://grafana.com/docs/loki/latest/clients/promtail/#loki-push-api) as specified [here](https://grafana.com/docs/loki/latest/api/#push-log-entries-to-loki). +The Loki receiver implements the [Loki push api](https://grafana.com/docs/loki/latest/clients/promtail/#loki-push-api) as specified in [Loki HTTP API: Ingest logs](https://grafana.com/docs/loki/latest/reference/loki-http-api/#ingest-logs). It allows Promtail instances to specify the open telemetry collector as their lokiAddress. This receiver runs HTTP and GRPC servers to ingest log entries in Loki format. From 112797844f6cf31777e31c7c199ecbe2223d3833 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 5 Jan 2025 14:46:28 -0500 Subject: [PATCH 08/18] link: Prometheus license Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/prometheusreceiver/DESIGN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/receiver/prometheusreceiver/DESIGN.md b/receiver/prometheusreceiver/DESIGN.md index 6da2c713ffea..a33e42d0254f 100644 --- a/receiver/prometheusreceiver/DESIGN.md +++ b/receiver/prometheusreceiver/DESIGN.md @@ -156,7 +156,7 @@ type ExemplarAppender interface { } ``` -*Note: the above code belongs to the Prometheus project, its license can be found [here](https://github.com/prometheus/prometheus/blob/v2.26.0/LICENSE)* +*Note: the above code belongs to the Prometheus project, and is covered by the [Prometheus license](https://github.com/prometheus/prometheus/blob/v2.26.0/LICENSE)* One can see that the interface is very simple, it only has 4 methods (once we account for the embedded `ExemplarAppender` interface): `Append`, `AppendExemplar`, From ca99dab60b8148f593d5f496c16bc3eab103e2f8 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sat, 4 Jan 2025 23:06:00 -0500 Subject: [PATCH 09/18] link: apache scoreboard Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/apachereceiver/documentation.md | 2 +- receiver/apachereceiver/metadata.yaml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/receiver/apachereceiver/documentation.md b/receiver/apachereceiver/documentation.md index a0514c8405d2..7190b5fe0588 100644 --- a/receiver/apachereceiver/documentation.md +++ b/receiver/apachereceiver/documentation.md @@ -87,7 +87,7 @@ The number of requests serviced by the HTTP server per second. The number of workers in each state. -The apache scoreboard is an encoded representation of the state of all the server's workers. This metric decodes the scoreboard and presents a count of workers in each state. Additional details can be found [here](https://metacpan.org/pod/Apache::Scoreboard#DESCRIPTION). +The [apache scoreboard](https://metacpan.org/pod/Apache::Scoreboard#DESCRIPTION) is an encoded representation of the state of all the server's workers. This metric decodes the scoreboard and presents a count of workers in each state. | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | | ---- | ----------- | ---------- | ----------------------- | --------- | diff --git a/receiver/apachereceiver/metadata.yaml b/receiver/apachereceiver/metadata.yaml index 82b897db1b2d..38ab65b620b1 100644 --- a/receiver/apachereceiver/metadata.yaml +++ b/receiver/apachereceiver/metadata.yaml @@ -164,9 +164,9 @@ metrics: enabled: true description: The number of workers in each state. extended_documentation: >- - The apache scoreboard is an encoded representation of the state of all the server's workers. + The [apache scoreboard](https://metacpan.org/pod/Apache::Scoreboard#DESCRIPTION) + is an encoded representation of the state of all the server's workers. This metric decodes the scoreboard and presents a count of workers in each state. - Additional details can be found [here](https://metacpan.org/pod/Apache::Scoreboard#DESCRIPTION). unit: "{workers}" sum: value_type: int From c3ec2fce20fce38dc45bd407a509fa76f7d67712 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 5 Jan 2025 13:48:09 -0500 Subject: [PATCH 10/18] link: experimentalmetricmetadata/metadata.go Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/k8sclusterreceiver/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/receiver/k8sclusterreceiver/README.md b/receiver/k8sclusterreceiver/README.md index 53f9990eef01..91d34f1c2d64 100644 --- a/receiver/k8sclusterreceiver/README.md +++ b/receiver/k8sclusterreceiver/README.md @@ -123,7 +123,7 @@ type MetadataDelta struct { } ``` -See [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/experimentalmetricmetadata/metadata.go) for details about the above types. +See [experimentalmetricmetadata/metadata.go](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/experimentalmetricmetadata/metadata.go) for details about the above types. The same metadata will be also emitted as entity events in the form of log records if this receiver is connected to a logs pipeline. From 241dcc57e7ab349e70ec63201c6fe046f73465a5 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sat, 4 Jan 2025 23:18:29 -0500 Subject: [PATCH 11/18] link: go sdk's default authentication mechanism Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/awsxrayreceiver/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/receiver/awsxrayreceiver/README.md b/receiver/awsxrayreceiver/README.md index 5163880970a0..4bc2616d90d6 100644 --- a/receiver/awsxrayreceiver/README.md +++ b/receiver/awsxrayreceiver/README.md @@ -15,7 +15,7 @@ The AWS X-Ray receiver accepts segments (i.e. spans) in the [X-Ray Segment format](https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html). This enables the collector to receive spans emitted by the existing X-Ray SDK. [Centralized sampling](https://github.com/aws/aws-xray-daemon/blob/master/CHANGELOG.md#300-2018-08-28) is also supported via a local TCP port. -The requests sent to AWS are authenticated using the mechanism documented [here](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials). +The requests sent to AWS using the [go sdk's default authentication mechanism](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials). ## Configuration From 5c38c83a24d3bd7e883e806fd086e615c35b96a7 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 5 Jan 2025 14:42:41 -0500 Subject: [PATCH 12/18] link: in-depth documentation on the allowable metrics Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/snowflakereceiver/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/receiver/snowflakereceiver/README.md b/receiver/snowflakereceiver/README.md index ae4d8c22e7e2..5470342fa0fd 100644 --- a/receiver/snowflakereceiver/README.md +++ b/receiver/snowflakereceiver/README.md @@ -24,7 +24,7 @@ The following settings are required: The following settings are optional: -* `metrics` (default: see [`DefaultMetricSettings`](./internal/metadata/generated_metrics.go)): Controls the enabling/disabling of specific metrics. For in depth documentation on the allowable metrics see [here](./documentation.md). +* `metrics` (default: see [`DefaultMetricSettings`](./internal/metadata/generated_metrics.go)): Controls the enabling/disabling of specific metrics. See [in-depth documentation on the allowable metrics](./documentation.md). * `schema` (default: 'ACCOUNT_USAGE'): Snowflake DB schema containing usage statistics and metadata to be monitored. * `database` (default: 'SNOWFLAKE'): Snowflake DB containing schema with usage statistics and metadata to be monitored. * `role` (default: 'ACCOUNTADMIN'): Role associated with the username designated above. By default admin privileges are required to access most/all of the usage data. From 228b812f2e7d12667085e62c77b3b8e2fb9e9bf8 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 5 Jan 2025 16:52:45 -0500 Subject: [PATCH 13/18] link: metadata.yaml Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/kafkametricsreceiver/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/receiver/kafkametricsreceiver/README.md b/receiver/kafkametricsreceiver/README.md index 188e4712cce5..c6b9341ca1d2 100644 --- a/receiver/kafkametricsreceiver/README.md +++ b/receiver/kafkametricsreceiver/README.md @@ -31,7 +31,7 @@ Required settings (no defaults): - `consumers` - `brokers` -Metrics collected by the associated scraper are listed [here](metadata.yaml) +Metrics collected by the associated scraper are listed in [metadata.yaml](metadata.yaml) Optional Settings (with defaults): From df914b99426344484fa439a7f92695bd6a522f2b Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 5 Jan 2025 13:49:41 -0500 Subject: [PATCH 14/18] link: node conditions Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/k8sclusterreceiver/README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/receiver/k8sclusterreceiver/README.md b/receiver/k8sclusterreceiver/README.md index 91d34f1c2d64..1351f67e539c 100644 --- a/receiver/k8sclusterreceiver/README.md +++ b/receiver/k8sclusterreceiver/README.md @@ -45,11 +45,9 @@ In addition, metadata of all entities is collected periodically even if no chang This setting controls the interval between periodic collections. Setting the duration to 0 will disable periodic collection (however will not impact metadata collection on changes). -- `node_conditions_to_report` (default = `[Ready]`): An array of node -conditions this receiver should report. See -[here](https://kubernetes.io/docs/concepts/architecture/nodes/#condition) for -list of node conditions. The receiver will emit one metric per entry in the -array. +- `node_conditions_to_report` (default = `[Ready]`): An array of [node +conditions](https://kubernetes.io/docs/concepts/architecture/nodes/#condition) +this receiver should report. The receiver will emit one metric per entry in the array. - `distribution` (default = `kubernetes`): The Kubernetes distribution being used by the cluster. Currently supported versions are `kubernetes` and `openshift`. Setting the value to `openshift` enables OpenShift specific metrics in addition to standard From 55b46181b4ea81c747f754f53470da3b42e35ea6 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 5 Jan 2025 13:48:26 -0500 Subject: [PATCH 15/18] link: opentelemetry-collector-contrib#23565 Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/k8sclusterreceiver/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/receiver/k8sclusterreceiver/README.md b/receiver/k8sclusterreceiver/README.md index 1351f67e539c..c7c5bd4b8e0a 100644 --- a/receiver/k8sclusterreceiver/README.md +++ b/receiver/k8sclusterreceiver/README.md @@ -125,7 +125,7 @@ See [experimentalmetricmetadata/metadata.go](https://github.com/open-telemetry/o The same metadata will be also emitted as entity events in the form of log records if this receiver is connected to a logs pipeline. -See [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/23565) +See [opentelemetry-collector-contrib#23565](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/23565) for the format of emitted log records. ## Example From 72d41c174fbc68ccad61303a3465e753287b97a5 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 5 Jan 2025 16:55:03 -0500 Subject: [PATCH 16/18] link: signalfx/sapm-proto Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/sapmreceiver/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/receiver/sapmreceiver/README.md b/receiver/sapmreceiver/README.md index e2fec058f597..1e92d63ec4ab 100644 --- a/receiver/sapmreceiver/README.md +++ b/receiver/sapmreceiver/README.md @@ -16,8 +16,8 @@ The SAPM receiver builds on the Jaeger proto. This allows the collector to receive traces from other collectors or the SignalFx Smart Agent. SAPM proto -and some useful related utilities can be found -[here](https://github.com/signalfx/sapm-proto/). +and some useful related utilities can be found in +[signalfx/sapm-proto](https://github.com/signalfx/sapm-proto/). ## Configuration From da7163859fe22b870338844639b8bec5a28ef3a4 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 5 Jan 2025 15:13:16 -0500 Subject: [PATCH 17/18] link: sql/database Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/postgresqlreceiver/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/receiver/postgresqlreceiver/README.md b/receiver/postgresqlreceiver/README.md index c10dcf3b367f..a7490a197306 100644 --- a/receiver/postgresqlreceiver/README.md +++ b/receiver/postgresqlreceiver/README.md @@ -83,7 +83,7 @@ When this feature gate is enabled, the following optional settings are available - `max_idle`: The maximum number of connections in the idle connection pool. - `max_open`: The maximum number of open connections to the database. -Those settings and their defaults are further documented in the `sql/database` package [here](https://pkg.go.dev/database/sql#DB). +Those settings and their defaults are further documented in the [`sql/database`](https://pkg.go.dev/database/sql#DB) package. ### Example Configuration From c05d050278733ab71768bdf9ca51be1ca4930b9a Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Fri, 3 Jan 2025 11:23:36 -0500 Subject: [PATCH 18/18] link: config.go Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- receiver/activedirectorydsreceiver/README.md | 2 +- receiver/apachereceiver/README.md | 2 +- receiver/apachesparkreceiver/README.md | 2 +- receiver/bigipreceiver/README.md | 2 +- receiver/carbonreceiver/README.md | 4 ++-- receiver/cloudfoundryreceiver/README.md | 4 ++-- receiver/collectdreceiver/README.md | 4 ++-- receiver/couchdbreceiver/README.md | 2 +- receiver/dockerstatsreceiver/README.md | 4 ++-- receiver/elasticsearchreceiver/README.md | 2 +- receiver/flinkmetricsreceiver/README.md | 2 +- receiver/huaweicloudcesreceiver/README.md | 2 +- receiver/iisreceiver/README.md | 2 +- receiver/k8sclusterreceiver/README.md | 4 ++-- receiver/k8seventsreceiver/README.md | 4 ++-- receiver/k8sobjectsreceiver/README.md | 4 ++-- receiver/kubeletstatsreceiver/README.md | 4 ++-- receiver/memcachedreceiver/README.md | 4 ++-- receiver/mongodbreceiver/README.md | 2 +- receiver/mysqlreceiver/README.md | 2 +- receiver/nginxreceiver/README.md | 4 ++-- receiver/nsxtreceiver/README.md | 2 +- receiver/ntpreceiver/README.md | 2 +- receiver/podmanreceiver/README.md | 4 ++-- receiver/postgresqlreceiver/README.md | 2 +- receiver/purefareceiver/README.md | 4 ++-- receiver/purefbreceiver/README.md | 4 ++-- receiver/rabbitmqreceiver/README.md | 2 +- receiver/receivercreator/README.md | 4 ++-- receiver/redisreceiver/README.md | 4 ++-- receiver/saphanareceiver/README.md | 4 ++-- receiver/sapmreceiver/README.md | 4 ++-- receiver/signalfxreceiver/README.md | 4 ++-- receiver/simpleprometheusreceiver/README.md | 4 ++-- receiver/snmpreceiver/README.md | 2 +- receiver/snowflakereceiver/README.md | 2 +- receiver/splunkenterprisereceiver/README.md | 2 +- receiver/splunkhecreceiver/README.md | 4 ++-- receiver/sqlserverreceiver/README.md | 2 +- receiver/sshcheckreceiver/README.md | 2 +- receiver/statsdreceiver/README.md | 4 ++-- receiver/vcenterreceiver/README.md | 2 +- receiver/wavefrontreceiver/README.md | 4 ++-- receiver/webhookeventreceiver/README.md | 2 +- 44 files changed, 66 insertions(+), 66 deletions(-) diff --git a/receiver/activedirectorydsreceiver/README.md b/receiver/activedirectorydsreceiver/README.md index 4bdad762d1a1..7cbc00f630f2 100644 --- a/receiver/activedirectorydsreceiver/README.md +++ b/receiver/activedirectorydsreceiver/README.md @@ -32,7 +32,7 @@ receivers: enabled: false ``` -The full list of settings exposed for this receiver is documented [here](./config.go), along with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver is documented in [config.go](./config.go), along with detailed sample configurations [here](./testdata/config.yaml). ## Metrics diff --git a/receiver/apachereceiver/README.md b/receiver/apachereceiver/README.md index b095009e6210..b57a7abfb830 100644 --- a/receiver/apachereceiver/README.md +++ b/receiver/apachereceiver/README.md @@ -40,7 +40,7 @@ receivers: endpoint: "http://localhost:8080/server-status?auto" ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ## Metrics diff --git a/receiver/apachesparkreceiver/README.md b/receiver/apachesparkreceiver/README.md index 65ce3f1275d4..2dbe79ab733c 100644 --- a/receiver/apachesparkreceiver/README.md +++ b/receiver/apachesparkreceiver/README.md @@ -47,7 +47,7 @@ receivers: - PythonLR ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ## Metrics diff --git a/receiver/bigipreceiver/README.md b/receiver/bigipreceiver/README.md index 49aa27eadb61..d2a6051a6f5c 100644 --- a/receiver/bigipreceiver/README.md +++ b/receiver/bigipreceiver/README.md @@ -44,7 +44,7 @@ receivers: insecure_skip_verify: true ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). TLS config is documented further under the [opentelemetry collector's configtls package](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). TLS config is documented further under the [opentelemetry collector's configtls package](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). ## Metrics diff --git a/receiver/carbonreceiver/README.md b/receiver/carbonreceiver/README.md index 8e7a0d9a2471..b4e2c5755557 100644 --- a/receiver/carbonreceiver/README.md +++ b/receiver/carbonreceiver/README.md @@ -64,6 +64,6 @@ receivers: name_separator: "_" ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). diff --git a/receiver/cloudfoundryreceiver/README.md b/receiver/cloudfoundryreceiver/README.md index ce7f85c151c6..6571d94646fd 100644 --- a/receiver/cloudfoundryreceiver/README.md +++ b/receiver/cloudfoundryreceiver/README.md @@ -72,8 +72,8 @@ receivers: password: "changeit" ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ## Telemetry common Attributes diff --git a/receiver/collectdreceiver/README.md b/receiver/collectdreceiver/README.md index 6b65f19f8617..d913b788ded9 100644 --- a/receiver/collectdreceiver/README.md +++ b/receiver/collectdreceiver/README.md @@ -49,6 +49,6 @@ receivers: timeout: "50s" ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). diff --git a/receiver/couchdbreceiver/README.md b/receiver/couchdbreceiver/README.md index 0b779d5462c2..6ccb441affb8 100644 --- a/receiver/couchdbreceiver/README.md +++ b/receiver/couchdbreceiver/README.md @@ -42,7 +42,7 @@ receivers: collection_interval: 60s ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). TLS config is documented further under the [opentelemetry collector's configtls package](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). TLS config is documented further under the [opentelemetry collector's configtls package](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). ## Metrics diff --git a/receiver/dockerstatsreceiver/README.md b/receiver/dockerstatsreceiver/README.md index ccfabc263b84..48e88460b639 100644 --- a/receiver/dockerstatsreceiver/README.md +++ b/receiver/dockerstatsreceiver/README.md @@ -70,8 +70,8 @@ receivers: enabled: false ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ## Deprecations diff --git a/receiver/elasticsearchreceiver/README.md b/receiver/elasticsearchreceiver/README.md index df0070e55d7f..8803a1e2c96d 100644 --- a/receiver/elasticsearchreceiver/README.md +++ b/receiver/elasticsearchreceiver/README.md @@ -51,7 +51,7 @@ receivers: collection_interval: 10s ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ## Metrics diff --git a/receiver/flinkmetricsreceiver/README.md b/receiver/flinkmetricsreceiver/README.md index 2c7859062eb7..9a1f1267238c 100644 --- a/receiver/flinkmetricsreceiver/README.md +++ b/receiver/flinkmetricsreceiver/README.md @@ -40,7 +40,7 @@ receivers: collection_interval: 10s ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). TLS config is documented further under the [opentelemetry collector's configtls package](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). TLS config is documented further under the [opentelemetry collector's configtls package](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). ## Metrics diff --git a/receiver/huaweicloudcesreceiver/README.md b/receiver/huaweicloudcesreceiver/README.md index 3541e1f9355f..2249b213e9da 100644 --- a/receiver/huaweicloudcesreceiver/README.md +++ b/receiver/huaweicloudcesreceiver/README.md @@ -72,7 +72,7 @@ receivers: no_verify_ssl: True ``` -The full list of settings exposed for this receiver are documented [here](./config.go). +The full list of settings exposed for this receiver are documented in [config.go](./config.go). ### Huawei Cloud SDK Authentication Setup diff --git a/receiver/iisreceiver/README.md b/receiver/iisreceiver/README.md index c4780b94b7f4..06515b0e1298 100644 --- a/receiver/iisreceiver/README.md +++ b/receiver/iisreceiver/README.md @@ -33,7 +33,7 @@ Example: ``` -The full list of settings exposed for this receiver are documented [here](./config.go). +The full list of settings exposed for this receiver are documented in [config.go](./config.go). ## Metrics diff --git a/receiver/k8sclusterreceiver/README.md b/receiver/k8sclusterreceiver/README.md index c7c5bd4b8e0a..1ebd6af45761 100644 --- a/receiver/k8sclusterreceiver/README.md +++ b/receiver/k8sclusterreceiver/README.md @@ -77,8 +77,8 @@ Example: enabled: false ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ### node_conditions_to_report diff --git a/receiver/k8seventsreceiver/README.md b/receiver/k8seventsreceiver/README.md index 143147dcd5f8..f2a0f6a05467 100644 --- a/receiver/k8seventsreceiver/README.md +++ b/receiver/k8seventsreceiver/README.md @@ -39,8 +39,8 @@ Examples: namespaces: [default, my_namespace] ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ## Example diff --git a/receiver/k8sobjectsreceiver/README.md b/receiver/k8sobjectsreceiver/README.md index afb9914a3d3b..c7bc34d7355c 100644 --- a/receiver/k8sobjectsreceiver/README.md +++ b/receiver/k8sobjectsreceiver/README.md @@ -58,8 +58,8 @@ For example, `events` resource is available in both `v1` and `events.k8s.io/v1` this case, it will select `v1` by default. -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). Follow the below sections to setup various Kubernetes resources required for the deployment. diff --git a/receiver/kubeletstatsreceiver/README.md b/receiver/kubeletstatsreceiver/README.md index d91c83402749..1c72da60b155 100644 --- a/receiver/kubeletstatsreceiver/README.md +++ b/receiver/kubeletstatsreceiver/README.md @@ -263,8 +263,8 @@ The following parameters can also be specified: - `collection_interval` (default = `10s`): The interval at which to collect data. - `insecure_skip_verify` (default = `false`): Whether or not to skip certificate verification. -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ### Role-based access control diff --git a/receiver/memcachedreceiver/README.md b/receiver/memcachedreceiver/README.md index d0c39bbbb7d1..b9a1ae3f7eef 100644 --- a/receiver/memcachedreceiver/README.md +++ b/receiver/memcachedreceiver/README.md @@ -46,8 +46,8 @@ receivers: collection_interval: 10s ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ## Metrics diff --git a/receiver/mongodbreceiver/README.md b/receiver/mongodbreceiver/README.md index f872f48a9783..afcd09c14cd9 100644 --- a/receiver/mongodbreceiver/README.md +++ b/receiver/mongodbreceiver/README.md @@ -64,7 +64,7 @@ receivers: insecure_skip_verify: true ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ## Metrics diff --git a/receiver/mysqlreceiver/README.md b/receiver/mysqlreceiver/README.md index 9bdea8f4327b..541fcb76f9ec 100644 --- a/receiver/mysqlreceiver/README.md +++ b/receiver/mysqlreceiver/README.md @@ -63,7 +63,7 @@ receivers: limit: 250 ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ## Metrics diff --git a/receiver/nginxreceiver/README.md b/receiver/nginxreceiver/README.md index 23ba20634461..d8a09fd28534 100644 --- a/receiver/nginxreceiver/README.md +++ b/receiver/nginxreceiver/README.md @@ -44,5 +44,5 @@ receivers: collection_interval: 10s ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). diff --git a/receiver/nsxtreceiver/README.md b/receiver/nsxtreceiver/README.md index d6825a3d4fbd..1cf16840f601 100644 --- a/receiver/nsxtreceiver/README.md +++ b/receiver/nsxtreceiver/README.md @@ -72,7 +72,7 @@ service: exporters: [file] ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ## Metrics diff --git a/receiver/ntpreceiver/README.md b/receiver/ntpreceiver/README.md index ab4642a21561..f15fc6cc38dc 100644 --- a/receiver/ntpreceiver/README.md +++ b/receiver/ntpreceiver/README.md @@ -36,7 +36,7 @@ receivers: initial_delay: 5m ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./internal/metadata/testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./internal/metadata/testdata/config.yaml). ## Metrics diff --git a/receiver/podmanreceiver/README.md b/receiver/podmanreceiver/README.md index f75d1d36e045..73baa358b11e 100644 --- a/receiver/podmanreceiver/README.md +++ b/receiver/podmanreceiver/README.md @@ -48,8 +48,8 @@ receivers: enabled: false ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ### Connecting over SSH diff --git a/receiver/postgresqlreceiver/README.md b/receiver/postgresqlreceiver/README.md index a7490a197306..f4c834a0f182 100644 --- a/receiver/postgresqlreceiver/README.md +++ b/receiver/postgresqlreceiver/README.md @@ -69,7 +69,7 @@ receivers: key_file: /home/otel/mypostgreskey.key ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). TLS config is documented further under the [opentelemetry collector's configtls package](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). TLS config is documented further under the [opentelemetry collector's configtls package](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). ## Connection pool feature diff --git a/receiver/purefareceiver/README.md b/receiver/purefareceiver/README.md index 48af5f922bf4..47e0b616a058 100644 --- a/receiver/purefareceiver/README.md +++ b/receiver/purefareceiver/README.md @@ -106,6 +106,6 @@ service: receivers: [purefa/array01,purefa/array02] ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). diff --git a/receiver/purefbreceiver/README.md b/receiver/purefbreceiver/README.md index e0ec50b746e3..bacff705f096 100644 --- a/receiver/purefbreceiver/README.md +++ b/receiver/purefbreceiver/README.md @@ -50,6 +50,6 @@ receivers: ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). diff --git a/receiver/rabbitmqreceiver/README.md b/receiver/rabbitmqreceiver/README.md index 9adda8eca2e7..74752d28df29 100644 --- a/receiver/rabbitmqreceiver/README.md +++ b/receiver/rabbitmqreceiver/README.md @@ -47,7 +47,7 @@ receivers: collection_interval: 10s ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). TLS config is documented further under the [opentelemetry collector's configtls package](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). TLS config is documented further under the [opentelemetry collector's configtls package](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). ## Metrics diff --git a/receiver/receivercreator/README.md b/receiver/receivercreator/README.md index 4fe12d38bcbe..fd7774d6f2c8 100644 --- a/receiver/receivercreator/README.md +++ b/receiver/receivercreator/README.md @@ -437,8 +437,8 @@ service: extensions: [k8s_observer, host_observer] ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ## Generate receiver configurations from provided Hints diff --git a/receiver/redisreceiver/README.md b/receiver/redisreceiver/README.md index 0b5e3c4d69d0..6935baf1d551 100644 --- a/receiver/redisreceiver/README.md +++ b/receiver/redisreceiver/README.md @@ -95,6 +95,6 @@ receivers: password: ${env:REDIS_PASSWORD} ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). diff --git a/receiver/saphanareceiver/README.md b/receiver/saphanareceiver/README.md index 3ed373085d27..2c8752d917e2 100644 --- a/receiver/saphanareceiver/README.md +++ b/receiver/saphanareceiver/README.md @@ -92,8 +92,8 @@ receivers: enabled: false ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ## Metrics diff --git a/receiver/sapmreceiver/README.md b/receiver/sapmreceiver/README.md index 1e92d63ec4ab..2cef11fb8a01 100644 --- a/receiver/sapmreceiver/README.md +++ b/receiver/sapmreceiver/README.md @@ -52,5 +52,5 @@ receivers: key_file: /test.key ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). diff --git a/receiver/signalfxreceiver/README.md b/receiver/signalfxreceiver/README.md index b2b5fd171240..0a0d8eb19d91 100644 --- a/receiver/signalfxreceiver/README.md +++ b/receiver/signalfxreceiver/README.md @@ -57,8 +57,8 @@ receivers: key_file: /test.key ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). > :warning: When enabling the SignalFx receiver or exporter, configure both the `metrics` and `logs` pipelines. diff --git a/receiver/simpleprometheusreceiver/README.md b/receiver/simpleprometheusreceiver/README.md index d4113c232b3e..cde8339a3315 100644 --- a/receiver/simpleprometheusreceiver/README.md +++ b/receiver/simpleprometheusreceiver/README.md @@ -75,5 +75,5 @@ Example: exporters: [signalfx] ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). diff --git a/receiver/snmpreceiver/README.md b/receiver/snmpreceiver/README.md index 7083140b19fe..aa96973563bf 100644 --- a/receiver/snmpreceiver/README.md +++ b/receiver/snmpreceiver/README.md @@ -248,5 +248,5 @@ receivers: ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). diff --git a/receiver/snowflakereceiver/README.md b/receiver/snowflakereceiver/README.md index 5470342fa0fd..caf353580708 100644 --- a/receiver/snowflakereceiver/README.md +++ b/receiver/snowflakereceiver/README.md @@ -46,4 +46,4 @@ receivers: enabled: false ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with a detailed sample configuration [here](./testdata/config.yaml) +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with a detailed sample configuration in [testdata/config.yaml](./testdata/config.yaml) diff --git a/receiver/splunkenterprisereceiver/README.md b/receiver/splunkenterprisereceiver/README.md index ccf82d7b5234..5149567e4dec 100644 --- a/receiver/splunkenterprisereceiver/README.md +++ b/receiver/splunkenterprisereceiver/README.md @@ -71,4 +71,4 @@ service: exporters: [debug] ``` -For a full list of settings exposed by this receiver please look [here](./config.go) with a detailed configuration [here](./testdata/config.yaml). +For a full list of settings exposed by this receiver please look in [config.go](./config.go) with a detailed configuration in [testdata/config.yaml](./testdata/config.yaml). diff --git a/receiver/splunkhecreceiver/README.md b/receiver/splunkhecreceiver/README.md index 1887c71ea022..906659cdf690 100644 --- a/receiver/splunkhecreceiver/README.md +++ b/receiver/splunkhecreceiver/README.md @@ -75,7 +75,7 @@ receivers: extension: ack/in_memory ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). [configtls]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls diff --git a/receiver/sqlserverreceiver/README.md b/receiver/sqlserverreceiver/README.md index 9764f7aec27e..86b051cb0291 100644 --- a/receiver/sqlserverreceiver/README.md +++ b/receiver/sqlserverreceiver/README.md @@ -66,7 +66,7 @@ Example with named instance: enabled: true ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ## Metrics diff --git a/receiver/sshcheckreceiver/README.md b/receiver/sshcheckreceiver/README.md index e5d9d43a55b4..abaa6308ca76 100644 --- a/receiver/sshcheckreceiver/README.md +++ b/receiver/sshcheckreceiver/README.md @@ -44,7 +44,7 @@ receivers: collection_interval: 60s ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ## Metrics diff --git a/receiver/statsdreceiver/README.md b/receiver/statsdreceiver/README.md index c302cde0eda1..eb84ef18e6a2 100644 --- a/receiver/statsdreceiver/README.md +++ b/receiver/statsdreceiver/README.md @@ -69,8 +69,8 @@ receivers: percentiles: [0, 10, 50, 90, 95, 100] ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). ## Aggregation diff --git a/receiver/vcenterreceiver/README.md b/receiver/vcenterreceiver/README.md index 4a00fd41e452..c23fae314858 100644 --- a/receiver/vcenterreceiver/README.md +++ b/receiver/vcenterreceiver/README.md @@ -48,7 +48,7 @@ receivers: metrics: [] ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). TLS config is documented further under the [opentelemetry collector's configtls package](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). TLS config is documented further under the [opentelemetry collector's configtls package](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). ## Metrics diff --git a/receiver/wavefrontreceiver/README.md b/receiver/wavefrontreceiver/README.md index aca05a79a943..61a1a709a9b6 100644 --- a/receiver/wavefrontreceiver/README.md +++ b/receiver/wavefrontreceiver/README.md @@ -60,6 +60,6 @@ receivers: extract_collectd_tags: true ``` -The full list of settings exposed for this receiver are documented [here](./config.go) -with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver are documented in [config.go](./config.go) +with detailed sample configurations in [testdata/config.yaml](./testdata/config.yaml). diff --git a/receiver/webhookeventreceiver/README.md b/receiver/webhookeventreceiver/README.md index 668d0a67eed0..370240025a1b 100644 --- a/receiver/webhookeventreceiver/README.md +++ b/receiver/webhookeventreceiver/README.md @@ -44,5 +44,5 @@ receivers: key: "required-header-key" value: "required-header-value" ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with a detailed sample configuration [here](./testdata/config.yaml) +The full list of settings exposed for this receiver are documented in [config.go](./config.go) with a detailed sample configuration in [testdata/config.yaml](./testdata/config.yaml)