Skip to content
Merged
Show file tree
Hide file tree
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 Jul 2, 2025
40d9357
added codeowner
AlexanderWert Jul 2, 2025
f7e185b
fix dataview problem
AlexanderWert Jul 2, 2025
310e08c
fix hosts filtering in logs view
AlexanderWert Jul 2, 2025
36932f8
Update packages/system_otel/changelog.yml
ChrsMark Jul 2, 2025
dbe4e7a
Update packages/system_otel/docs/README.md
AlexanderWert Jul 3, 2025
8bfd772
Update packages/system_otel/docs/README.md
AlexanderWert Jul 3, 2025
39103cf
fixed some review comments
AlexanderWert Jul 3, 2025
ab52668
updated readme
AlexanderWert Jul 3, 2025
83f8c33
fix that pods are shown in hosts overview
AlexanderWert Jul 3, 2025
1052b6d
Update packages/system_otel/changelog.yml
AlexanderWert Jul 3, 2025
d86940d
fix CPU utilization label
AlexanderWert Jul 3, 2025
d9e8d4b
fixed bug with filter
AlexanderWert Jul 3, 2025
9ad0b43
Update packages/system_otel/docs/README.md
AlexanderWert Jul 4, 2025
e5d23a6
Update packages/system_otel/docs/README.md
AlexanderWert Jul 4, 2025
de024ca
Update packages/system_otel/docs/README.md
AlexanderWert Jul 4, 2025
8f55695
Update packages/system_otel/docs/README.md
AlexanderWert Jul 4, 2025
c00bc77
Update packages/system_otel/docs/README.md
AlexanderWert Jul 4, 2025
d14193c
Update packages/system_otel/docs/README.md
AlexanderWert Jul 4, 2025
6770a66
Update packages/system_otel/docs/README.md
AlexanderWert Jul 4, 2025
40ed57f
Update packages/system_otel/docs/README.md
AlexanderWert Jul 4, 2025
c934224
Update packages/system_otel/docs/README.md
AlexanderWert Jul 4, 2025
179c4d7
Update packages/system_otel/docs/README.md
AlexanderWert Jul 4, 2025
0a8ba92
Update packages/system_otel/docs/README.md
AlexanderWert Jul 4, 2025
0c1a3e9
removed cloud.availability_zone attributes from metadata
AlexanderWert Jul 4, 2025
6211ef3
Merge branch 'main' into otel-system-content-pack
AlexanderWert Jul 4, 2025
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
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,7 @@
/packages/system/data_stream/uptime @elastic/obs-infraobs-integrations
/packages/system/manifest.yml @elastic/obs-infraobs-integrations @elastic/sec-linux-platform @elastic/sec-windows-platform
/packages/system_audit @elastic/sec-linux-platform
/packages/system_otel @elastic/ingest-otel-data
/packages/tanium @elastic/security-service-integrations
/packages/tcp @elastic/sec-deployment-and-devices
/packages/teleport @elastic/security-service-integrations
Expand Down
6 changes: 6 additions & 0 deletions packages/system_otel/changelog.yml
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
74 changes: 74 additions & 0 deletions packages/system_otel/docs/README.md
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.
Binary file added packages/system_otel/img/logs-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/system_otel/img/metrics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions packages/system_otel/img/system-otel.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading