Skip to content

Commit

Permalink
[chore] Spelling receiver (#37134)
Browse files Browse the repository at this point in the history
#### Description

Fix spelling in receiver/

#37128 (review)

#### Link to tracking issue

* #37128

---------

Signed-off-by: Josh Soref <[email protected]>
  • Loading branch information
jsoref authored Jan 31, 2025
1 parent 24dd011 commit d7125ca
Show file tree
Hide file tree
Showing 53 changed files with 91 additions and 95 deletions.
4 changes: 2 additions & 2 deletions receiver/activedirectorydsreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion receiver/apachereceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion receiver/apachereceiver/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| ---- | ----------- | ---------- | ----------------------- | --------- |
Expand Down
4 changes: 2 additions & 2 deletions receiver/apachereceiver/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion receiver/apachesparkreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion receiver/awsxrayreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions receiver/bigipreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions receiver/carbonreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 2 additions & 2 deletions receiver/cloudfoundryreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions receiver/collectdreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion receiver/couchdbreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions receiver/dockerstatsreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion receiver/elasticsearchreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions receiver/flinkmetricsreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
4 changes: 1 addition & 3 deletions receiver/githubreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions receiver/huaweicloudcesreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected]/services/ces/v1/region).
- `region_id`: The ID of the [Huawei Cloud region](https://pkg.go.dev/github.com/huaweicloud/[email protected]/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).

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion receiver/iisreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
16 changes: 7 additions & 9 deletions receiver/k8sclusterreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions receiver/k8seventsreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions receiver/k8sobjectsreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion receiver/kafkametricsreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand Down
4 changes: 2 additions & 2 deletions receiver/kubeletstatsreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion receiver/lokireceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

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.
Expand Down
4 changes: 2 additions & 2 deletions receiver/memcachedreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions receiver/mongodbreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion receiver/mysqlreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions receiver/nginxreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion receiver/nsxtreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading

0 comments on commit d7125ca

Please sign in to comment.