Skip to content

Update Observability integration steps for direct Add integration navigation #9252

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.

Sign up for GitHub

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
vishaangelova merged 2 commits into from
Nov 6, 2026
Merged

Update Observability integration steps for direct Add integration navigation #9252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
570a92b
Update Observability integration steps for direct Add integration nav…
vishaangelova Nov 6, 2026
8b5c74d
Drop the separate documentation step and the required settings senten…
vishaangelova Nov 6, 2026
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
4 changes: 2 additions & 2 deletions solutions/observability/apm/apm-server/fleet-managed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,15 +113,15 @@ If you don’t have a {{fleet}} setup already in place, the easiest way to get s

::::

1. In {{kib}}, find **Integrations** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
1. In {{kib}}, find **Integrations** in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Select **Elastic APM**.

:::{image} /solutions/images/observability-kibana-fleet-integrations-apm.png
Comment thread
vishaangelova marked this conversation as resolved.
Resolved
:alt: {{fleet}} showing APM integration
:screenshot:
:::

3. Click **Add Elastic APM**.
3. If the integration's **Overview** page opens, click **Add Elastic APM**.

:::{image} /solutions/images/observability-kibana-fleet-integrations-apm-overview.png
:alt: {{fleet}} showing APM integration overview
Expand Down
24 changes: 18 additions & 6 deletions solutions/observability/apm/ingest/jaeger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,14 @@ The APM integration serves Jaeger gRPC over the same host and port as the Elasti

::::::{applies-item} ess:
1. Log into [{{ecloud}}](https://cloud.elastic.co?page=docs&placement=docs-body) and select your deployment.
2. In {{kib}}, find **Integrations** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
3. Select **Elastic APM**. If the integration is already installed, under the polices tab, select **Actions** > **Edit integration**. If the integration has not been installed, select **Add Elastic APM**. Copy the URL. If you’re using Agent authorization, copy the Secret token as well.
4. Configure the APM Integration as a collector for your Jaeger agents.
2. In {{kib}}, find **Integrations** in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
3. Open the Elastic APM integration settings:

* If the Elastic APM integration is already installed, open the **Installed integrations** tab and select **Elastic APM**. On the **Integration policies** tab, select **Actions** → **Edit integration**.
* If the integration isn't installed yet, [add the Elastic APM integration](/reference/fleet/add-integration-to-policy.md).

4. Copy the URL. If you’re using Agent authorization, copy the Secret token as well.
5. Configure the APM Integration as a collector for your Jaeger agents.

As of this writing, the Jaeger agent binary offers the following CLI flags, which can be used to enable TLS, output to {{ecloud}}, and set the APM Integration secret token:

Expand All @@ -65,23 +70,30 @@ For the equivalent environment variables, change all letters to upper-case and r
::::::

::::::{applies-item} self:
1. Configure the APM Integration as a collector for your Jaeger agents. In {{kib}}, find **Integrations** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). Select **Elastic APM**. If the integration is already installed, under the polices tab, select **Actions** > **Edit integration**. If the integration has not been installed, select **Add Elastic APM**. Copy the Host. If you’re using Agent authorization, copy the Secret token as well.
1. In {{kib}}, find **Integrations** in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Open the Elastic APM integration settings:

* If the Elastic APM integration is already installed, open the **Installed integrations** tab and select **Elastic APM**. On the **Integration policies** tab, select **Actions** → **Edit integration**.
* If the integration isn't installed yet, [add the Elastic APM integration](/reference/fleet/add-integration-to-policy.md).

3. Copy the Host. If you’re using Agent authorization, copy the Secret token as well.
4. Configure the APM Integration as a collector for your Jaeger agents.

As of this writing, the Jaeger agent binary offers the `--reporter.grpc.host-port` CLI flag. Use this to define the host and port that the APM Integration is listening on:

```bash
--reporter.grpc.host-port=<apm-endpoint:8200>
```

2. (Optional) Enable encryption
5. (Optional) Enable encryption

When TLS is enabled for the APM Integration, Jaeger agents must also enable TLS communication:

```bash
--reporter.grpc.tls.enabled=true
```

3. (Optional) Enable token-based authorization
6. (Optional) Enable token-based authorization

A secret token or API key can be used to ensure only authorized Jaeger agents can send data to the APM Integration. When enabled, use an agent level tag to authorize Jaeger agent communication with the APM Server:

Expand Down
10 changes: 6 additions & 4 deletions solutions/observability/cloud/gcp-dataflow-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,20 +58,22 @@ You can optionally restrict the privileges of your API Key; otherwise they’ll

You’ll start with installing the Elastic GCP integration to add pre-built dashboards, ingest node configurations, and other assets that help you get the most of the GCP logs you ingest.

1. Find **Integrations** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Search for `gcp`.
1. Find **Integrations** in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Search for and select **Google Cloud Platform**.

