diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 657b9d691a9..117f16d0bad 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -205,6 +205,7 @@ /packages/dga @elastic/sec-applied-ml /packages/digital_guardian @elastic/security-service-integrations /packages/docker @elastic/obs-ds-hosted-services +/packages/docker_input_otel @elastic/ecosystem /packages/docker_otel @elastic/obs-ds-hosted-services /packages/elastic_agent @elastic/elastic-agent /packages/elastic_connectors @elastic/search-extract-and-transform diff --git a/packages/docker_input_otel/LICENSE.txt b/packages/docker_input_otel/LICENSE.txt new file mode 100644 index 00000000000..d317b57b294 --- /dev/null +++ b/packages/docker_input_otel/LICENSE.txt @@ -0,0 +1,93 @@ +Elastic License 2.0 + +URL: https://www.elastic.co/licensing/elastic-license + +## Acceptance + +By using the software, you agree to all of the terms and conditions below. + +## Copyright License + +The licensor grants you a non-exclusive, royalty-free, worldwide, +non-sublicensable, non-transferable license to use, copy, distribute, make +available, and prepare derivative works of the software, in each case subject to +the limitations and conditions below. + +## Limitations + +You may not provide the software to third parties as a hosted or managed +service, where the service provides users with access to any substantial set of +the features or functionality of the software. + +You may not move, change, disable, or circumvent the license key functionality +in the software, and you may not remove or obscure any functionality in the +software that is protected by the license key. + +You may not alter, remove, or obscure any licensing, copyright, or other notices +of the licensor in the software. Any use of the licensor's trademarks is subject +to applicable law. + +## Patents + +The licensor grants you a license, under any patent claims the licensor can +license, or becomes able to license, to make, have made, use, sell, offer for +sale, import and have imported the software, in each case subject to the +limitations and conditions in this license. This license does not cover any +patent claims that you cause to be infringed by modifications or additions to +the software. If you or your company make any written claim that the software +infringes or contributes to infringement of any patent, your patent license for +the software granted under these terms ends immediately. If your company makes +such a claim, your patent license ends immediately for work on behalf of your +company. + +## Notices + +You must ensure that anyone who gets a copy of any part of the software from you +also gets a copy of these terms. + +If you modify the software, you must include in any modified copies of the +software prominent notices stating that you have modified the software. + +## No Other Rights + +These terms do not imply any licenses other than those expressly granted in +these terms. + +## Termination + +If you use the software in violation of these terms, such use is not licensed, +and your licenses will automatically terminate. If the licensor provides you +with a notice of your violation, and you cease all violation of this license no +later than 30 days after you receive that notice, your licenses will be +reinstated retroactively. However, if you violate these terms after such +reinstatement, any additional violation of these terms will cause your licenses +to terminate automatically and permanently. + +## No Liability + +*As far as the law allows, the software comes as is, without any warranty or +condition, and the licensor will not be liable to you for any damages arising +out of these terms or the use or nature of the software, under any kind of +legal claim.* + +## Definitions + +The **licensor** is the entity offering these terms, and the **software** is the +software the licensor makes available under these terms, including any portion +of it. + +**you** refers to the individual or entity agreeing to these terms. + +**your company** is any legal entity, sole proprietorship, or other kind of +organization that you work for, plus all organizations that have control over, +are under the control of, or are under common control with that +organization. **control** means ownership of substantially all the assets of an +entity, or the power to direct its management and policies by vote, contract, or +otherwise. Control can be direct or indirect. + +**your licenses** are all the licenses granted to you for the software under +these terms. + +**use** means anything you do with the software requiring one of your licenses. + +**trademark** means trademarks, service marks, and similar rights. diff --git a/packages/docker_input_otel/_dev/build/docs/README.md b/packages/docker_input_otel/_dev/build/docs/README.md new file mode 100644 index 00000000000..8b26b82d452 --- /dev/null +++ b/packages/docker_input_otel/_dev/build/docs/README.md @@ -0,0 +1,83 @@ +# Docker OpenTelemetry Input Package + +## Overview + +The Docker OpenTelemetry Input Package for Elastic enables collection of telemetry data from Docker containers through OpenTelemetry protocols using the [dockerstats receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/dockerstatsreceiver). It provides comprehensive metrics about container resource usage including CPU, memory, network, and block I/O statistics. + +### How it works + +This package receives telemetry data from the Docker daemon by configuring the Docker endpoint in the Input Package, which then gets applied to the `docker_stats` receiver present in the EDOT collector, which then forwards the data to Elastic Agent. The Elastic Agent processes and enriches the data before sending it to Elasticsearch for indexing and analysis. Once the data arrives into Elasticsearch, its corresponding [Docker OpenTelemetry Assets Package](https://www.elastic.co/docs/reference/integrations/docker_otel) gets auto installed and the dashboards light up. + +## Requirements + +- Access to the Docker daemon socket (default: `unix:///var/run/docker.sock` on Linux and `npipe:////./pipe/docker_engine` on Windows) +- Docker API version greater than or equal to the one defined in [Docker Stats Receiver Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/dockerstatsreceiver). Also, the API version must be supported by the Docker Engine being monitored. + +## Compatibility + +This integration uses the OpenTelemetry dockerstats receiver which is currently in **alpha** stability. The configuration and metrics may change between versions. + +## Setup + +For step-by-step instructions on how to set up an integration, see the {{ url "getting-started-observability" "Getting started" }} guide. + +## Configuration + +The following configuration options are available: + +### Docker Endpoint +The endpoint of the Docker daemon. If not specified, the receiver uses `unix:///var/run/docker.sock` on Linux. +For remote Docker hosts, you can use TCP endpoints like `tcp://docker-host:2375`. + +### Excluded Images +A list of container image names to exclude from metrics collection. Supports wildcards. +Example: +```yaml +- "nginx:*" +- "redis:latest" +``` + +### API Version +The Docker API version to use. Default is `"1.44"`. +For Docker Engine v29, API version `"1.44"` or higher must be used. + +### Initial Delay +Defines how long this receiver waits before starting. Default is `1s`. + +### Container Labels to Metric Labels +Map container labels to metric resource attributes. This allows you to add custom dimensions to your metrics based on container labels. +Example: +```yaml +my.container.label: my_metric_label +app.version: version +``` + +### Environment Variables to Metric Labels +Map container environment variables to metric resource attributes. +Example: +```yaml +MY_ENV_VAR: my_metric_label +APP_VERSION: version +``` + + +### Metrics + +For a complete list of all available metrics, including their types, descriptions, and default enabled status, refer to the [Docker Stats Receiver documentation](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/dockerstatsreceiver/documentation.md) in the upstream OpenTelemetry Collector repository. + +The `metrics` configuration allows you to enable optional metrics or disable default metrics. + +For example, to enable per-CPU usage metrics (which are disabled by default): + +```yaml +metrics: + container.cpu.usage.percpu: + enabled: true +``` + + +## Additional Resources + +- [OpenTelemetry dockerstats receiver documentation](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/dockerstatsreceiver) +- [Docker Stats API documentation](https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerStats) +- [Elastic Observability documentation](https://www.elastic.co/guide/en/observability/current/index.html) diff --git a/packages/docker_input_otel/_dev/deploy/docker/docker-compose.yml b/packages/docker_input_otel/_dev/deploy/docker/docker-compose.yml new file mode 100644 index 00000000000..261a78b6894 --- /dev/null +++ b/packages/docker_input_otel/_dev/deploy/docker/docker-compose.yml @@ -0,0 +1,45 @@ +services: + dockerd: + image: docker:24-dind + privileged: true + command: ["--tls=false", "--host=tcp://0.0.0.0:2375", "--host=unix:///var/run/docker.sock"] + environment: + DOCKER_TLS_CERTDIR: "" + ports: + - 2375 + healthcheck: + test: ["CMD", "docker", "info"] + interval: 5s + timeout: 5s + retries: 20 + + workload: + image: docker:24-cli + environment: + - DOCKER_HOST=tcp://dockerd:2375 + depends_on: + dockerd: + condition: service_healthy + entrypoint: ["/bin/sh", "-c"] + command: + - | + # Redirect all output (including stderr) to a log file + exec > /var/log/workload.log 2>&1 + echo "Check binaries..." + which docker && which sh + echo "Waiting for Docker daemon at $DOCKER_HOST..." + # Simply wait for the daemon + while ! docker info >/dev/null 2>&1; do + echo "Waiting for Docker daemon connection..." + sleep 5 + done + echo "Docker daemon found!" + docker info + # Start a container that generates some stats (simulating load) + echo "Starting stressful container..." + # Identify if container already exists to avoid conflict on restart + docker rm -f stressful || true + docker run -d --name stressful alpine sh -c "while true; do :; done" + echo "Stressful container running." + # Keep this container alive + tail -f /var/log/workload.log diff --git a/packages/docker_input_otel/_dev/test/policy/test-default.expected b/packages/docker_input_otel/_dev/test/policy/test-default.expected new file mode 100644 index 00000000000..fb80a04871f --- /dev/null +++ b/packages/docker_input_otel/_dev/test/policy/test-default.expected @@ -0,0 +1,53 @@ +connectors: + forward: {} +exporters: + elasticsearch/componentid-0: {} +inputs: [] +output_permissions: + default: + _elastic_agent_checks: + cluster: + - monitor + _elastic_agent_monitoring: + indices: [] + uuid-for-permissions-on-related-indices: + indices: + - names: + - metrics-*-* + privileges: + - auto_configure + - create_doc +processors: + resourcedetection/componentid-0: + detectors: + - system + override: false + timeout: 2s + transform/componentid-1: + metric_statements: + - context: datapoint + statements: + - set(attributes["data_stream.type"], "metrics") + - set(attributes["data_stream.dataset"], "docker_input_otel.dockerstatsreceiver") + - set(attributes["data_stream.namespace"], "ep") +receivers: + docker_stats/componentid-0: + api_version: "1.44" + collection_interval: 60s + initial_delay: "1s" +secret_references: [] +service: + pipelines: + metrics: + exporters: + - elasticsearch/componentid-0 + receivers: + - forward + metrics/componentid-0: + exporters: + - forward + processors: + - resourcedetection/componentid-0 + - transform/componentid-1 + receivers: + - docker_stats/componentid-0 diff --git a/packages/docker_input_otel/_dev/test/policy/test-default.yml b/packages/docker_input_otel/_dev/test/policy/test-default.yml new file mode 100644 index 00000000000..4f55812fdb4 --- /dev/null +++ b/packages/docker_input_otel/_dev/test/policy/test-default.yml @@ -0,0 +1 @@ +vars: {} diff --git a/packages/docker_input_otel/_dev/test/policy/test-docker-stats.expected b/packages/docker_input_otel/_dev/test/policy/test-docker-stats.expected new file mode 100644 index 00000000000..4f083220923 --- /dev/null +++ b/packages/docker_input_otel/_dev/test/policy/test-docker-stats.expected @@ -0,0 +1,66 @@ +connectors: + forward: {} +exporters: + elasticsearch/componentid-0: {} +inputs: [] +output_permissions: + default: + _elastic_agent_checks: + cluster: + - monitor + _elastic_agent_monitoring: + indices: [] + uuid-for-permissions-on-related-indices: + indices: + - names: + - metrics-*-* + privileges: + - auto_configure + - create_doc +processors: + resourcedetection/componentid-0: + detectors: + - system + override: false + timeout: 2s + transform/componentid-1: + metric_statements: + - context: datapoint + statements: + - set(attributes["data_stream.type"], "metrics") + - set(attributes["data_stream.dataset"], "docker_input_otel.dockerstatsreceiver") + - set(attributes["data_stream.namespace"], "ep") +receivers: + docker_stats/componentid-0: + api_version: "1.44" + collection_interval: 10s + container_labels_to_metric_labels: + com.docker.compose.service: compose_service + com.docker.compose.project: compose_project + endpoint: unix:///var/run/docker.sock + env_vars_to_metric_labels: + ENVIRONMENT: environment + excluded_images: + - nginx:latest + - redis:alpine + initial_delay: "5s" + metrics: + container.cpu.usage.percpu: + enabled: true + timeout: 5s +secret_references: [] +service: + pipelines: + metrics: + exporters: + - elasticsearch/componentid-0 + receivers: + - forward + metrics/componentid-0: + exporters: + - forward + processors: + - resourcedetection/componentid-0 + - transform/componentid-1 + receivers: + - docker_stats/componentid-0 diff --git a/packages/docker_input_otel/_dev/test/policy/test-docker-stats.yml b/packages/docker_input_otel/_dev/test/policy/test-docker-stats.yml new file mode 100644 index 00000000000..3166338040d --- /dev/null +++ b/packages/docker_input_otel/_dev/test/policy/test-docker-stats.yml @@ -0,0 +1,17 @@ +vars: + collection_interval: "10s" + initial_delay: "5s" + endpoint: "unix:///var/run/docker.sock" + excluded_images: + - "nginx:latest" + - "redis:alpine" + timeout: "5s" + api_version: "1.44" + metrics: | + container.cpu.usage.percpu: + enabled: true + container_labels_to_metric_labels: | + com.docker.compose.service: compose_service + com.docker.compose.project: compose_project + env_vars_to_metric_labels: | + ENVIRONMENT: environment diff --git a/packages/docker_input_otel/_dev/test/system/test-default-config.yml b/packages/docker_input_otel/_dev/test/system/test-default-config.yml new file mode 100644 index 00000000000..400d183c769 --- /dev/null +++ b/packages/docker_input_otel/_dev/test/system/test-default-config.yml @@ -0,0 +1,6 @@ +service: dockerd +vars: + collection_interval: 10s + endpoint: "tcp://{{Hostname}}:2375" + # Use a safe API version for the dind image + api_version: "1.41" diff --git a/packages/docker_input_otel/agent/input/input.yml.hbs b/packages/docker_input_otel/agent/input/input.yml.hbs new file mode 100644 index 00000000000..f59778fcba5 --- /dev/null +++ b/packages/docker_input_otel/agent/input/input.yml.hbs @@ -0,0 +1,42 @@ +receivers: + docker_stats: + collection_interval: {{collection_interval}} + initial_delay: {{initial_delay}} +{{#if metrics}} + metrics: {{metrics}} +{{/if}} +{{#if endpoint}} + endpoint: {{endpoint}} +{{/if}} +{{#if excluded_images}} + excluded_images: +{{#each excluded_images as |image|}} + - {{image}} +{{/each}} +{{/if}} +{{#if timeout}} + timeout: {{timeout}} +{{/if}} +{{#if api_version}} + api_version: "{{api_version}}" +{{/if}} +{{#if container_labels_to_metric_labels}} + container_labels_to_metric_labels: {{container_labels_to_metric_labels}} +{{/if}} +{{#if env_vars_to_metric_labels}} + env_vars_to_metric_labels: {{env_vars_to_metric_labels}} +{{/if}} + +processors: + resourcedetection: + detectors: ["system"] + timeout: 2s + override: false + +service: + pipelines: + metrics: + receivers: + - docker_stats + processors: + - resourcedetection diff --git a/packages/docker_input_otel/changelog.yml b/packages/docker_input_otel/changelog.yml new file mode 100644 index 00000000000..c7ce230ea26 --- /dev/null +++ b/packages/docker_input_otel/changelog.yml @@ -0,0 +1,5 @@ +- version: "0.1.0" + changes: + - description: Initial technical preview of Docker Stats OpenTelemetry input package + type: enhancement + link: https://github.com/elastic/integrations/pull/17372 diff --git a/packages/docker_input_otel/docs/README.md b/packages/docker_input_otel/docs/README.md new file mode 100644 index 00000000000..351b81b82bd --- /dev/null +++ b/packages/docker_input_otel/docs/README.md @@ -0,0 +1,83 @@ +# Docker OpenTelemetry Input Package + +## Overview + +The Docker OpenTelemetry Input Package for Elastic enables collection of telemetry data from Docker containers through OpenTelemetry protocols using the [dockerstats receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/dockerstatsreceiver). It provides comprehensive metrics about container resource usage including CPU, memory, network, and block I/O statistics. + +### How it works + +This package receives telemetry data from the Docker daemon by configuring the Docker endpoint in the Input Package, which then gets applied to the `docker_stats` receiver present in the EDOT collector, which then forwards the data to Elastic Agent. The Elastic Agent processes and enriches the data before sending it to Elasticsearch for indexing and analysis. Once the data arrives into Elasticsearch, its corresponding [Docker OpenTelemetry Assets Package](https://www.elastic.co/docs/reference/integrations/docker_otel) gets auto installed and the dashboards light up. + +## Requirements + +- Access to the Docker daemon socket (default: `unix:///var/run/docker.sock` on Linux and `npipe:////./pipe/docker_engine` on Windows) +- Docker API version greater than or equal to the one defined in [Docker Stats Receiver Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/dockerstatsreceiver). Also, the API version must be supported by the Docker Engine being monitored. + +## Compatibility + +This integration uses the OpenTelemetry dockerstats receiver which is currently in **alpha** stability. The configuration and metrics may change between versions. + +## Setup + +For step-by-step instructions on how to set up an integration, see the [Getting started](https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/getting-started-observability.html) guide. + +## Configuration + +The following configuration options are available: + +### Docker Endpoint +The endpoint of the Docker daemon. If not specified, the receiver uses `unix:///var/run/docker.sock` on Linux. +For remote Docker hosts, you can use TCP endpoints like `tcp://docker-host:2375`. + +### Excluded Images +A list of container image names to exclude from metrics collection. Supports wildcards. +Example: +```yaml +- "nginx:*" +- "redis:latest" +``` + +### API Version +The Docker API version to use. Default is `"1.44"`. +For Docker Engine v29, API version `"1.44"` or higher must be used. + +### Initial Delay +Defines how long this receiver waits before starting. Default is `1s`. + +### Container Labels to Metric Labels +Map container labels to metric resource attributes. This allows you to add custom dimensions to your metrics based on container labels. +Example: +```yaml +my.container.label: my_metric_label +app.version: version +``` + +### Environment Variables to Metric Labels +Map container environment variables to metric resource attributes. +Example: +```yaml +MY_ENV_VAR: my_metric_label +APP_VERSION: version +``` + + +### Metrics + +For a complete list of all available metrics, including their types, descriptions, and default enabled status, refer to the [Docker Stats Receiver documentation](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/dockerstatsreceiver/documentation.md) in the upstream OpenTelemetry Collector repository. + +The `metrics` configuration allows you to enable optional metrics or disable default metrics. + +For example, to enable per-CPU usage metrics (which are disabled by default): + +```yaml +metrics: + container.cpu.usage.percpu: + enabled: true +``` + + +## Additional Resources + +- [OpenTelemetry dockerstats receiver documentation](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/dockerstatsreceiver) +- [Docker Stats API documentation](https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerStats) +- [Elastic Observability documentation](https://www.elastic.co/guide/en/observability/current/index.html) diff --git a/packages/docker_input_otel/img/docker_otel_logo.svg b/packages/docker_input_otel/img/docker_otel_logo.svg new file mode 100644 index 00000000000..34692a4e3b7 --- /dev/null +++ b/packages/docker_input_otel/img/docker_otel_logo.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/packages/docker_input_otel/manifest.yml b/packages/docker_input_otel/manifest.yml new file mode 100644 index 00000000000..6c48d285b34 --- /dev/null +++ b/packages/docker_input_otel/manifest.yml @@ -0,0 +1,91 @@ +format_version: 3.5.0 +name: docker_input_otel +title: "Docker OpenTelemetry Input Package" +version: 0.1.0 +source: + license: "Elastic-2.0" +description: "Collect Docker container metrics using OpenTelemetry Collector" +type: input +categories: + - containers + - monitoring + - observability + - opentelemetry +conditions: + kibana: + version: "^9.2.0" + elastic: + subscription: "basic" +icons: + - src: /img/docker_otel_logo.svg + title: Docker OTel logo + size: 32x32 + type: image/svg+xml +policy_templates: + - name: dockerstatsreceiver + title: Docker Stats + description: Collect Docker container performance metrics including CPU, memory, network, and block I/O + input: otelcol + type: metrics + template_path: input.yml.hbs + vars: + - name: collection_interval + type: duration + title: Collection Interval + description: How often to collect metrics (e.g., 10s, 1m). Default is 60s. + default: 60s + required: true + show_user: true + - name: initial_delay + type: duration + description: Defines how long this receiver waits before starting. + default: 1s + required: false + show_user: false + - name: endpoint + type: text + title: Docker Endpoint + description: Docker daemon endpoint + required: false + show_user: false + - name: excluded_images + type: text + title: Excluded Images + description: List of image names to exclude from metrics collection + multi: true + required: false + show_user: false + - name: timeout + type: duration + title: Timeout + description: Timeout for Docker API requests + required: false + show_user: false + - name: api_version + type: text + title: API Version + description: The Docker API version to use. Default is "1.44". + required: false + show_user: false + default: "1.44" + - name: metrics + type: yaml + title: Metrics + description: Enable or disable specific metrics + required: false + show_user: false + - name: container_labels_to_metric_labels + type: yaml + title: Container Labels to Metric Labels + description: Mapping of container labels to metric labels (YAML format) + required: false + show_user: false + - name: env_vars_to_metric_labels + type: yaml + title: Environment Variables to Metric Labels + description: Mapping of environment variables to metric labels (YAML format) + required: false + show_user: false +owner: + github: elastic/ecosystem + type: elastic diff --git a/packages/docker_input_otel/sample_event.json b/packages/docker_input_otel/sample_event.json new file mode 100644 index 00000000000..ed5016e0420 --- /dev/null +++ b/packages/docker_input_otel/sample_event.json @@ -0,0 +1,38 @@ +{ + "@timestamp": 1770889867956, + "_metric_names_hash": "24ce535e7a780dc7", + "attributes": { + "interface": "eth0" + }, + "data_stream": { + "dataset": "dockerstatsreceiver.otel", + "namespace": "20111", + "type": "metrics" + }, + "event": { + "agent_id_status": "missing", + "ingested": "2026-02-12T09:51:17Z" + }, + "metrics": { + "container.network.io.usage.rx_dropped": 0, + "container.network.io.usage.tx_dropped": 0 + }, + "resource": { + "attributes": { + "container.hostname": "07f0e4d3349d", + "container.id": "07f0e4d3349d69663058156e7a274d99bd59889689c6e40d72088624f2c48160", + "container.image.name": "alpine", + "container.name": "stressful", + "container.runtime": "docker", + "host.name": "elastic-agent-37796", + "os.type": "linux" + }, + "schema_url": "https://opentelemetry.io/schemas/1.27.0" + }, + "scope": { + "name": "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/dockerstatsreceiver", + "version": "9.2.3" + }, + "start_timestamp": 1770889863893, + "unit": "{packets}" +}