--- title: System OpenTelemetry Assets description: System OpenTelemetry Assets provides dashboards for visualizing OpenTelemetry hosts' metrics and logs. Collect and ingest OpenTelemetry data from the... url: https://www.elastic.co/docs/reference/integrations/system_otel products: - Elastic integrations applies_to: - Serverless Observability projects: Preview - Serverless Security projects: Preview - Elastic Stack: Preview since 9.0 --- # System OpenTelemetry Assets | | | |-------------------------------------------------------------------------------------------------|-------------------------------------------------------------------| | **Version** | 0.3.0 : Preview ([View all](#changelog)) | | **Subscription level**[What's this?](https://www.elastic.co/subscriptions) | Basic | | **Developed by**[What's this?](https://www.elastic.co/docs/reference/integrations/developed-by) | Elastic | | **Minimum Kibana version(s)** | 9.0.08.18.0 | To use pre-release integrations, go to the **Integrations** page in Kibana, scroll down, and toggle on the _Display beta integrations_ option. System OpenTelemetry Assets provides dashboards for visualizing OpenTelemetry hosts' metrics and logs. ## Requirements Collect and ingest OpenTelemetry data from the Collector's [`hostmetrics` receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.127.0/receiver/hostmetricsreceiver) through: - [Elastic Distributions of OpenTelemetry](https://www.elastic.co/docs/reference/opentelemetry/quickstart/) - Contrib or upstream OpenTelemetry Collector Compatible `hostmetrics` receiver versions are version 0.102.0 or later. ## Where to start If you're configuring your OpenTelemetry Collector so the dashboards in this package work as expected, start with *Collector configuration*, and then verify the required *Available metrics*. ## Collector configuration The Elastic Distribution of OpenTelemetry (EDOT) Collector and the upstream Contrib Collector both include the `hostmetrics` receiver. Regardless of which Collector distribution you use, review the following snippets and add or adjust your Collector configuration to ensure the required metrics are enabled, as some of them are not enabled by default. ### Receivers configuration Make sure that your receivers section in the Collector configuration file is as follows: #### Linux ```yaml # Receiver for CPU, Disk, Memory, and Filesystem metrics hostmetrics/system: collection_interval: 60s scrapers: disk: filesystem: cpu: metrics: system.cpu.utilization: enabled: true system.cpu.logical.count: enabled: true memory: metrics: system.memory.utilization: enabled: true #process: # mute_process_exe_error: true # mute_process_io_error: true # mute_process_user_error: true # metrics: # process.threads: # enabled: true # process.open_file_descriptors: # enabled: true # process.memory.utilization: # enabled: true # process.disk.operations: # enabled: true network: processes: load: ``` #### Windows ```yaml # Receiver for CPU, Disk, Memory, and Filesystem metrics hostmetrics/system: collection_interval: 60s scrapers: filesystem: memory: metrics: system.memory.utilization: enabled: true #process: # mute_process_exe_error: true # mute_process_io_error: true # mute_process_user_error: true # metrics: # process.threads: # enabled: true # process.open_file_descriptors: # enabled: true # process.memory.utilization: # enabled: true # process.disk.operations: # enabled: true network: processes: load: ``` ### Processors configuration Make sure that your processors section in the Collector configuration file is as follows: ```yaml processors: resourcedetection: detectors: ["system"] system: hostname_sources: ["os"] resource_attributes: host.name: enabled: true host.id: enabled: false host.arch: enabled: true host.cpu.vendor.id: enabled: true host.cpu.family: enabled: true host.cpu.model.id: enabled: true host.cpu.model.name: enabled: true host.cpu.stepping: enabled: true host.cpu.cache.l2.size: enabled: true os.description: enabled: true os.type: enabled: true ``` ### Service configuration Make sure that the service section in your Collector configuration file includes the receiver and processor: #### Self-managed ```yaml service: metrics/hostmetrics: receivers: [hostmetrics/system] processors: [resourcedetection] exporters: [elasticsearch/otel] ``` ### ECH and Serverless ```yaml metrics/hostmetrics: receivers: [hostmetrics/system] processors: [resourcedetection] exporters: [otlp/ingest_metrics_traces] ``` ## Available metrics For full functionality of the dashboards included in this content pack, you will need to ensure the following metrics are enabled in the [`hostmetrics` receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.127.0/receiver/hostmetricsreceiver): | Metric | Enabled by default in EDOT Collector | Enabled by default in upstream Contrib Collector | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|--------------------------------------------------| | **[CPU](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.127.0/receiver/hostmetricsreceiver/internal/scraper/cpuscraper/documentation.md)** | | | | `system.cpu.time` | ✅ | ✅ | | `system.cpu.utilization` | ✅ | ❌ | | `system.cpu.logical.count` | ✅ | ❌ | | **[Load](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.127.0/receiver/hostmetricsreceiver/internal/scraper/loadscraper/documentation.md)** | | | | `system.cpu.load_average.1m` | ✅ | ✅ | | `system.cpu.load_average.5m` | ✅ | ✅ | | `system.cpu.load_average.15m` | ✅ | ✅ | | **[Memory](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.127.0/receiver/hostmetricsreceiver/internal/scraper/memoryscraper/documentation.md)** | | | | `system.memory.usage` | ✅ | ✅ | | `system.memory.utilization` | ✅ | ❌ | | **[Network](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.127.0/receiver/hostmetricsreceiver/internal/scraper/networkscraper/documentation.md)** | | | | `system.network.connections` | ✅ | ✅ | | `system.network.dropped` | ✅ | ✅ | | `system.network.errors` | ✅ | ✅ | | `system.network.io` | ✅ | ✅ | | `system.network.packets` | ✅ | ✅ | | **[Disk](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.127.0/receiver/hostmetricsreceiver/internal/scraper/diskscraper/documentation.md)** | | | | `system.disk.io` | ✅ | ✅ | | `system.disk.io_time` | ✅ | ✅ | | `system.disk.operations` | ✅ | ✅ | | **[File System](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.127.0/receiver/hostmetricsreceiver/internal/scraper/filesystemscraper/documentation.md)** | | | | `system.filesystem.usage` | ✅ | ✅ | | **[Processes](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.127.0/receiver/hostmetricsreceiver/internal/scraper/processesscraper/documentation.md)** | | | | `system.processes.count` | ✅ | ✅ | | `system.processes.created` | ✅ | ✅ | For step-by-step instructions on how to ingest OpenTelemetry data using Elastic's distribution of the OpenTelemetry Collector, see the [quickstart guide](https://www.elastic.co/docs/reference/opentelemetry/quickstart/). Also, it's recommended to enable the [`resourcedetection` processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.127.0/processor/resourcedetectionprocessor/README.md) with detection of the following resource attributes explicitly enabled: - `host.name` - `host.id` - `host.arch` - `host.cpu.vendor.id` - `host.cpu.family` - `host.cpu.model.id` - `host.cpu.model.name` - `host.cpu.stepping` - `host.cpu.cache.l2.size` - `os.description` - `os.type` ## Troubleshooting If individual widgets in the dashboard show errors that certain fields are not available, that might be an indicator of one of the following: - For your use case, the missing data is not relevant (e.g. you are only running plain, local VMs, no `Cloud` metadata will be available). - Your Collector configuration does not enable all of the required metrics, or resource attributes. For additional information, refer to: - [Scraper limitations](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.127.0/receiver/hostmetricsreceiver#host-metrics-receiver) with the `hostmetrics` receiver for certain systems. - [Related EDOT Collector limitations](https://www.elastic.co/docs/reference/opentelemetry/compatibility/limitations#infrastructure-and-host-metrics) for host metrics. ## Screenshots This integration includes one or more Kibana dashboards that visualizes the data collected by the integration. The screenshots below illustrate how the ingested data is displayed. ![Host Details Metrics](https://epr.elastic.co/package/system_otel/0.3.0/img/metrics.png) ![Host Details Logs](https://epr.elastic.co/package/system_otel/0.3.0/img/logs-view.png) ## Changelog | Version | Details | Minimum Kibana version | |-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| | **0.3.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/19942))Add tags to Kibana assets | 9.0.08.18.0 | | **0.2.7** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/18390))Remove `host.ip` and `host.mac` from dashboard | 9.0.08.18.0 | | **0.2.6** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/17459))Use `host.id` so cloud metadata works with default attributes | 9.0.08.18.0 | | **0.2.5** | **Bug fix** ([View pull request](https://github.com/elastic/integrations/pull/17459))Clarify Collector configuration guidance for enabling required host metrics | 9.0.08.18.0 | | **0.2.4** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/17018))Update documentation with config examples | 9.0.08.18.0 | | **0.2.3** | **Bug fix** ([View pull request](https://github.com/elastic/integrations/pull/15615))Use `metrics-*` index pattern for dataviews | 9.0.08.18.0 | | **0.2.2** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/15615))Add `opentelemetry` category | 9.0.08.18.0 | | **0.2.1** | **Bug fix** ([View pull request](https://github.com/elastic/integrations/pull/15509))Remove adhoc dataviews | 9.0.08.18.0 | | **0.2.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/14770))Add discovery datasets field | 9.0.08.18.0 | | **0.1.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/14400))Initial version of the System OpenTelemetry Assets content pack | 9.0.08.18.0 |