diff --git a/extensions/apm-server/README.md b/extensions/apm-server/README.md index e8364da..77a7510 100644 --- a/extensions/apm-server/README.md +++ b/extensions/apm-server/README.md @@ -1,21 +1,21 @@ # APM Server extension -Adds a container for Elasticsearch APM server. Forwards caught errors and traces to Elasticsearch -server that can be viewed in Kibana. +Adds a container for Elasticsearch APM server. Forwards caught errors and traces to Elasticsearch to enable their +visualisation in Kibana. ## Usage -If you want to include the APM server, run Docker compose from the root of -the repository with an additional command line argument referencing the `apm-server-compose.yml` file: - -```bash +If you want to include the APM server, run Docker Compose from the root of the repository with an additional command +line argument referencing the `apm-server-compose.yml` file: + +```console $ docker-compose -f docker-compose.yml -f extensions/apm-server/apm-server-compose.yml up ``` ## Connecting an agent to APM-Server -The most basic configuration to send traces to apm server. Is to specify the -`SERVICE_NAME` and `SERVICE_URL`. Here is an example Python FLASK configuration: +The most basic configuration to send traces to APM server is to specify the `SERVICE_NAME` and `SERVICE_URL`. Here is an +example Python FLASK configuration: ```python import elasticapm @@ -36,19 +36,19 @@ app.config['ELASTIC_APM'] = { } ``` -More configuration setting can be found under the **Configuration** -section for each language. Link: https://www.elastic.co/guide/en/apm/agent/index.html +More configuration settings can be found under the **Configuration** section for each language: +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. 3. Press `Check agent status` 4. Press `Load Kibana objects` to get the default dashboards 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) diff --git a/extensions/apm-server/apm-server-compose.yml b/extensions/apm-server/apm-server-compose.yml index 9881314..b7bb09c 100644 --- a/extensions/apm-server/apm-server-compose.yml +++ b/extensions/apm-server/apm-server-compose.yml @@ -7,7 +7,7 @@ services: args: ELK_VERSION: $ELK_VERSION 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: - "8200:8200" networks: