diff --git a/README.md b/README.md index 751a17b..194b2d9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # Elastic Distributions of OpenTelemetry [OpenTelemetry](https://opentelemetry.io/docs/) is a vendor-neutral observability framework for collecting, processing, and exporting telemetry data. -The Elastic Distribution of OpenTelemetry (EDOT) 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 use OpenTelemetry to send your telemetry data to Elastic Observability the following ways: + +The Elastic Distributions of OpenTelemetry (EDOT) are composed of OpenTelemetry (OTel) project components, [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector), and language SDKs, which provide users with the necessary capabilities and out-of-the-box configurations, enabling quick and effortless infrastructure and application monitoring. + +You can use OpenTelemetry to send your telemetry data to Elastic Observability in the following ways: - Collect and send logs and host metrics to [Elastic Cloud](https://cloud.elastic.co/) using the EDOT Collector. - Instrument your applications and send logs, traces, and metrics to [Elastic Cloud](https://cloud.elastic.co/) using the Elastic Distributions of select [OpenTelemetry language SDKs](https://opentelemetry.io/docs/languages/). Currently, Elastic provides distributions for the following language SDKs: Java, .NET, Node.js, and Python. @@ -17,7 +19,7 @@ This diagram provides a quick overview of how the different components work toge These pages detail the components and how to configure the EDOT Collector. - [Components](docs/collector-components.md): Get details on the components used to receive, process, and export telemetry data. -- [Guided onboarding](docs/guided-onboarding.md): Use the guided onboarding in Kibana or in a serverless Observability project to send data using the EDOT Collector. +- [Guided onboarding](docs/guided-onboarding.md): Use the guided onboarding in Elasticsearch Service or a serverless Observability project to send data using the EDOT Collector. - [Manual configurations](docs/manual-configuration.md): Manually configure the EDOT Collector to send data to Elastic Observability. - [Limitations](docs/collector-limitations.md): Understand the current limitations of the EDOT Collector. diff --git a/docs/configure-upstream-collector.md b/docs/configure-upstream-collector.md index f9f2b7e..8e0e5ce 100644 --- a/docs/configure-upstream-collector.md +++ b/docs/configure-upstream-collector.md @@ -2,8 +2,8 @@ You can 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. -For a more seamless experience, use the Elastic Distribution for the OpenTelemetry Collector. -Refer to the [guided onboarding](guided-onboarding.md) docs or the [manual configuration](manual-configuration.md) docs for more on configuring the Elastic Distribution for the OpenTelemetry Collector. +For a more seamless experience, use the Elastic Distribution of the OpenTelemetry Collector. +Refer to the [guided onboarding](guided-onboarding.md) docs or the [manual configuration](manual-configuration.md) docs for more on configuring the Elastic Distribution of the OpenTelemetry Collector. ## Upstream collector configuration examples Refer to the OpenTelemetry documentation on [building a custom collector](https://opentelemetry.io/docs/collector/custom-collector/) for more on creating an upstream collector. diff --git a/docs/guided-onboarding.md b/docs/guided-onboarding.md index ff5ed85..d1d91e2 100644 --- a/docs/guided-onboarding.md +++ b/docs/guided-onboarding.md @@ -1,5 +1,5 @@ # 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 Distribution of OpenTelemetry (EDOT) Collector. +The guided onboarding in Elasticsearch Service or a serverless Observability project walks you through collecting logs and metrics using the Elastic Distribution of OpenTelemetry (EDOT) Collector. To configure the EDOT Collector manually, refer to the [manual configuration](manual-configuration.md) docs. ## Before you begin @@ -7,7 +7,7 @@ The onboarding has the following requirements: - The **Admin** role or higher is required to onboard system logs and metrics. To learn more, refer to [Assign user roles and privileges](https://www.elastic.co/docs/current/serverless/general/assign-user-roles). - Root privileges on the host are required to run the OpenTelemetry collector used in this quickstart. -- The EDOT Collector only works on Kubernetes, Linux, and MacOS systems. +- The guided onboarding provides out-of-the-box deployment and configurations for Kubernetes, Linux, and MacOS systems. ## Collect your logs and metrics diff --git a/docs/manual-configuration.md b/docs/manual-configuration.md index 2bb7ee5..7a49b0b 100644 --- a/docs/manual-configuration.md +++ b/docs/manual-configuration.md @@ -1,5 +1,5 @@ # Manually configure the Elastic Distribution of OpenTelemetry Collector -Collecting logs and host metrics with the Elastic Distribution of OpenTelemetry (EDOT) Collector without using the [guided onboarding](guided-onboarding.md) requires some manual configuration. +Collecting logs and host metrics with the Elastic Distribution of OpenTelemetry (EDOT) Collector without using the [guided onboarding](guided-onboarding.md) requires completing some manual steps. ## Before you begin The EDOT Collector has the following requirements: @@ -12,9 +12,9 @@ The EDOT Collector has the following requirements: To manually configure the EDOT Collector, gather the following information: -- **Your Elasticsearch endpoint**: From the help menu in Kibana or your serverless Observability project, select **Connection details** and copy the **Elasticsearch endpoint**. +- **Your Elasticsearch endpoint**: From the help menu in Elastic Cloud or your serverless Observability project, select **Connection details** and copy the **Elasticsearch endpoint**. - **API key**: - - **Kibana:** From the help menu, select **Connection details** and select **Create and manage API keys**. From the **API keys** page, select **Create API key**. Give your API key a name, select **Create API key**, and copy the new API key. + - **Elasticsearch Service:** From the help menu, select **Connection details** and select **Create and manage API keys**. From the **API keys** page, select **Create API key**. Give your API key a name, select **Create API key**, and copy the new API key. - **Serverless:** From the help menu, select **Connection details** and select the **API key** tab. Give your API key a name, select **Create API key**, and copy the new API key. Then manually configure the EDOT Collector to collect logs and metrics on a MacOS or Linux system: @@ -27,7 +27,7 @@ Then manually configure the EDOT Collector to collect logs and metrics on a MacO - `file_storage.directory`: Set to the directory where you want to store you OpenTelemetry data. - `elasticsearch.endpoint`: Set to your Elasticsearch endpoint you copied earlier. - `elasticsearch.api_key`: Set to the API key you created earlier. -1. Run the OpenTelemetry collector with the following command: +1. Run the EDOT collector with the following command: ```console ./elastic-agent otel --config otel.yml ``` @@ -37,4 +37,4 @@ The default log path is `/var/log/*`. Update the path in the `otel.yml` file. ## Limitations -Refer to [Elastic OpenTelemetry Collector limitations](collector-limitations.md) for known limitations when using the Elastic Distribution for the OpenTelemetry collector. \ No newline at end of file +Refer to [Elastic OpenTelemetry Collector limitations](collector-limitations.md) for known limitations when using the Elastic Distribution of the OpenTelemetry collector. \ No newline at end of file