diff --git a/receiver/activedirectorydsreceiver/README.md b/receiver/activedirectorydsreceiver/README.md index 1730b5d5fa61..7cbc00f630f2 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. @@ -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/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 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/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 diff --git a/receiver/bigipreceiver/README.md b/receiver/bigipreceiver/README.md index b1c80a18042b..d2a6051a6f5c 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 @@ -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 7cb12525e3bc..941ce4a70d9c 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 1ba5e7f198de..9a1f1267238c 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 @@ -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/githubreceiver/README.md b/receiver/githubreceiver/README.md index d0d2cb908f89..d6cfd4f38833 100644 --- a/receiver/githubreceiver/README.md +++ b/receiver/githubreceiver/README.md @@ -87,9 +87,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 diff --git a/receiver/huaweicloudcesreceiver/README.md b/receiver/huaweicloudcesreceiver/README.md index a874006d42d0..dbe141f08fa7 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). @@ -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 53f9990eef01..1ebd6af45761 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 @@ -79,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 @@ -123,11 +121,11 @@ 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. -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 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/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): diff --git a/receiver/kubeletstatsreceiver/README.md b/receiver/kubeletstatsreceiver/README.md index 44b8dbce0866..9531dbd4cb49 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/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. 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 1ffaba9f6fbc..afcd09c14cd9 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 @@ -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 18f716e34ca9..50d702979bbb 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 63d81a5bd195..80469b7d4a83 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 c73cce90a65a..3bd3cb423a35 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 @@ -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 diff --git a/receiver/prometheusreceiver/DESIGN.md b/receiver/prometheusreceiver/DESIGN.md index 3a1fbc4d8c23..4c09c5c11ba6 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`, 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 4d6bc771f30c..74752d28df29 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 @@ -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 8cee77686306..980261765f9c 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/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 diff --git a/receiver/saphanareceiver/README.md b/receiver/saphanareceiver/README.md index 3ed373085d27..058ad2ad498b 100644 --- a/receiver/saphanareceiver/README.md +++ b/receiver/saphanareceiver/README.md @@ -92,12 +92,12 @@ 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 Details about the metrics produced by this receiver can be found in [metadata.yaml](./metadata.yaml). Further details of the monitoring queries used to collect them may be found in [queries.go](./queries.go). -> If all of the metrics collected by a given monitoring query are marked as `enabled: false` in the receiver configration, the monitoring query will not be executed. +> If all of the metrics collected by a given monitoring query are marked as `enabled: false` in the receiver configuration, the monitoring query will not be executed. diff --git a/receiver/saphanareceiver/client_test.go b/receiver/saphanareceiver/client_test.go index e8e3f2f4ea2e..6fb1988f018b 100644 --- a/receiver/saphanareceiver/client_test.go +++ b/receiver/saphanareceiver/client_test.go @@ -107,7 +107,7 @@ func TestBasicConnectAndClose(t *testing.T) { func TestFailedPing(t *testing.T) { dbWrapper := &testDBWrapper{} - dbWrapper.On("PingContext").Return(errors.New("Coult not ping host")) + dbWrapper.On("PingContext").Return(errors.New("Could not ping host")) dbWrapper.On("Close").Return(nil) factory := &testConnectionFactory{dbWrapper} diff --git a/receiver/sapmreceiver/README.md b/receiver/sapmreceiver/README.md index e2fec058f597..2cef11fb8a01 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 @@ -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/skywalkingreceiver/internal/trace/tracing_report_service.go b/receiver/skywalkingreceiver/internal/trace/tracing_report_service.go index 2018cd022bc5..afbbed8ca192 100644 --- a/receiver/skywalkingreceiver/internal/trace/tracing_report_service.go +++ b/receiver/skywalkingreceiver/internal/trace/tracing_report_service.go @@ -83,13 +83,13 @@ func (r *Receiver) CollectInSync(ctx context.Context, segments *agent.SegmentCol for _, segment := range segments.Segments { marshaledSegment, err := proto.Marshal(segment) if err != nil { - fmt.Printf("cannot marshal segemnt from sync, %v", err) + fmt.Printf("cannot marshal segment from sync, %v", err) } err = consumeTraces(ctx, segment, r.nextConsumer) if err != nil { fmt.Printf("cannot consume traces, %v", err) } - fmt.Printf("receivec data:%s", marshaledSegment) + fmt.Printf("received data:%s", marshaledSegment) } return &common.Commands{}, nil } diff --git a/receiver/skywalkingreceiver/skywalking_receiver.go b/receiver/skywalkingreceiver/skywalking_receiver.go index 2e9cd490ef95..8af7caec8b01 100644 --- a/receiver/skywalkingreceiver/skywalking_receiver.go +++ b/receiver/skywalkingreceiver/skywalking_receiver.go @@ -39,7 +39,7 @@ type configuration struct { CollectorGRPCServerSettings configgrpc.ServerConfig } -// Receiver type is used to receive spans that were originally intended to be sent to Skywaking. +// Receiver type is used to receive spans that were originally intended to be sent to Skywalking. // This receiver is basically a Skywalking collector. type swReceiver struct { config *configuration diff --git a/receiver/snmpreceiver/README.md b/receiver/snmpreceiver/README.md index 7083140b19fe..c56dd12789de 100644 --- a/receiver/snmpreceiver/README.md +++ b/receiver/snmpreceiver/README.md @@ -126,14 +126,14 @@ Attribute configurations are used to define what resource attributes will be use | -- | -- | -- | -- | | `oid` | The SNMP scalar OID value to grab data from (must end in .0). | string | | | `resource_attributes` | The names of the related resource attribute configurations, allowing scalar oid metrics to be added to resources that have one or more scalar oid resource attributes. Cannot have indexed resource attributes as values. | string[] | | -| `attributes` | The names of the related attribute enum configurations as well as the values to attach to this returned SNMP scalar data. This can be used to have a metric config with multiple ScalarOIDs as different datapoints with different attributue values within the same metric | Attribute | | +| `attributes` | The names of the related attribute enum configurations as well as the values to attach to this returned SNMP scalar data. This can be used to have a metric config with multiple ScalarOIDs as different datapoints with different attribute values within the same metric | Attribute | | #### ColumnOID Configuration | Field Name | Description | Value | Default | | -- | -- | -- | -- | | `oid` | The SNMP scalar OID value to grab data from (must end in .0). | string | | -| `attributes` | The names of the related attribute configurations as well as the enum values to attach to this returned SNMP indexed data if the attribute configuration has enum data. This can be used to attach a specific metric SNMP column OID to an attribute. In doing so, multiple datapoints for a single metric will be created for each returned SNMP indexed data value for the metric along with different attribute values to differentiate them. This also can be used to have a metric config with multiple ColumnOIDs as different datapoints with different attributue values within the same metric | Attribute[] | | +| `attributes` | The names of the related attribute configurations as well as the enum values to attach to this returned SNMP indexed data if the attribute configuration has enum data. This can be used to attach a specific metric SNMP column OID to an attribute. In doing so, multiple datapoints for a single metric will be created for each returned SNMP indexed data value for the metric along with different attribute values to differentiate them. This also can be used to have a metric config with multiple ColumnOIDs as different datapoints with different attribute values within the same metric | Attribute[] | | | `resource_attributes` | The names of the related resource attribute configurations. This is used to attach a specific metric SNMP column OID to a resource attribute. In doing so, multiple resources will be created for each returned SNMP indexed data value for the metric | string[] | | #### Attribute @@ -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/snmpreceiver/config.go b/receiver/snmpreceiver/config.go index 2f43460e7d1a..d7c9992672d1 100644 --- a/receiver/snmpreceiver/config.go +++ b/receiver/snmpreceiver/config.go @@ -164,7 +164,7 @@ type AttributeConfig struct { // This contains a list of possible values that can be associated with this attribute Enum []string `mapstructure:"enum"` // OID is required only if Enum and IndexedValuePrefix are not defined. - // This is the column OID which will provide indexed values to be uased for this attribute (alongside a metric with ColumnOIDs) + // This is the column OID which will provide indexed values to be used for this attribute (alongside a metric with ColumnOIDs) OID string `mapstructure:"oid"` // IndexedValuePrefix is required only if Enum and OID are not defined. // This is used alongside metrics with ColumnOIDs to assign attribute values using this prefix + the OID index of the metric value @@ -190,7 +190,7 @@ type MetricConfig struct { // GaugeMetric contains info about the value of the gauge metric type GaugeMetric struct { - // ValueType is required can can be either int or double + // ValueType is required and can be either int or double ValueType string `mapstructure:"value_type"` } @@ -200,7 +200,7 @@ type SumMetric struct { Aggregation string `mapstructure:"aggregation"` // Monotonic is required and can be true or false Monotonic bool `mapstructure:"monotonic"` - // ValueType is required can can be either int or double + // ValueType is required and can be either int or double ValueType string `mapstructure:"value_type"` } diff --git a/receiver/snowflakereceiver/README.md b/receiver/snowflakereceiver/README.md index 380e29f11239..caf353580708 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. 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. @@ -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/snowflakereceiver/client_test.go b/receiver/snowflakereceiver/client_test.go index 40534292a2f7..c7672760ff3c 100644 --- a/receiver/snowflakereceiver/client_test.go +++ b/receiver/snowflakereceiver/client_test.go @@ -218,7 +218,7 @@ func TestMetricQueries(t *testing.T) { { desc: "FetchSessionMetrics", query: sessionMetricsQuery, - columns: []string{"username", "disctinct_id"}, + columns: []string{"username", "distinct_id"}, params: []driver.Value{"t", 3.0}, expect: sessionMetric{ userName: sql.NullString{ diff --git a/receiver/snowflakereceiver/documentation.md b/receiver/snowflakereceiver/documentation.md index 9847fef0405a..23bf637616ef 100644 --- a/receiver/snowflakereceiver/documentation.md +++ b/receiver/snowflakereceiver/documentation.md @@ -306,7 +306,7 @@ Reported total credits used in the cloud service over the last 24 hour window. | Name | Description | Values | | ---- | ----------- | ------ | -| service_type | Service type associateed with metric query. | Any Str | +| service_type | Service type associated with metric query. | Any Str | ### snowflake.billing.total_credit.total @@ -320,7 +320,7 @@ Reported total credits used across account over the last 24 hour window. | Name | Description | Values | | ---- | ----------- | ------ | -| service_type | Service type associateed with metric query. | Any Str | +| service_type | Service type associated with metric query. | Any Str | ### snowflake.billing.virtual_warehouse.total @@ -334,7 +334,7 @@ Reported total credits used by virtual warehouse service over the last 24 hour w | Name | Description | Values | | ---- | ----------- | ------ | -| service_type | Service type associateed with metric query. | Any Str | +| service_type | Service type associated with metric query. | Any Str | ### snowflake.billing.warehouse.cloud_service.total diff --git a/receiver/snowflakereceiver/factory_test.go b/receiver/snowflakereceiver/factory_test.go index 10e04c5e5a44..586113487872 100644 --- a/receiver/snowflakereceiver/factory_test.go +++ b/receiver/snowflakereceiver/factory_test.go @@ -15,7 +15,7 @@ import ( "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/snowflakereceiver/internal/metadata" ) -func TestFacoryCreate(t *testing.T) { +func TestFactoryCreate(t *testing.T) { factory := NewFactory() require.EqualValues(t, metadata.Type, factory.Type()) } diff --git a/receiver/snowflakereceiver/metadata.yaml b/receiver/snowflakereceiver/metadata.yaml index 335110846567..023a47cd7c53 100644 --- a/receiver/snowflakereceiver/metadata.yaml +++ b/receiver/snowflakereceiver/metadata.yaml @@ -17,7 +17,7 @@ resource_attributes: attributes: service_type: - description: Service type associateed with metric query. + description: Service type associated with metric query. type: string error_message: description: Error message reported by query if present. diff --git a/receiver/snowflakereceiver/scraper_test.go b/receiver/snowflakereceiver/scraper_test.go index 0620f8d64eba..4bb297ac380c 100644 --- a/receiver/snowflakereceiver/scraper_test.go +++ b/receiver/snowflakereceiver/scraper_test.go @@ -27,12 +27,12 @@ func TestScraper(t *testing.T) { cfg.Warehouse = "warehouse" err := component.ValidateConfig(cfg) if err != nil { - t.Fatal("an error ocured when validating config", err) + t.Fatal("an error occurred when validating config", err) } db, mock, err := sqlmock.New(sqlmock.QueryMatcherOption(sqlmock.QueryMatcherEqual)) if err != nil { - t.Fatal("an error ocured when opening mock db", err) + t.Fatal("an error occurred when opening mock db", err) } defer db.Close() @@ -124,7 +124,7 @@ func (m *mockDB) initMockDB() { }, { query: sessionMetricsQuery, - columns: []string{"username", "disctinct_id"}, + columns: []string{"username", "distinct_id"}, params: []driver.Value{"t", 3.0}, }, { diff --git a/receiver/solacereceiver/factory.go b/receiver/solacereceiver/factory.go index f0d59e55802f..c877393ac498 100644 --- a/receiver/solacereceiver/factory.go +++ b/receiver/solacereceiver/factory.go @@ -17,8 +17,8 @@ import ( ) const ( - // default value for max unaked messages - defaultMaxUnaked int32 = 1000 + // default value for max unacked messages + defaultMaxUnacked int32 = 1000 // default value for host defaultHost string = "localhost:5671" ) @@ -36,7 +36,7 @@ func NewFactory() receiver.Factory { func createDefaultConfig() component.Config { return &Config{ Broker: []string{defaultHost}, - MaxUnacked: defaultMaxUnaked, + MaxUnacked: defaultMaxUnacked, Auth: Authentication{}, TLS: configtls.ClientConfig{ InsecureSkipVerify: false, diff --git a/receiver/solacereceiver/messaging_service.go b/receiver/solacereceiver/messaging_service.go index d1903e3e5031..7793319fb38f 100644 --- a/receiver/solacereceiver/messaging_service.go +++ b/receiver/solacereceiver/messaging_service.go @@ -72,7 +72,7 @@ func newAMQPMessagingServiceFactory(cfg *Config, logger *zap.Logger) (messagingS } type amqpConnectConfig struct { - // conenct config + // connect config addr string saslConfig amqp.SASLType tlsConfig *tls.Config diff --git a/receiver/solacereceiver/messaging_service_test.go b/receiver/solacereceiver/messaging_service_test.go index 6faa2d559897..fafc8c99631d 100644 --- a/receiver/solacereceiver/messaging_service_test.go +++ b/receiver/solacereceiver/messaging_service_test.go @@ -504,7 +504,7 @@ func TestAMQPSubstituteVariables(t *testing.T) { // testFunctionEquality will check that the pointer names are the same for the two functions. // It is not a perfect comparison but will perform well differentiating between anonymous -// functions and the amqp named functinos +// functions and the amqp named functions func testFunctionEquality(t *testing.T, f1, f2 any) { assert.Equal(t, (f1 == nil), (f2 == nil)) if f1 == nil { @@ -654,7 +654,7 @@ func (c *connMock) Read(b []byte) (n int, err error) { d := <-c.nextData // the way this test fixture is designed, there is a race condition // between write and read where data may be written to nextData on - // a call to Write and may be propogated prior to the return of Write. + // a call to Write and may be propagated prior to the return of Write. time.Sleep(10 * time.Millisecond) c.remaining = bytes.NewReader(d) } diff --git a/receiver/solacereceiver/receiver.go b/receiver/solacereceiver/receiver.go index 893c677bd69e..658b3d10c925 100644 --- a/receiver/solacereceiver/receiver.go +++ b/receiver/solacereceiver/receiver.go @@ -41,7 +41,7 @@ const ( ) const ( - brokerComponenteNameAttr = "receiver_name" + brokerComponentNameAttr = "receiver_name" ) // solaceTracesReceiver uses azure AMQP to consume and handle telemetry data from SOlace. Implements receiver.Traces @@ -88,7 +88,7 @@ func newTracesReceiver(config *Config, set receiver.Settings, nextConsumer consu receiverName = "solace" } solaceBrokerAttrs := attribute.NewSet( - attribute.String(brokerComponenteNameAttr, receiverName), + attribute.String(brokerComponentNameAttr, receiverName), ) unmarshaller := newTracesUnmarshaller(set.Logger, telemetryBuilder, solaceBrokerAttrs) diff --git a/receiver/solacereceiver/unmarshaller.go b/receiver/solacereceiver/unmarshaller.go index f99b35f6a795..60f839bb046e 100644 --- a/receiver/solacereceiver/unmarshaller.go +++ b/receiver/solacereceiver/unmarshaller.go @@ -25,7 +25,7 @@ type tracesUnmarshaller interface { unmarshal(message *inboundMessage) (ptrace.Traces, error) } -// newUnmarshalleer returns a new unmarshaller ready for message unmarshalling +// newTracesUnmarshaller returns a new unmarshaller ready for message unmarshalling func newTracesUnmarshaller(logger *zap.Logger, telemetryBuilder *metadata.TelemetryBuilder, metricAttrs attribute.Set) tracesUnmarshaller { return &solaceTracesUnmarshaller{ logger: logger, diff --git a/receiver/solacereceiver/unmarshaller_egress.go b/receiver/solacereceiver/unmarshaller_egress.go index c678e5f94e9a..c811682b27cb 100644 --- a/receiver/solacereceiver/unmarshaller_egress.go +++ b/receiver/solacereceiver/unmarshaller_egress.go @@ -24,7 +24,7 @@ import ( type brokerTraceEgressUnmarshallerV1 struct { logger *zap.Logger telemetryBuilder *metadata.TelemetryBuilder - metricAttrs attribute.Set // othere Otel attributes (to add to the metrics) + metricAttrs attribute.Set // other Otel attributes (to add to the metrics) } // unmarshal implements tracesUnmarshaller.unmarshal diff --git a/receiver/solacereceiver/unmarshaller_move.go b/receiver/solacereceiver/unmarshaller_move.go index 41dc73ebe40f..2efb5dfd801d 100644 --- a/receiver/solacereceiver/unmarshaller_move.go +++ b/receiver/solacereceiver/unmarshaller_move.go @@ -21,7 +21,7 @@ import ( type brokerTraceMoveUnmarshallerV1 struct { logger *zap.Logger telemetryBuilder *metadata.TelemetryBuilder - metricAttrs attribute.Set // othere Otel attributes (to add to the metrics) + metricAttrs attribute.Set // other Otel attributes (to add to the metrics) } // unmarshal implements tracesUnmarshaller.unmarshal diff --git a/receiver/solacereceiver/unmarshaller_receive.go b/receiver/solacereceiver/unmarshaller_receive.go index 27d806b6157c..9214471b7d0a 100644 --- a/receiver/solacereceiver/unmarshaller_receive.go +++ b/receiver/solacereceiver/unmarshaller_receive.go @@ -175,7 +175,7 @@ func (u *brokerTraceReceiveUnmarshallerV1) mapClientSpanAttributes(spanData *rec attrMap.PutInt(droppedEnqueueEventsSuccessAttrKey, int64(spanData.DroppedEnqueueEventsSuccess)) attrMap.PutInt(droppedEnqueueEventsFailedAttrKey, int64(spanData.DroppedEnqueueEventsFailed)) - // The IPs are now optional meaning we will not incluude them if they are zero length + // The IPs are now optional meaning we will not include them if they are zero length hostIPLen := len(spanData.HostIp) if hostIPLen == 4 || hostIPLen == 16 { attrMap.PutStr(hostIPAttrKey, net.IP(spanData.HostIp).String()) @@ -372,7 +372,7 @@ func (u *brokerTraceReceiveUnmarshallerV1) unmarshalBaggage(toMap pcommon.Map, b return nil } -// insertUserProperty will instert a user property value with the given key to an attribute if possible. +// insertUserProperty will insert a user property value with the given key to an attribute if possible. // Since AttributeMap only supports int64 integer types, uint64 data may be misrepresented. func (u *brokerTraceReceiveUnmarshallerV1) insertUserProperty(toMap pcommon.Map, key string, value any) { const ( diff --git a/receiver/solacereceiver/unmarshaller_test.go b/receiver/solacereceiver/unmarshaller_test.go index de2153d1099a..9b3a17c4cd67 100644 --- a/receiver/solacereceiver/unmarshaller_test.go +++ b/receiver/solacereceiver/unmarshaller_test.go @@ -37,7 +37,7 @@ func TestSolaceMessageUnmarshallerUnmarshal(t *testing.T) { err error }{ { - name: "Unknown Topic Stirng", + name: "Unknown Topic String", message: &inboundMessage{ Properties: &amqp.MessageProperties{ To: &invalidTopicString, 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/sqlserverreceiver/testdata/scrape-available-counters.ps1 b/receiver/sqlserverreceiver/testdata/scrape-available-counters.ps1 index 9872c1ec2ad7..175bae66dfd1 100644 --- a/receiver/sqlserverreceiver/testdata/scrape-available-counters.ps1 +++ b/receiver/sqlserverreceiver/testdata/scrape-available-counters.ps1 @@ -1,3 +1,3 @@ # This powershell script finds all SQLServer counter paths and dumps them to counters.txt. -# This should be run on a system with the a running SQLServer. +# This should be run on a system with a running SQLServer. (Get-Counter -ListSet "SQLServer:*").Paths | Set-Content -Path "$PSScriptRoot\counters.txt" diff --git a/receiver/sqlserverreceiver/testdata/scrape-named-instance-counters.ps1 b/receiver/sqlserverreceiver/testdata/scrape-named-instance-counters.ps1 index 12ca2a78b79c..7416b826c2d2 100644 --- a/receiver/sqlserverreceiver/testdata/scrape-named-instance-counters.ps1 +++ b/receiver/sqlserverreceiver/testdata/scrape-named-instance-counters.ps1 @@ -1,4 +1,4 @@ # This powershell script finds all SQLServer counter paths and dumps them to counters.txt for a named instance. -# This should be run on a system with the a running SQLServer and named instance. +# This should be run on a system with a running SQLServer and named instance. # This example uses a named instance of TEST_NAME. (Get-Counter -ListSet "MSSQL$*").Paths| Set-Content -Path "$PSScriptRoot\counters.txt" 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/sshcheckreceiver/scraper.go b/receiver/sshcheckreceiver/scraper.go index 9e15f70d7272..3de9b8f70fd4 100644 --- a/receiver/sshcheckreceiver/scraper.go +++ b/receiver/sshcheckreceiver/scraper.go @@ -63,7 +63,7 @@ func (s *sshcheckScraper) scrapeSFTP(now pcommon.Timestamp) error { return err } -// timeout chooses the shorter between between a given deadline and timeout +// timeout chooses the shorter duration between a given deadline and timeout func timeout(deadline time.Time, timeout time.Duration) time.Duration { timeToDeadline := time.Until(deadline) if timeToDeadline < timeout { 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/syslogreceiver/README.md b/receiver/syslogreceiver/README.md index 9cb834deb661..98285aad26a0 100644 --- a/receiver/syslogreceiver/README.md +++ b/receiver/syslogreceiver/README.md @@ -22,7 +22,7 @@ Parses Syslogs received over TCP or UDP. | `udp` | `nil` | Defined udp_input operator. (see the UDP configuration section) | | `protocol` | required | The protocol to parse the syslog messages as. Options are `rfc3164` and `rfc5424` | | `location` | `UTC` | The geographic location (timezone) to use when parsing the timestamp (Syslog RFC 3164 only). The available locations depend on the local IANA Time Zone database. [This page](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) contains many examples, such as `America/New_York`. | -| `enable_octet_counting` | `false` | Wether or not to enable [RFC 6587](https://www.rfc-editor.org/rfc/rfc6587#section-3.4.1) Octet Counting on syslog parsing (Syslog RFC 5424 and TCP only). | +| `enable_octet_counting` | `false` | Whether or not to enable [RFC 6587](https://www.rfc-editor.org/rfc/rfc6587#section-3.4.1) Octet Counting on syslog parsing (Syslog RFC 5424 and TCP only). | | `max_octets` | `8192` | The maximum octets for messages using [RFC 6587](https://www.rfc-editor.org/rfc/rfc6587#section-3.4.1) Octet Counting on syslog parsing (Syslog RFC 5424 and TCP only). | | `allow_skip_pri_header` | `false` | Allow parsing records without the PRI header. If this setting is enabled, messages without the PRI header will be successfully parsed. The `SeverityNumber` and `SeverityText` fields as well as the `priority` and `facility` attributes will not be set on the log record. If this setting is disabled (the default), messages without PRI header will throw an exception. To set this setting to `true`, the `enable_octet_counting` setting must be `false`. | | `non_transparent_framing_trailer` | `nil` | The framing trailer, either `LF` or `NUL`, when using [RFC 6587](https://www.rfc-editor.org/rfc/rfc6587#section-3.4.2) Non-Transparent-Framing (Syslog RFC 5424 and TCP only). | 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) 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