diff --git a/reference/fleet/manage-integrations.md b/reference/fleet/manage-integrations.md index 9f1671bd05..f9260c28a2 100644 --- a/reference/fleet/manage-integrations.md +++ b/reference/fleet/manage-integrations.md @@ -2,6 +2,9 @@ navigation_title: Manage integrations mapped_pages: - https://www.elastic.co/guide/en/fleet/current/integrations.html +applies_to: + stack: ga + serverless: ga products: - id: fleet - id: elastic-agent @@ -9,27 +12,24 @@ products: # Manage {{agent}} integrations [integrations] +{{agent}} integrations provide a unified way to collect data from apps and services and to protect systems from security threats. -::::{admonition} -Integrations are available for a wide array of popular services and platforms. To see the full list of available integrations, go to the **Integrations** page in {{kib}}, or visit [Elastic Integrations](integration-docs://reference/index.md). +Integrations are available for a wide array of services and platforms. To browse the full list of available integrations, go to the **Integrations** page in {{kib}}, or visit [Elastic Integrations](integration-docs://reference/index.md). -{{agent}} integrations provide a simple, unified way to collect data from popular apps and services, and protect systems from security threats. - -Each integration comes prepackaged with assets that support all of your observability needs: +{{agent}} integrations based on the [Elastic Common Schema](ecs://reference/index.md) (ECS) come prepackaged with assets that support your observability needs: * Data ingestion, storage, and transformation rules * Configuration options * Pre-built, custom dashboards and visualizations * Documentation -:::: - +{applies_to}`stack: preview 9.2.0` {{fleet}} also supports installing {{agent}} integration packages for collecting and visualizing OpenTelemetry data. For more information, refer to [Collect OpenTelemetry data with {{agent}} integrations](/reference/fleet/otel-integrations.md). ::::{note} -Be aware that some integrations may function differently across different spaces. Also, some might only work in the default space. We recommend reviewing the specific integration documentation for any space-related considerations. - +Some integrations may function differently across different spaces, and some might only work in the default space. For any space-related considerations, review the documentation for the specific integration. :::: +## Integration actions [integration-actions] The following table shows the main actions you can perform in the **Integrations** app in {{kib}}. You can perform some of these actions from other places in {{kib}}, too. @@ -44,9 +44,8 @@ The following table shows the main actions you can perform in the **Integrations ::::{note} The **Integrations** app in {{kib}} needs access to the public {{package-registry}} to discover integrations. If your deployment has network restrictions, you can [deploy your own self-managed {{package-registry}}](/reference/fleet/air-gapped.md#air-gapped-diy-epr). - :::: :::{tip} Once you've started using integrations to ingest data, you can customize how that data is managed over time. Refer to [Index lifecycle management](/reference/fleet/data-streams.md#data-streams-ilm) to learn more. -::: +::: \ No newline at end of file diff --git a/reference/fleet/otel-integrations.md b/reference/fleet/otel-integrations.md new file mode 100644 index 0000000000..4ca073f4e7 --- /dev/null +++ b/reference/fleet/otel-integrations.md @@ -0,0 +1,47 @@ +--- +navigation_title: OpenTelemetry integration packages +description: Fleet supports installing Elastic Agent integration packages for collecting and visualizing OpenTelemetry data such as logs, metrics, and traces. +applies_to: + stack: preview 9.2 + serverless: ga +products: + - id: fleet + - id: elastic-agent +--- + +# Collect OpenTelemetry data with {{agent}} integrations + +{{fleet}} now supports installing {{agent}} integration packages for collecting and visualizing OpenTelemetry (OTel) data such as logs, metrics, and traces. To find the available OpenTelemetry integration packages, open the **Integrations** page in {{kib}}, then select the **OpenTelemetry** category. + +There are two types of OpenTelemetry integration packages: + +- Input packages which include an OTel Collector configuration. +- Content packages which include {{es}} and {{kib}} assets such as prebuilt dashboards and visualizations. + +Unlike {{agent}} integrations based on the [Elastic Common Schema](ecs://reference/index.md) (ECS), OpenTelemetry input packages use OTel Collector receivers to collect OTel data following [OpenTelemetry semantic conventions](https://opentelemetry.io/docs/specs/semconv). + +When OTel data is collected using an OpenTelemetry input package, content packages with assets related to the collected data type are automatically installed if available. + +:::{important} +OpenTelemetry input packages are used with {{fleet}} and {{agent}} running in default mode. They are distinct from [running {{agent}} as an EDOT Collector](/reference/fleet/otel-agent.md), and cannot be used on {{agent}} running in `otel` mode. +::: + +## Configure OpenTelemetry input packages + +The installation and configuration of OpenTelemetry input packages is similar to that of ECS-based integrations and allow you to specify the namespace, dataset name, data stream type, and more. For more information, refer to [Add an integration to an {{agent}} policy](/reference/fleet/add-integration-to-policy.md). + +When the integration policy for the input package is created, {{fleet}} creates a managed index template with an OTel configuration and an index pattern with an `.otel` suffix. The index template uses {{fleet}} component templates for settings and OTel component templates for default mappings. It also includes `@custom` component templates that allow you to [customize your {{es}} index](/reference/fleet/data-streams.md#data-streams-index-templates-edit) similarly to ECS-based integrations. + +On the OpenTelemetry input package's **Configs** page, you can view a generated sample configuration, which you can use as a starting point to set up the integration on a standalone {{agent}}. + +Note that this is a partial configuration as it does not include an exporter component. For more information on setting up the exporter, refer to [{{es}} exporter](elastic-agent://reference/edot-collector/components/elasticsearchexporter.md). + +:::{note} +Currently, OpenTelemetry input packages only support sending data using the {{es}} output. +::: + +## Compatibility with ECS-based integrations + +{{agent}} policies can include configurations for both ECS-based integrations and OpenTelemetry input packages, essentially converting the {{agents}} enrolled in the policy into hybrid agents. + +Note that only {{agents}} on version 9.2 or later can collect OTel data using OpenTelemetry input packages. OpenTelemetry input packages added to an agent policy do not affect enrolled agents on prior versions. \ No newline at end of file diff --git a/reference/fleet/toc.yml b/reference/fleet/toc.yml index a08b40b87f..cadbf6392a 100644 --- a/reference/fleet/toc.yml +++ b/reference/fleet/toc.yml @@ -149,6 +149,7 @@ toc: - file: upgrade-integration.md - file: managed-integrations-content.md - file: integrations-assets-best-practices.md + - file: otel-integrations.md - file: data-streams.md children: - file: data-streams-ilm-tutorial.md