elastic / apm-contrib

Contrib repository for Elastic APM

Elastic APM Contrib

This repository includes contributions for Elastic APM.

What we do…

Project	Repo	Docs	Contrib
APM Server	apm-server	📘 elastic.co	📂 contrib
APM UI	apm-ui	📘 elastic.co	📂 contrib
Android Agent (🚧 In Development)	apm-agent-android	📘 elastic.co	📂 contrib
Go Agent	apm-agent-go	📘 elastic.co	📂 contrib
iOS Agent (🚧 In Development)	apm-agent-ios	📘 elastic.co	📂 contrib
Java Agent	apm-agent-java	📘 elastic.co	📂 contrib
JavaScript RUM Agent	apm-agent-rum-js	📘 elastic.co	📂 contrib
.NET Agent	apm-agent-dotnet	📘 elastic.co	📂 contrib
Node.js Agent	apm-agent-nodejs	📘 elastic.co	📂 contrib
PHP Agent	apm-agent-php	📘 elastic.co	📂 contrib
Python Agent	apm-agent-python	📘 elastic.co	📂 contrib
Ruby Agent	apm-agent-ruby	📘 elastic.co	📂 contrib

APM Contrib Repository

This is a collection of code and recipes to be used in conjunction with Elastic APM. The code here is not necessarily maintained by the core Elastic APM Team.

Contributing

All contributions are welcome: recipes, visualizations, dashboards, ingest processors, ideas, documentation, and even something you drew up on a napkin.

For more information about contributing, see the relevant CONTRIBUTING file:

• APM Server
• APM UI
• Android Agent
• Go Agent
• iOS Agent
• Java Agent
• JavaScript RUM Agent
• .NET Agent
• Node.js Agent
• PHP Agent
• Python Agent
• Ruby Agent

Community Developed Agents

The following agents are developed and maintained by members of the community.

Project	Repo	Docs	Notes
Meteor Agent	kschingiz/meteor-elastic-apm	📘 README

apm-contrib's Issues

get warning when import error.json in 7.x folder(stack version 7.1.0)

Hi, when I import the dashboard error.json and transaction.json from apm-contrib/apm-ui/7.x/ folder. The APM pops up with below error.

Saved "field" parameter is now invalid. Please select a new field.

stack version:
ES: 7.1.0
Kibana: 7.1.0
APM: 7.1.0

[APM] APM Dashboards and Visualizations Break when apm-* is not Default Index Pattern and Auto Refresh On

Kibana version: 6.6.0, 6.5.1, 6.5.4 (tested)

Elasticsearch version: 6.6.0, 6.5.1, 6.5.4 (tested)

Server OS version: MacOS and Ubuntu 18.04.1

Browser version: Chrome Version 71.0.3578.98 (Official Build) (64-bit)

Browser OS version: macOS 10.14.1 (18B75)

Original install method (e.g. download page, yum, from source, etc.):
Docker on Mac
.deb on Ubuntu

Describe the bug:
When the apm-* index pattern is not selected as the default index patterns AND Auto Refresh is On the APM Dashboards and Visualizations break and respond with “No data to display for the selected metrics .“ or simply are missing the data.
Examples:
Dashboard / [APM] Services
Dashboard / [APM] Transactions
Visualize / Transaction Per Minute [APM]

Steps to reproduce:

1. Install Elasticsearch, Kibana, and APM Server and properly configure so they all communicate.

2. Load Kibana APM Dashboards.

3. Install a client APM Application and Generate and Send APM Data

For Quick setup of all this you can use this docker-compose
https://gist.github.com/bvader/9665fa7b3bd69457517e41a7c28b4725

And this for the application. It is a Java Spring Boot App.
https://gist.github.com/bvader/cc9fea7e6f8f709dfa2ad14776eed7fe

3. Load other data and create another index pattern. Example install another beat e.g. metricbeat or filebeat and properly configure, setup and start this should create another index pattern... or you can just create your own new data and index pattern manually.

4. Set the Default Index Pattern to a pattern other than apm-*

5. Navigate to an APM Dashboard or Visualization such as Dashboard / [APM] Services
   Set the Time Frame to Last 15 Minutes
   Set Auto Refresh to 5 sec.

6. Observe when first refresh occurs that “No data to display for the selected metrics .“ message is displayed for Dashboard / [APM] Services

