diff --git a/content/en/docs/collector/configuration.md b/content/en/docs/collector/configuration.md index b4feba6a7a0b..4cf07ed66e9e 100644 --- a/content/en/docs/collector/configuration.md +++ b/content/en/docs/collector/configuration.md @@ -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`. @@ -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 . 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`. @@ -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 ``` @@ -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 %}}