|
1 | | -= APM Python Agent Reference |
2 | | - |
3 | 1 | :branch: current |
4 | 2 | include::{asciidoc-dir}/../../shared/attributes.asciidoc[] |
5 | 3 |
|
6 | | -[[getting-started]] |
7 | | -== Getting started |
8 | | - |
9 | | -Welcome to the APM Python agent docs. |
10 | | - |
11 | | -The Elastic APM Python agent sends performance metrics and error logs to the APM Server. |
12 | | -It has built-in support for Django and Flask performance metrics and error logging, as well as generic support of other WSGI frameworks for error logging. |
13 | | -The agent is only one of multiple components you need to get started with APM. Please also have a look at the documentation for |
14 | | - |
15 | | - * {apm-server-ref}/index.html[APM Server] |
16 | | - * {ref}/index.html[Elasticsearch] |
17 | | - |
18 | 4 | ifdef::env-github[] |
19 | | -NOTE: For the best reading experience, please head over to this document at https://www.elastic.co/guide/en/apm/agent/python/current/index.html[elastic.co] |
| 5 | +NOTE: For the best reading experience, |
| 6 | +please view this documentation at https://www.elastic.co/guide/en/apm/agent/python/current/index.html[elastic.co] |
20 | 7 | endif::[] |
21 | 8 |
|
22 | | -[[framework-support]] |
23 | | -The Elastic APM Python Agent comes with support for the following frameworks: |
24 | | - |
25 | | - * <<django-support,Django>> 1.8 - 2.1 |
26 | | - * <<flask-support,Flask>> 0.10+ |
27 | | - |
28 | | -For other frameworks and custom Python code, the agent exposes a set of <<api,APIs>> for integration. |
| 9 | += APM Python Agent Reference |
29 | 10 |
|
30 | | -NOTE: The Elastic APM Python agent does currently not support asynchronous frameworks like Twisted or Tornado. |
| 11 | +include::./getting-started.asciidoc[Getting Started] |
31 | 12 |
|
32 | 13 | include::./configuration.asciidoc[Configuration] |
33 | 14 |
|
34 | 15 | include::./django.asciidoc[Django support] |
35 | 16 |
|
36 | 17 | include::./flask.asciidoc[Flask support] |
37 | 18 |
|
38 | | -[[advanced-topics]] |
39 | | -== Advanced Topics |
40 | | -include::./custom-instrumentation.asciidoc[Custom Instrumentation] |
41 | | -include::./sanitizing-data.asciidoc[Sanitizing Data] |
42 | | -include::./run-tests-locally.asciidoc[Run Tests Locally] |
| 19 | +include::./advanced-topics.asciidoc[Advanced Topics] |
43 | 20 |
|
44 | 21 | include::./api.asciidoc[API documentation] |
| 22 | + |
45 | 23 | include::./upgrading.asciidoc[Upgrading from previous versions] |
| 24 | + |
46 | 25 | include::./tuning.asciidoc[Tuning and Overhead considerations] |
0 commit comments