Skip to content

Commit

Permalink
posted an APM doc on how to instrument future enhancements
Browse files Browse the repository at this point in the history
  • Loading branch information
Ahil PonArul authored and Ahil PonArul committed Apr 29, 2020
1 parent d1cbcf5 commit d65eb20
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions src/APM.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Elastic APM

This application has been instrumented with Elastic APM.

In order to [configure](https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html) this application environment variables should be
used in the configMap of the `app.yaml` file.


Custom instrumentation begins in the main method in `st_app.py` with the call

```
client = Client()
client.begin_transaction('main_page')
```
and ends with `client.end_transaction('main_page')`

The sidebar menu and charts are instrumented with [custom instrumentations](https://www.elastic.co/guide/en/apm/agent/python/current/api.html).


The `display_sidebar` has its internal functions instrumented
with the `with` notation.

The `charts` and `display_header` are instrumented with the `annotation` method.

0 comments on commit d65eb20

Please sign in to comment.