Skip to content

Commit

Permalink
documentation edits
Browse files Browse the repository at this point in the history
  • Loading branch information
BarunKGP committed Feb 28, 2024
1 parent a6037b9 commit 04d63d3
Showing 1 changed file with 11 additions and 14 deletions.
25 changes: 11 additions & 14 deletions docs/sources/flow/reference/components/otelcol.exporter.debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ title: otelcol.exporter.debug

# otelcol.exporter.debug

`otelcol.exporter.debug` accepts telemetry data from other `otelcol` components
and writes them to the console (stderr). The verbosity of the logs can also be controlled.
`otelcol.exporter.debug` accepts telemetry data from other `otelcol` components and writes them to the console (stderr).
You can control the verbosity of the logs.

> **NOTE**: `otelcol.exporter.debug` is a wrapper over the upstream
> OpenTelemetry Collector `debug` exporter. Bug reports or feature requests will
> be redirected to the upstream repository, if necessary.
{{< admonition type="note" >}}
`otelcol.exporter.debug` is a wrapper over the upstream OpenTelemetry Collector `debug` exporter.
If necessary, bug reports or feature requests are redirected to the upstream repository.
{{< /admonition >}}

Multiple `otelcol.exporter.debug` components can be specified by giving them
different labels.
You can specify multiple `otelcol.exporter.debug` components by giving them different labels.

## Usage

Expand Down Expand Up @@ -49,22 +49,19 @@ Name | Type | Description
---- | ---- | -----------
`input` | `otelcol.Consumer` | A value that other components can use to send telemetry data to.

`input` accepts `otelcol.Consumer` data for any telemetry signal (metrics,
logs, or traces).
`input` accepts `otelcol.Consumer` data for any telemetry signal (metrics, logs, or traces).

## Component health

`otelcol.exporter.debug` is only reported as unhealthy if given an invalid
configuration.
`otelcol.exporter.debug` is only reported as unhealthy if given an invalid configuration.

## Debug information

`otelcol.exporter.debug` does not expose any component-specific debug
information.
`otelcol.exporter.debug` does not expose any component-specific debug information.

## Example

This example scrapes prometheus unix metrics and writes them to the console:
This example scrapes Prometheus UNIX metrics and writes them to the console:

```river
prometheus.exporter.unix "default" { }
Expand Down

0 comments on commit 04d63d3

Please sign in to comment.