7. If you select another dashboard such as Dashboard / [APM] Transaction you will just see no data reported / flat line where the data should be.

8. Go back and set apm-* as the default and navigate back to the Dashboards and observe the Dashboards and visualizations work correctly.

Expected behavior:
The APM Dashboards and APM Visualization should properly display the visualizations / data with automatic refresh on when apm-* is not selected as the Default Index Pattern.

Screenshots (if relevant):

Dashboard / [APM] Services
apm-* is set as Default Index Pattern and Auto Refresh On

Dashboard / [APM] Services
apm-* is not set as Default Index Pattern and Auto Refresh On

Dashboard / [APM] Transactions
apm-* is set as Default Index Pattern and Auto Refresh On

Dashboard / [APM] Transactions
apm-* is not set as Default Index Pattern and Auto Refresh On

Errors in browser console (if relevant):

Provide logs and/or server output (if relevant):

Any additional context:

[Dashboards 7.x] Problems loading visualizations for Services, Errors and Transactions dashboards

I haven't problems on some of the 7.x dashboards, where certain visualizations don't load.

Services

Errors

Transactions

cc @bmorelli25 @graphaelli

Update APM UI dashboards to support 7.0+ (ECS changes)

We'll need to update the added dashboards with support for 7.0+ due to the ECS changes. Not sure if the right approach is to have versions for 6.x and 7.x?

Java agent dashboard doesn't work with 7.0

Unfortunately, the dashboards don't work with version 7.0 of the stack. Possibly due to ECS changes. context.service.agent is now just "agent.name"

Test results: Load dashboards from apm-contrib. 7.x viz will only show 7.x data

In this test we have to check that the data show in the apm-contrib dashboards for the 7.x version only show 7.x data.

Test steps

• Prepare a couple of Docker compose files one for 6.6.1 and another for 7.0.0-rc1, to make it I have used the integration test tool compose.py
  • Run ./script/compose.py start 6.6.1 --release --with-agent-go-net-http then docker-compose -f docker-compose.yml stop
  • Rename docker-compose.yml file to docker-compose-6.6.1.yml
  • Run ./script/compose.py start 7.0.0-rc1 --bc --with-agent-go-net-http then docker-compose -f docker-compose.yml stop
  • Rename docker-compose.yml file to docker-compose-7.0.0-rc1.yml
  • edit the files to use the same Docker volume
    • Change `"path.data=/usr/share/elasticsearch/data/6.6.1" to "path.data=/usr/share/elasticsearch/data/esdata" on docker-compose-6.6.1.yml
    • Change `"path.data=/usr/share/elasticsearch/data/7.0.0" to "path.data=/usr/share/elasticsearch/data/esdata" on docker-compose-7.0.0-rc1.yml
• Start 6.6.1 docker-compose -f docker-compose-6.6.1.yml up -d
• Configure APM
• Generate some data accesing to http://localhost:8080/foo-6.6.1, http://localhost:8080/foo, and http://localhost:8080/oof
• Check that the data is show in the APM UI
• Stop 6.6.1 docker-compose -f docker-compose-6.6.0.yml stop
• Wait a couple of minutes to have a time gap between the data
• Start 7.0.0-rc1 docker-compose -f docker-compose-7.0.0-rc1.yml up -d
• Generate some data accesing to http://localhost:8080/foo-7.0.0-rc1, http://localhost:8080/foo, and http://localhost:8080/oof
• Download the dashboards from https://github.com/elastic/apm-contrib/tree/master/apm-ui/7.x
• Import the dashboard on kibana
• Check that the data show in the dashboards is only from 7.0.0-rc1 version

Issues found

• On 7.0.0-rc1, when I go to Discover it said that some shards failed and I see a bunch of the following error in the logs, the solution it is to remove the index pattern and create it again.

