-
Notifications
You must be signed in to change notification settings - Fork 515
Initial version of the OpenTelemetry System content pack #14400
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.
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
Merged
AlexanderWert
merged 26 commits into
elastic:main
from
AlexanderWert:otel-system-content-pack
Jul 9, 2025
Merged
Changes from all commits
Commits
Show all changes
26 commits
Select commit
Hold shift + click to select a range
267d431
Initial version of the OpenTelemetry System content pack
AlexanderWert 40d9357
added codeowner
AlexanderWert f7e185b
fix dataview problem
AlexanderWert 310e08c
fix hosts filtering in logs view
AlexanderWert 36932f8
Update packages/system_otel/changelog.yml
ChrsMark dbe4e7a
Update packages/system_otel/docs/README.md
AlexanderWert 8bfd772
Update packages/system_otel/docs/README.md
AlexanderWert 39103cf
fixed some review comments
AlexanderWert ab52668
updated readme
AlexanderWert 83f8c33
fix that pods are shown in hosts overview
AlexanderWert 1052b6d
Update packages/system_otel/changelog.yml
AlexanderWert d86940d
fix CPU utilization label
AlexanderWert d9e8d4b
fixed bug with filter
AlexanderWert 9ad0b43
Update packages/system_otel/docs/README.md
AlexanderWert e5d23a6
Update packages/system_otel/docs/README.md
AlexanderWert de024ca
Update packages/system_otel/docs/README.md
AlexanderWert 8f55695
Update packages/system_otel/docs/README.md
AlexanderWert c00bc77
Update packages/system_otel/docs/README.md
AlexanderWert d14193c
Update packages/system_otel/docs/README.md
AlexanderWert 6770a66
Update packages/system_otel/docs/README.md
AlexanderWert 40ed57f
Update packages/system_otel/docs/README.md
AlexanderWert c934224
Update packages/system_otel/docs/README.md
AlexanderWert 179c4d7
Update packages/system_otel/docs/README.md
AlexanderWert 0a8ba92
Update packages/system_otel/docs/README.md
AlexanderWert 0c1a3e9
removed cloud.availability_zone attributes from metadata
AlexanderWert 6211ef3
Merge branch 'main' into otel-system-content-pack
AlexanderWert File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # newer versions go on top | ||
| - version: "0.1.0" | ||
| changes: | ||
| - description: Initial version of the System OpenTelemetry Assets content pack | ||
| type: enhancement | ||
| link: https://github.com/elastic/integrations/pull/14400 # FIXME Replace with the real PR link |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| # System OpenTelemetry Assets | ||
|
|
||
| System OpenTelemetry Assets provides dashboards for vizualising 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: | ||
|
|
||
| - the [Elastic Distributions of OpenTelemetry](https://www.elastic.co/docs/reference/opentelemetry/quickstart/) | ||
| - or using the vanilla / upstream OpenTelemetry Collector | ||
|
|
||
| Compatible `hostmetrics` receiver versions are all versions `>= v0.102.0`. | ||
|
|
||
| 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.ip` | ||
| - `host.mac` | ||
| - `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 evailable, 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) | ||
| - You are using the OpenTelemetry upstream Contrib Collector (or any other, non-EDOT Collector) and some of the above-mentioned requirements are not met | ||
|
|
||
| See also: | ||
|
|
||
| - [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 | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.