Skip to content

Commit

Permalink
Collector config copyedits (#4469)
Browse files Browse the repository at this point in the history
Co-authored-by: Severin Neumann <[email protected]>
  • Loading branch information
chalin and svrnm authored May 13, 2024
1 parent c675510 commit 4223f45
Showing 1 changed file with 18 additions and 20 deletions.
38 changes: 18 additions & 20 deletions content/en/docs/collector/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -609,10 +609,9 @@ Collector issues. It consists of two subsections: `logs` and `metrics`.
The `logs` subsection lets you configure how the logs can be generated by the
Collector. By default, the Collector writes its logs to `stderr` with a log
level of `INFO`. You can also add static key-value pairs to all log entries with
the `initial_fields` to enrich the logging context. As per the `LogsConfig`
defined in v{{%
param vers %}} [here](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
param vers %}}/service/telemetry/config.go), the `logs` configuration options are:
the `initial_fields` to enrich the logging context. The [`logs` configuration
options](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
param vers %}}/service/telemetry/config.go) are:

- `level`: sets the minimum enabled logging level, default `INFO`.
- `development`: puts the logger in development mode, default `false`.
Expand All @@ -635,17 +634,16 @@ The `metrics` subsection lets you configure how the metrics can be generated and
exposed by the Collector. By default, the Collector generates basic metrics
about itself and expose them for scraping at <http://127.0.0.1:8888/metrics>.
You can expose the endpoint to a specific or even all network interfaces when
needed. As per the `MetricsConfig` defined in v{{%
param vers %}} [here](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
param vers %}}/service/telemetry/config.go), the `metrics` configuration options
are:
needed. The [`metrics` configuration
options](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
param vers %}}/service/telemetry/config.go) are:

- `level`: the level of telemetry metrics, default `basic`. The possible values
are:
- "none" indicates that no telemetry data should be collected.
- "basic" is the recommended and covers the basics of the service telemetry.
- "normal" adds some other indicators on top of basic.
- "detailed" adds dimensions and views to the previous levels.
- `none`: no telemetry is collected.
- `basic`: essential service telemetry.
- `normal`: the default level, adds standard indicators on top of basic.
- `detailed`: the most verbose level, includes dimensions and views.
- `address`: the `[address]:port` formatted URL that metrics exposition should
be bound to. Default `127.0.0.1:8888`.

Expand Down Expand Up @@ -858,7 +856,7 @@ Install [`cfssl`](https://github.com/cloudflare/cfssl) and create the following

Then run the following commands:

```bash
```sh
cfssl genkey -initca csr.json | cfssljson -bare ca
cfssl gencert -ca ca.pem -ca-key ca-key.pem csr.json | cfssljson -bare cert
```
Expand All @@ -880,14 +878,14 @@ define with this method are merged into the final configuration after all

The following examples show how to override settings inside nested sections:

```shell
# The following example sets the verbosity
# level of the debug exporter to 'detailed'
```sh
otelcol --set "exporters::debug::verbosity=detailed"
# The following example overrides gRPC
# settings for the OTLP receiver
otelcol --set "receivers::otlp::protocols::grpc={endpoint:localhost:4317, compression: gzip}"
```

Note tha the `--set` option doesn't support setting a key that contains a dot or
an equal sign.
{{% alert title="Important" color="warning" %}}

The `--set` option doesn't support setting a key that contains a dot or an equal
sign.

{{% /alert %}}

0 comments on commit 4223f45

Please sign in to comment.