Skip to content

Commit

Permalink
Merge pull request #152 from embrace-io/elastic-integration-docs
Browse files Browse the repository at this point in the history
EMBR-5843 added elastic configuration
  • Loading branch information
juansc authored Jan 10, 2025
2 parents b7449b7 + 127f3c1 commit 2eb8983
Show file tree
Hide file tree
Showing 9 changed files with 59 additions and 3 deletions.
55 changes: 55 additions & 0 deletions docs/data-destinations/elastic-setup.md
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" />
2 changes: 1 addition & 1 deletion docs/data-destinations/grafana-cloud-setup.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Grafana Cloud Integration
description: Learn about the Embrace <> Grafana Cloud integration
sidebar_position: 3
sidebar_position: 4
---

# Grafana Cloud Integration
Expand Down
2 changes: 1 addition & 1 deletion docs/data-destinations/honeycomb.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Honeycomb Integration
description: Learn about the Embrace <> Honeycomb integration
sidebar_position: 4
sidebar_position: 5
---

# Honeycomb Integration
Expand Down
1 change: 1 addition & 0 deletions docs/data-destinations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ cross-platform observability tool of choice:

* [Chronosphere integration guide](/data-destinations/chronosphere-setup.md)
* [Datadog integration guide](/data-destinations/data-dog-setup.md)
* [Elastic integration guide](/data-destinations/elastic-setup.md)
* [Grafana Cloud integration guide](/data-destinations/grafana-cloud-setup.md)
* [Grafana visualization suite integration guide](/embrace-api/grafana_integrations/)
* [Honeycomb integration guide](/data-destinations/honeycomb.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/react-native/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ This could be due to one of the following reasons:
* Akamai
* Cloudflare
* PacketZoom
* You are using an Axios version that is not compatible with us or you have a custom integration that block us. You can force log the Axios request appying our [interceptor](https://github.com/embrace-io/embrace-react-native-sdk/blob/v5.2.0/packages/core/src/networkInterceptors/ApplyInterceptor.ts).
* You are using an Axios version that is not compatible with us or you have a custom integration that block us. You can force log the Axios request appying our [interceptor](https://github.com/embrace-io/embrace-react-native-sdk/blob/v5.2.0/packages/core/src/networkInterceptors/ApplyInterceptor.ts).
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.

0 comments on commit 2eb8983

Please sign in to comment.