:::{image} /solutions/images/observability-monitor-gcp-kibana-integrations.png
:alt: {{kib}} integrations
:::

3. Click the Elastic Google Cloud Platform (GCP) integration to see more details about it, then click **Add Google Cloud Platform (GCP)**.
3. If the integration's **Overview** page opens, click **Add Google Cloud Platform**.

:::{image} /solutions/images/observability-monitor-gcp-integration.png
:alt: GCP integration
:::

4. Click **Save integration**.
4. If the **Ready to add your first integration?** page opens, click **Add integration only (skip agent installation)**.
5. Click **Save and continue**.
6. In the dialog that opens, click **Add {{agent}} later**. The Dataflow template sends data directly to {{es}}, so you don't need to install {{agent}}.

## Step 2: Create a Pub/Sub topic and subscription [_step_2_create_a_pubsub_topic_and_subscription]

Expand Down
15 changes: 5 additions & 10 deletions solutions/observability/cloud/monitor-amazon-cloud-compute-ec2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,11 @@ To collect EC2 metrics, you typically need to install the Elastic [Amazon EC2 in
Expand the **quick guide** to learn how, or skip to the next section if your data is already in {{es}}.

:::::{dropdown} Quick guide: Add data
1. In the Observability UI, find **Integrations** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. In the query bar, search for and select the **Amazon EC2** integration.
3. Read the overview to make sure you understand integration requirements and other considerations.
4. Click **Add Amazon EC2**.

::::{tip}
If you’re installing an integration for the first time, you may be prompted to install {{agent}}. If you see this page, click **Add integration only (skip agent installation)**.
::::

5. Configure the integration name and optionally add a description. Make sure you configure all required settings.
1. Find **Integrations** in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Search for and select **Amazon EC2**.
3. If the integration's **Overview** page opens, click **Add Amazon EC2**.
4. If the **Ready to add your first integration?** page opens, click **Add integration only (skip agent installation)**.
5. Configure the integration name and optionally add a description.
6. Choose where to add the integration policy.

* If {{agent}} is not already deployed locally or on an EC2 instance, click **New hosts** and enter a name for the new agent policy.
Expand Down
15 changes: 5 additions & 10 deletions solutions/observability/cloud/monitor-amazon-kinesis-data-streams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,11 @@ To collect Kinesis data stream metrics from Amazon CloudWatch, you typically nee
Expand the **quick guide** to learn how, or skip to the next section if your data is already in {{es}}.

:::::{dropdown} Quick guide: Add data
1. In the Observability UI, find **Integrations** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. In the query bar, search for and select the **Amazon Kinesis Data Stream** integration.
3. Read the overview to make sure you understand integration requirements and other considerations.
4. Click **Add Amazon Kinesis Data Stream**.

::::{tip}
If you’re installing an integration for the first time, you may be prompted to install {{agent}}. If you see this page, click **Add integration only (skip agent installation)**.
::::

5. Configure the integration name and optionally add a description. Make sure you configure all required settings.
1. Find **Integrations** in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Search for and select **Amazon Kinesis Data Stream**.
3. If the integration's **Overview** page opens, click **Add Amazon Kinesis Data Stream**.
4. If the **Ready to add your first integration?** page opens, click **Add integration only (skip agent installation)**.
5. Configure the integration name and optionally add a description.
6. Choose where to add the integration policy.

* If {{agent}} is not already deployed locally or on an EC2 instance, click **New hosts** and enter a name for the new agent policy.
Expand Down
15 changes: 5 additions & 10 deletions solutions/observability/cloud/monitor-amazon-simple-queue-service-sqs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,11 @@ To collect SQS metrics, you typically need to install the Elastic [Amazon SQS in
Expand the **quick guide** to learn how, or skip to the next section if your data is already in {{es}}.

:::::{dropdown} Quick guide: Add data
1. In the Observability UI, find **Integrations** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. In the query bar, search for and select the **Amazon SQS** integration.
3. Read the overview to make sure you understand integration requirements and other considerations.
4. Click **Add Amazon SQS**.

::::{tip}
If you’re installing an integration for the first time, you may be prompted to install {{agent}}. If you see this page, click **Add integration only (skip agent installation)**.
::::

5. Configure the integration name and optionally add a description. Make sure you configure all required settings.
1. Find **Integrations** in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Search for and select **Amazon SQS**.
3. If the integration's **Overview** page opens, click **Add Amazon SQS**.
4. If the **Ready to add your first integration?** page opens, click **Add integration only (skip agent installation)**.
5. Configure the integration name and optionally add a description.
6. Choose where to add the integration policy.

* If {{agent}} is not already deployed locally or on an EC2 instance, click **New hosts** and enter a name for the new agent policy.
Expand Down
15 changes: 5 additions & 10 deletions solutions/observability/cloud/monitor-amazon-simple-storage-service-s3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,11 @@ To collect S3 metrics, you typically need to install the Elastic [Amazon S3 inte
Expand the **quick guide** to learn how, or skip to the next section if your data is already in {{es}}.

:::::{dropdown} Quick guide: Add data
1. In the Observability UI, find **Integrations** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. In the query bar, search for and select the **Amazon S3** integration.
3. Read the overview to make sure you understand integration requirements and other considerations.
4. Click **Add Amazon S3**.

::::{tip}
If you’re installing an integration for the first time, you may be prompted to install {{agent}}. If you see this page, click **Add integration only (skip agent installation)**.
::::

5. Configure the integration name and optionally add a description. Make sure you configure all required settings.
1. Find **Integrations** in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Search for and select **Amazon S3**.
3. If the integration's **Overview** page opens, click **Add Amazon S3**.
4. If the **Ready to add your first integration?** page opens, click **Add integration only (skip agent installation)**.
5. Configure the integration name and optionally add a description.
6. Choose where to add the integration policy.

* If {{agent}} is not already deployed locally or on an EC2 instance, click **New hosts** and enter a name for the new agent policy.
Expand Down
21 changes: 9 additions & 12 deletions ...tions/observability/cloud/monitor-amazon-web-services-aws-with-elastic-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,16 +124,13 @@ In this step, you install the AWS integration in {{kib}}. The AWS integration co

To add the integration:

1. Find **Integrations** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. In the query bar, search for **AWS** and select the AWS integration to see more details about it.
3. Click **Add AWS**.
4. Configure the integration name and optionally add a description.
1. Find **Integrations** in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Search for and select **AWS**.
3. If the integration's **Overview** page opens, click **Add AWS**.
4. If the **Ready to add your first integration?** page opens, click **Add integration only (skip agent installation)**.
5. Configure the integration name and optionally add a description.

::::{tip}
If you don’t see options for configuring the integration, you’re probably in a workflow designed for new deployments. Follow the steps, then return to this tutorial when you’re ready to configure the integration.
::::

5. Specify the AWS credentials required to connect to AWS and read log files. In this tutorial, we use an AWS access key ID and secret, but there are a few other ways to provide AWS credentials. To learn more, refer to the [AWS integration](https://docs.elastic.co/en/integrations/aws) documentation. The account you specify must have at least the following privileges:
6. Specify the AWS credentials required to connect to AWS and read log files. In this tutorial, we use an AWS access key ID and secret, but there are a few other ways to provide AWS credentials. To learn more, refer to the [AWS integration](https://docs.elastic.co/en/integrations/aws) documentation. The account you specify must have at least the following privileges:

```yaml
{
Expand All @@ -153,9 +150,9 @@ To add the integration:
}
```

6. Turn off all data collection selectors *except* **Collect VPC flow logs from S3**.
7. Change defaults and in the **Queue URL** field, specify the URL of the SQS queue you created earlier.
8. Click **Save and continue**. This step takes a minute or two to complete. When it’s done, you’ll have an agent policy that contains the AWS configuration you just specified.
7. Turn off all data collection selectors *except* **Collect VPC flow logs from S3**.
8. Change defaults and in the **Queue URL** field, specify the URL of the SQS queue you created earlier.
9. Click **Save and continue**. This step takes a minute or two to complete. When it’s done, you’ll have an agent policy that contains the AWS configuration you just specified.

A popup should appear that prompts you to **Add {{agent}} to your hosts**.

Expand Down
16 changes: 6 additions & 10 deletions solutions/observability/cloud/monitor-microsoft-azure-openai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,15 +161,11 @@ To add a role assignment to your app:

## Step 3: Configure the Azure OpenAI integration [azure-openai-configure-integration]

1. Find **Integrations** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. In the query bar, search for **Azure OpenAI** and select the Azure OpenAI integration card.
3. Click **Add Azure OpenAI**.
4. Under Integration settings, configure the integration name and optionally add a description.

::::{tip}
If you don’t have options for configuring the integration, you’re probably in a workflow designed for new deployments. Follow the steps, then return to this tutorial when you’re ready to configure the integration.
::::

1. Find **Integrations** in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Search for and select **Azure OpenAI**.
3. If the integration's **Overview** page opens, click **Add Azure OpenAI**.
4. If the **Ready to add your first integration?** page opens, click **Add integration only (skip agent installation)**.
5. Under Integration settings, configure the integration name and optionally add a description.


### Configure logs collection [azure-openai-configure-integration-logs]
Expand Down Expand Up @@ -292,7 +288,7 @@ For this tutorial, we’ll be using an [example Python application](https://gith

To start collecting {{product.apm}} data for your Azure OpenAI applications, gather the OpenTelemetry OTLP exporter endpoint and authentication header from the {{product.apm}} integration in {{kib}}:

1. Find **Integrations** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
1. Find **Integrations** in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Select the **APM** integration.
3. Scroll down to **APM Agents** and select the **OpenTelemetry** tab.
4. Make note of the configuration values for the following configuration settings:
Expand Down
Loading
Loading