{"type": "server", "timestamp": "2019-03-22T10:51:24,993+0000", "level": "DEBUG", "component": "o.e.a.s.TransportSearchAction", "cluster.name": "docker-cluster", "node.name": "c95aab0bc3f6", "cluster.uuid": "uH43uCTXQNKZmC3BLzyVnw", "node.id": "Ps0q-MrPR26LYNUsgy-dag",  "message": "[2053] Failed to execute fetch phase" , 
"stacktrace": ["org.elasticsearch.transport.RemoteTransportException: [c95aab0bc3f6][172.31.0.2:9300][indices:data/read/search[phase/fetch/id]]",
"Caused by: org.elasticsearch.script.ScriptException: runtime error",
"at org.elasticsearch.painless.PainlessScript.convertToScriptException(PainlessScript.java:94) ~[?:?]",
"at org.elasticsearch.painless.PainlessScript$Script.execute(doc['context.service.name'].value:28) ~[?:?]",
"at org.elasticsearch.search.fetch.subphase.ScriptFieldsFetchSubPhase.hitsExecute(ScriptFieldsFetchSubPhase.java:67) ~[elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.search.fetch.FetchPhase.execute(FetchPhase.java:177) ~[elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.search.SearchService.lambda$executeFetchPhase$3(SearchService.java:539) ~[elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.search.SearchService$3.doRun(SearchService.java:379) [elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.common.util.concurrent.AbstractRunnable.run(AbstractRunnable.java:37) [elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.common.util.concurrent.TimedRunnable.doRun(TimedRunnable.java:41) [elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.common.util.concurrent.ThreadContext$ContextPreservingAbstractRunnable.doRun(ThreadContext.java:751) [elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.common.util.concurrent.AbstractRunnable.run(AbstractRunnable.java:37) [elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128) [?:?]",
"at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628) [?:?]",
"at java.lang.Thread.run(Thread.java:834) [?:?]",
"Caused by: java.lang.IllegalArgumentException: No field found for [context.service.name] in mapping with types []",
"at org.elasticsearch.search.lookup.LeafDocLookup.get(LeafDocLookup.java:94) ~[elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.search.lookup.LeafDocLookup.get(LeafDocLookup.java:41) ~[elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.painless.PainlessScript$Script.execute(doc['context.service.name'].value:5) ~[?:?]",
"at org.elasticsearch.search.fetch.subphase.ScriptFieldsFetchSubPhase.hitsExecute(ScriptFieldsFetchSubPhase.java:67) ~[elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.search.fetch.FetchPhase.execute(FetchPhase.java:177) ~[elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.search.SearchService.lambda$executeFetchPhase$3(SearchService.java:539) ~[elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.search.SearchService$3.doRun(SearchService.java:379) ~[elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.common.util.concurrent.AbstractRunnable.run(AbstractRunnable.java:37) ~[elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.common.util.concurrent.TimedRunnable.doRun(TimedRunnable.java:41) ~[elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.common.util.concurrent.ThreadContext$ContextPreservingAbstractRunnable.doRun(ThreadContext.java:751) ~[elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at org.elasticsearch.common.util.concurrent.AbstractRunnable.run(AbstractRunnable.java:37) ~[elasticsearch-7.0.0-rc1.jar:7.0.0-rc1]",
"at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128) ~[?:?]",
"at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628) ~[?:?]",
"at java.lang.Thread.run(Thread.java:834) ~[?:?]"] }

• APM Error Details shows data from 6.6.1
  
• APM Errors shows data from 6.6.1
  
• APM Span Details shows data from 6.6.1
  
• APM Transactions shows data from 6.6.1
  

Dashboards without issues

APM Services show the proper data

Why can't import *.json related files on my local cluster?

cluster: 7.17.3

The file agent-versions.ndjson was successfully imported, other json files failed.

The resource path I am using:
kibana

Add Meteor apm agent

Hi, I have developed meteor elastic agent. Will be happy to see it in this list:
https://github.com/kschingiz/meteor-elastic-apm/

Thanks!

APM7.2.0 dashboard and virtualization

Hi since APM7.2.0 is released. Do we have dashboard and virtualization created for the JVM metrics?

PHP Agent Supports v2 API

Dears,

There is a PHP agent that only supports v1 API for the APM server,

I asked the maintainer about his plan regarding v2 support, but I think that he may be busy for now, and currently, so we decided to fork it, and just do some updates that make it support v2 API,

here is the package https://github.com/speakol-ads/elastic-apm-php-agent also, we forked the laravel agent that depends on it and updated it, you can find it here https://github.com/speakol-ads/elastic-apm-laravel

We just wanted to help the php community, if you have any recommendation before adding the mentioned packages in your list, just ping me, and also what are the steps required to list them here?

Can't import Node.js Runtime Metrics Dashboard in latest Kibana snapshot

If I try to import nodejs-runtime-metrics-7.x.json from apm-agent-nodejs/dashboards, in the current master snapshot of Kibana, I get the following import error: