Commit f33e4c80 authored by Antoine Cotten's avatar Antoine Cotten

APM extension: update path to apm-server config

Closes #411
parent afdb99c2
# APM Server extension # APM Server extension
Adds a container for Elasticsearch APM server. Forwards caught errors and traces to Elasticsearch Adds a container for Elasticsearch APM server. Forwards caught errors and traces to Elasticsearch to enable their
server that can be viewed in Kibana. visualisation in Kibana.
## Usage ## Usage
If you want to include the APM server, run Docker compose from the root of If you want to include the APM server, run Docker Compose from the root of the repository with an additional command
the repository with an additional command line argument referencing the `apm-server-compose.yml` file: line argument referencing the `apm-server-compose.yml` file:
```bash ```console
$ docker-compose -f docker-compose.yml -f extensions/apm-server/apm-server-compose.yml up $ docker-compose -f docker-compose.yml -f extensions/apm-server/apm-server-compose.yml up
``` ```
## Connecting an agent to APM-Server ## Connecting an agent to APM-Server
The most basic configuration to send traces to apm server. Is to specify the The most basic configuration to send traces to APM server is to specify the `SERVICE_NAME` and `SERVICE_URL`. Here is an
`SERVICE_NAME` and `SERVICE_URL`. Here is an example Python FLASK configuration: example Python FLASK configuration:
```python ```python
import elasticapm import elasticapm
...@@ -36,19 +36,19 @@ app.config['ELASTIC_APM'] = { ...@@ -36,19 +36,19 @@ app.config['ELASTIC_APM'] = {
} }
``` ```
More configuration setting can be found under the **Configuration** More configuration settings can be found under the **Configuration** section for each language:
section for each language. Link: https://www.elastic.co/guide/en/apm/agent/index.html https://www.elastic.co/guide/en/apm/agent/index.html
## Checking Connectivity and Importing default APM Dashboards ## Checking connectivity and importing default APM dashboards
From Kibana main window press: From the Kibana Dashboard:
1. `Add APM` button under Add Data to Kibana section 1. `Add APM` button under _Add Data to Kibana_ section
2. Ignore all the install instructions and press `Check APM Server status` button. 2. Ignore all the install instructions and press `Check APM Server status` button.
3. Press `Check agent status` 3. Press `Check agent status`
4. Press `Load Kibana objects` to get the default dashboards 4. Press `Load Kibana objects` to get the default dashboards
5. Lastly press the `APM dashboard` to the bottom right. 5. Lastly press the `APM dashboard` to the bottom right.
## APM Agent Documentation ## See also
Link: https://www.elastic.co/guide/en/apm/agent/index.html [Running APM Server on Docker](https://www.elastic.co/guide/en/apm/server/current/running-on-docker.html)
...@@ -7,7 +7,7 @@ services: ...@@ -7,7 +7,7 @@ services:
args: args:
ELK_VERSION: $ELK_VERSION ELK_VERSION: $ELK_VERSION
volumes: volumes:
- ./extensions/apm-server/config/apm-server.yml:/usr/share/apm-server/config/apm-server.yml:ro - ./extensions/apm-server/config/apm-server.yml:/usr/share/apm-server/apm-server.yml:ro
ports: ports:
- "8200:8200" - "8200:8200"
networks: networks:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment