Skip to content

Commit

Permalink
Fix minor issues with the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ptodev committed Jul 31, 2024
1 parent 3ed44dc commit 92bc0aa
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 17 deletions.
26 changes: 10 additions & 16 deletions docs/sources/reference/components/otelcol/otelcol.exporter.debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@ Attributes:
```

{{< admonition type="note" >}}
All instances of `\n` in the `"detailed"` example have been replaced with new lines.
All instances of `\n` in the `"detailed"` example have been replaced with new lines.
{{< /admonition >}}

Setting `use_internal_logger` to `false` is useful if you would like to see actual new lines instead of `\n` in the collector logs.
However, by not using the internal logger you wouldn't see metadata in the log such as `component_id=otelcol.exporter.debug.default`.
However, by not using the internal logger you wouldn't see metadata in the log line such as `component_id=otelcol.exporter.debug.default`.
Multiline logs may also be harder to parse.

## Blocks
Expand Down Expand Up @@ -133,27 +133,21 @@ information.

## Example

This example scrapes Prometheus UNIX metrics and writes them to the console:
This example receives OTLP metrics, logs, and traces and writes them to the console:

```river
prometheus.exporter.unix "default" { }
prometheus.scrape "default" {
targets = prometheus.exporter.unix.default.targets
forward_to = [otelcol.receiver.prometheus.default.receiver]
}
```alloy
otelcol.receiver.otlp "default" {
grpc {}
http {}
otelcol.receiver.prometheus "default" {
output {
metrics = [otelcol.exporter.debug.default.input]
logs = [otelcol.exporter.debug.default.input]
traces = [otelcol.exporter.debug.default.input]
}
}
otelcol.exporter.debug "default" {
verbosity = "detailed"
sampling_initial = 1
sampling_thereafter = 1
}
otelcol.exporter.debug "default" {}
```
<!-- START GENERATED COMPATIBLE COMPONENTS -->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ information.

## Example

This example scrapes prometheus unix metrics and writes them to the console:
This example receives OTLP metrics, logs, and traces and writes them to the console:

```alloy
otelcol.receiver.otlp "default" {
Expand Down

0 comments on commit 92bc0aa

Please sign in to comment.