Skip to content

[OTel Docker] Fix Data View IDs and update Documentation #14426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+120 −117
Open

[OTel Docker] Fix Data View IDs and update Documentation #14426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/docker_otel/changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# newer versions go on top
- version: "0.1.1"
changes:
- description: Update documentation and fix Data View ID
type: bugfix
link: https://github.com/elastic/integrations/pull/14426

- version: "0.1.0"
changes:
- description: Initial availability of the package
Expand Down
19 changes: 8 additions & 11 deletions packages/docker_otel/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
# Docker OpenTelemetry Assets

The Docker OpenTelemetry Assets integration collects metrics from Docker containers using OpenTelemetry Collector. This integration enables monitoring of Docker containers using the OpenTelemetry protocol for metrics collection, providing insights into container performance and resource utilization.

Use the Docker OpenTelemetry Assets integration to monitor container metrics such as CPU usage, memory consumption, disk I/O, and network traffic through the OpenTelemetry Collector.
The Docker OpenTelemetry Assets content package provides out-of-the-box dashboards for visualizing container performance and resource utilization metrics such as CPU usage, memory consumption, disk I/O, and network traffic from Docker hosts running OpenTelemetry Collector with the Docker Stats Receiver.

For example, if you wanted to monitor container CPU spikes, you could track CPU usage metrics across all containers. Then you can visualize these metrics in dashboards or create alerts when CPU usage exceeds defined thresholds.

## Data streams

The Docker OpenTelemetry Assets integration collects metrics data streams using the OpenTelemetry protocol.
## Setup

**Metrics** give you insight into the state of Docker containers through OpenTelemetry collection.
Metric data streams collected by the Docker OpenTelemetry Assets integration include `cpu`, `memory`, `disk_io`, and `network` metrics. See more details in the [Metrics](#metrics-reference).
The minimal required configuration for the Docker Stats Receiver is:

## Setup
```yaml
receivers:
docker_stats:
```

For step-by-step instructions on how to set up an integration, see the
[Getting started](https://www.elastic.co/guide/en/welcome-to-elastic/current/getting-started-observability.html) guide.
Additional configuration options are available in the [OpenTelemetry Docker Stats Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/dockerstatsreceiver/README.md) documentation. The configuration options available will depend on the version of the OpenTelemetry Collector you are using.
Loading