-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,12 @@ | ||
# Elastic Distributions for OpenTelemetry | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong.
mlunadia
Contributor
|
||
|
||
[OpenTelemetry](https://opentelemetry.io/docs/) is a vendor- and tool-neutral observability framework for collecting, processing, and exporting telemetry data. | ||
The Elastic Distribution for OpenTelemetry (Elastic OTel Collector) is a supported distribution of the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector) made up of mostly upstream components. | ||
[OpenTelemetry](https://opentelemetry.io/docs/) is a vendor-neutral observability framework for collecting, processing, and exporting telemetry data. | ||
The Elastic Distribution for OpenTelemetry Collector (Elastic OTel Collector) is a supported, drop-in replacement distribution of the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector) made up of mostly upstream components. | ||
You can send your telemetry data to Elastic Observability using OpenTelemetry the following ways: | ||
|
||
- Collect and send logs and host metrics to [Elastic Cloud](https://cloud.elastic.co/) using the Elastic OTel Collector. | ||
- Instrument your applications and send logs, traces, and metrics to [Elastic Cloud](https://cloud.elastic.co/) using the **Elastic Distributions for OpenTelemetry** extensions of select [OpenTelemetry language SDKs](https://opentelemetry.io/docs/languages/). The following languages are currently supported: Java, .NET, Node.js, and Python. | ||
- Configure an upstream [custom collector](https://opentelemetry.io/docs/collector/custom-collector/) or [contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) distribution for the collector to collect logs and metrics and send them to Elastic Observability. | ||
- Instrument your applications and send logs, traces, and metrics to [Elastic Cloud](https://cloud.elastic.co/) using the Elastic Distributions for select [OpenTelemetry language SDKs](https://opentelemetry.io/docs/languages/). Currently, Elastic provides distributions for the following language SDKs: Java, .NET, Node.js, and Python. | ||
- Build and configure a [custom collector](https://opentelemetry.io/docs/collector/custom-collector/) or extend the [OpenTelemetry Collector Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) distribution to collect logs and metrics and send them to Elastic Observability. | ||
|
||
This diagram provides a quick overview on how the different components work together. Refer to the [components](docs/collector-components.md) for a more in-depth look. | ||
|
||
|
@@ -23,13 +23,13 @@ These pages detail the components and how to configure the Elastic OTel Collecto | |
|
||
## Collect application data with Elastic Distributions for OpenTelemetry language SDKs | ||
|
||
Elastic offers several distributions that extend [OpenTelemetry language SDKs](https://opentelemetry.io/docs/languages/). The following languages are currently supported: | ||
Elastic offers several Distributions that extend [OpenTelemetry language SDKs](https://opentelemetry.io/docs/languages/). The following languages are currently supported: | ||
|
||
* [Java](https://github.com/elastic/elastic-otel-java) | ||
* [.NET](https://github.com/elastic/elastic-otel-dotnet) | ||
* [Node.js](https://github.com/elastic/elastic-otel-node) | ||
* [Python](https://github.com/elastic/elastic-otel-python) | ||
|
||
## Configure an upstream collector for Elastic | ||
## Configure a custom collector or the OpenTelemetry Collector Contrib distribution | ||
|
||
[Configure a custom collector or a contrib distribution of the OpenTelemetry collector](docs/configure-upstream-collector.md): Configure a [custom collector](https://opentelemetry.io/docs/collector/custom-collector/) or [contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) distribution for the OpenTelemetry collector to collect logs and metrics and send them to Elastic Observability. | ||
[Configure a custom collector or the OpenTelemetry Collector Contrib distribution](docs/configure-upstream-collector.md): Build and configure a [custom collector](https://opentelemetry.io/docs/collector/custom-collector/) or extend the [OpenTelemetry Collector Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) distribution to collect logs and metrics and send them to Elastic Observability. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,11 @@ | ||
# Elastic Distribution for OpenTelemetry Collector limitations | ||
|
||
The Elastic OTel Collector has the following limitations: | ||
The Elastic Distribution for the OpenTelemetry Collector has the following limitations: | ||
|
||
- Because of an upstream limitation, `host.network.*` metrics aren't present from the OpenTelemetry side. | ||
- `process.state` isn't present in the OpenTelemetry host metric. It's set to a dummy value of **Unknown** in the **State** column of the host processes table. | ||
- The Elasticsearch exporter handles the metadata fields, but **Host OS version** and **Operating system** may show as "N/A" and **Host IP** may show different values. | ||
- The CPU scraper needs to be enabled to collect the `systm.load.cores` metric, which affects the **Normalized Load** column in the **Hosts** table and the **Normalized Load** visualization on the host detailed view. | ||
- The Elasticsearch exporter handles the resource attributes, but **Host OS version** and **Operating system** may show as "N/A". | ||
- The CPU scraper needs to be enabled to collect the `systm.load.cores` metric, which affects the **Normalized Load** column in the **Hosts** table and the **Normalized Load** visualization on the host detailed view. | ||
- The [`hostmetrics receiver`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver) doesn't support CPU and disk metrics on MacOS. These values will stay empty for collectors running on MacOS. | ||
- The console shows error Log messages when the [`hostmetrics receiver`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver) can't access some of the process information due to permission issues. | ||
- The console shows mapping errors initially until mapping occurs. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# Collect logs and metrics using the guided onboarding | ||
The guided onboarding in Kibana or in a serverless Observability project walks you through collecting logs and metrics using the Elastic OTel Collector. | ||
For manual configuration, refer to [Manually configure the Elastic OTel Collector](manual-configuration.md). | ||
The guided onboarding in Kibana or in a serverless Observability project walks you through collecting logs and metrics using the Elastic Distribution for OpenTelemetry Collector. | ||
To configure the Elastic OTel Collector manually, refer to the [manual configuration](manual-configuration.md) docs. | ||
|
||
## Before you begin | ||
The onboarding has the following requirements and limitations: | ||
This comment has been minimized.
Sorry, something went wrong.
mlunadia
Contributor
|
||
|
@@ -12,14 +12,14 @@ The onboarding has the following requirements and limitations: | |
|
||
## Collect your logs and metrics | ||
|
||
Follow these steps to collect logs and metrics using the Elastic OTel collector | ||
Follow these steps to collect logs and metrics using the Elastic OTel collector: | ||
|
||
1. Open an [Elastic Cloud](cloud.elastic.co) deployment or a serverless Observability project. | ||
1. To open the guided onboarding, either: | ||
1. In an Elastic Cloud deployment, open Kibana, and go to **Observability** → **Add Data**. | ||
1. In a serverless Observability project, go to **Add Data**. | ||
1. Select **Collect and analyze logs**, and then select **OpenTelemetry**. | ||
1. Select the appropriate platform: | ||
1. Select the appropriate platform, and complete the following: | ||
1. For **MacOS and Linux**, copy the command, open a terminal on your host, and run the command to download and configure the OpenTelemetry collector. | ||
1. For **Kubernetes**, download the manifest. | ||
1. Copy the command under Step 2: | ||
|
@mdbirnstiehl Should we add an index or is there any other way for users can get where they want without having to find links in the paragraphs?