-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #152 from embrace-io/elastic-integration-docs
EMBR-5843 added elastic configuration
- Loading branch information
Showing
9 changed files
with
59 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
title: Elastic Integration | ||
description: Learn about the Embrace <> Elastic integration | ||
sidebar_position: 3 | ||
--- | ||
|
||
# Elastic Integration | ||
|
||
## Prerequisites | ||
|
||
- Have an active Elastic account | ||
- Have an [APM server setup](https://www.elastic.co/guide/en/fleet/7.15/fleet-quick-start-traces.html) (You may have a | ||
default APM integration setup already.) | ||
|
||
|
||
## Get Secret Token for APM | ||
If you have set a [secret token already](https://www.elastic.co/guide/server/current/secret-token.html) you can use that | ||
token. Otherwise, you can use the default token in your integration. The instructions below are for the default token. | ||
|
||
1. Click the hamburger menu to open the menu and select Management. | ||
1. Select Fleet, then Agent policies. You should see a default policy. | ||
1. Click into the default policy, and select the Elastic APM integration policy. | ||
1. Scroll down to the Agent authorization section and select the secret token. | ||
|
||
## Find Server URL | ||
If you have an APM server URL already configured you can use that. Otherwise, you can use the default server URL in your | ||
integration. The instructions below are for the default server URLs. | ||
|
||
1. Click the hamburger menu to open the menu and select Management. | ||
1. Select Fleet, then Agent policies. You should see a default policy. | ||
1. Click into the default policy, and select the Elastic APM integration policy. | ||
1. Select the APM Agents tab, and scroll down to the OpenTelemetry section. Use the value for the `OTEL_EXPORTER_OTLP_ENDPOINT`. | ||
|
||
## Create Elastic Data Destination | ||
|
||
1. Navigate to the [Data Destinations](https://dash.embrace.io/settings/organization/integrations/data_destinations) and select | ||
Add Data Destination. | ||
1. Select Elastic in the dropdown and the apps that you want to forward. | ||
1. Input the secret token and server URL. | ||
|
||
<img src={require('@site/static/images/data-destinations/elastic_config.png').default} alt="Image showing Elastic data destination form" width="50%"/> | ||
|
||
## Querying Your Metrics | ||
|
||
Your metrics will be prefixed with `embrace.`. You can visualize your data using the Dashboards view under the Analytics section of the hamburger menu. Below is a sample dashboard panel and the configuration for it. | ||
|
||
<img src={require('@site/static/images/data-destinations/elastic_metrics.png').default} alt="Image showing Elastic panel with metrics" width="50%"/> | ||
<img src={require('@site/static/images/data-destinations/elastic_metric_config.png').default} alt="Image showing Elastic panel configuration" width="30%" style={{"padding": "20px"}} /> | ||
|
||
## Querying Your Network Spans | ||
|
||
You can explore your forwarded spans under the APM page under the Observability section. You should see `embrace-trace-forwarder` | ||
as the service. | ||
|
||
<img src={require('@site/static/images/data-destinations/elastic_traces.png').default} alt="Image showing Traces in Elastic dashboard" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
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.