Skip to content

Commit 744d6ab

Browse files
tiffany76tiffany76
authored
Remove duplicate content from Collector config page (#4504)
1 parent dc9b52c commit 744d6ab

File tree

2 files changed

+26
-100
lines changed

2 files changed

+26
-100
lines changed

‎content/en/docs/collector/configuration.md

+4-89
Original file line numberDiff line numberDiff line change
@@ -602,95 +602,10 @@ service:
602602

603603
### Telemetry
604604

605-
The `telemetry` is where the telemetry for the Collector itself can be
606-
configured. Collector's own telemetry can be useful when troubleshooting
607-
Collector issues. It consists of two subsections: `logs` and `metrics`.
608-
609-
The `logs` subsection lets you configure how the logs can be generated by the
610-
Collector. By default, the Collector writes its logs to `stderr` with a log
611-
level of `INFO`. You can also add static key-value pairs to all log entries with
612-
the `initial_fields` to enrich the logging context. The [`logs` configuration
613-
options](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
614-
param vers %}}/service/telemetry/config.go) are:
615-
616-
- `level`: sets the minimum enabled logging level, default `INFO`.
617-
- `development`: puts the logger in development mode, default `false`.
618-
- `encoding`: sets the logger's encoding, default `console`. Example values are
619-
`json`, `console`.
620-
- `disable_caller`: stops annotating logs with the calling function's file name
621-
and line number. By default `false`, all logs are annotated.
622-
- `disable_stacktrace`: disables automatic stacktrace capturing, default
623-
`false`. By default, stacktraces are captured for `WARN` level and above logs
624-
in development and `ERROR` level and above in production.
625-
- `sampling`: sets a sampling policy.
626-
- `output_paths`: a list of URLs or file paths to write logging output to,
627-
default `["stderr"]`.
628-
- `error_output_paths`: a list of URLs or file paths to write logger errors to,
629-
default `["stderr"]`.
630-
- `initial_fields`: a collection of fields to add to the root logger. By
631-
default, there is no initial field.
632-
633-
The `metrics` subsection lets you configure how the metrics can be generated and
634-
exposed by the Collector. By default, the Collector generates basic metrics
635-
about itself and expose them for scraping at <http://127.0.0.1:8888/metrics>.
636-
You can expose the endpoint to a specific or even all network interfaces when
637-
needed. The [`metrics` configuration
638-
options](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
639-
param vers %}}/service/telemetry/config.go) are:
640-
641-
- `level`: the level of telemetry metrics, default `basic`. The possible values
642-
are:
643-
- `none`: no telemetry is collected.
644-
- `basic`: essential service telemetry.
645-
- `normal`: the default level, adds standard indicators on top of basic.
646-
- `detailed`: the most verbose level, includes dimensions and views.
647-
- `address`: the `[address]:port` formatted URL that metrics exposition should
648-
be bound to. Default `127.0.0.1:8888`.
649-
650-
The following example shows the Collector telemetry configuration:
651-
652-
```yaml
653-
service:
654-
telemetry:
655-
logs:
656-
level: DEBUG
657-
initial_fields:
658-
service: my-instance
659-
metrics:
660-
level: detailed
661-
address: 0.0.0.0:8888
662-
```
663-
664-
Note that it's possible to scrape the metrics by using a
665-
[Prometheus receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/prometheusreceiver)
666-
within the Collector configuration so that we can consume the Collector's
667-
metrics at the backend. For example:
668-
669-
```yaml
670-
receivers:
671-
prometheus:
672-
trim_metric_suffixes: true
673-
use_start_time_metric: true
674-
start_time_metric_regex: .*
675-
config:
676-
scrape_configs:
677-
- job_name: 'otel-collector'
678-
scrape_interval: 5s
679-
static_configs:
680-
- targets: ['127.0.0.1:8888']
681-
682-
exporters:
683-
otlp:
684-
endpoint: my.company.com:4317
685-
tls:
686-
insecure: true
687-
688-
service:
689-
pipelines:
690-
metrics:
691-
receivers: [prometheus]
692-
exporters: [otlp]
693-
```
605+
The `telemetry` config section is where you can set up observability for the
606+
Collector itself. It consists of two subsections: `logs` and `metrics`. To learn
607+
how to configure these signals, see
608+
[Activate internal telemetry in the Collector](/docs/collector/internal-telemetry#activate-internal-telemetry-in-the-collector).
694609

695610
## Other Information
696611

‎content/en/docs/collector/internal-telemetry.md

+22-11
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,9 @@ service:
5858
level: detailed
5959
```
6060

61-
The Collector can also be configured to scrape its own metrics and send them
62-
through configured pipelines. For example:
61+
The Collector can also be configured to scrape its own metrics using a
62+
[Prometheus receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/prometheusreceiver)
63+
and send them through configured pipelines. For example:
6364

6465
```yaml
6566
receivers:
@@ -95,15 +96,25 @@ critical analysis.
9596

9697
### Configure internal logs
9798

98-
You can find log output in `stderr`. The verbosity level for logs defaults to
99-
`INFO`, but you can adjust it in the config `service::telemetry::logs`:
100-
101-
```yaml
102-
service:
103-
telemetry:
104-
logs:
105-
level: 'debug'
106-
```
99+
Log output is found in `stderr`. You can configure logs in the config
100+
`service::telemetry::logs`. The [configuration
101+
options](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
102+
param vers %}}/service/telemetry/config.go) are:
103+
104+
| Field name | Default value | Description |
105+
| ---------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
106+
| `level` | `INFO` | Sets the minimum enabled logging level. Other possible values are `DEBUG`, `WARN`, and `ERROR`. |
107+
| `development` | `false` | Puts the logger in development mode. |
108+
| `encoding` | `console` | Sets the logger's encoding. The other possible value is `json`. |
109+
| `disable_caller` | `false` | Stops annotating logs with the calling function's file name and line number. By default, all logs are annotated. |
110+
| `disable_stacktrace` | `false` | Disables automatic stacktrace capturing. Stacktraces are captured for logs at `WARN` level and above in development and at `ERROR` level and above in production. |
111+
| `sampling::enabled` | `true` | Sets a sampling policy. |
112+
| `sampling::tick` | `10s` | The interval in seconds that the logger applies to each sampling. |
113+
| `sampling::initial` | `10` | The number of messages logged at the start of each `sampling::tick`. |
114+
| `sampling::thereafter` | `100` | Sets the sampling policy for subsequent messages after `sampling::initial` messages are logged. When `sampling::thereafter` is set to `N`, every `Nth` message is logged and all others are dropped. If `N` is zero, the logger drops all messages after `sampling::initial` messages are logged. |
115+
| `output_paths` | `["stderr"]` | A list of URLs or file paths to write logging output to. |
116+
| `error_output_paths` | `["stderr"]` | A list of URLs or file paths to write logger errors to. |
117+
| `initial_fields` | | A collection of static key-value pairs added to all log entries to enrich logging context. By default, there is no initial field. |
107118

108119
You can also see logs for the Collector on a Linux systemd system using
109120
`journalctl`:

0 commit comments

Comments
 (0)