Skip to content

Commit f8764ed

Browse files
authored
docs: update intro and file structure (#345)
1 parent df99876 commit f8764ed

File tree

3 files changed

+47
-28
lines changed

3 files changed

+47
-28
lines changed

docs/advanced-topics.asciidoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[[advanced-topics]]
2+
== Advanced Topics
3+
4+
* <<instrumenting-custom-code>>
5+
* <<sanitizing-data>>
6+
* <<run-tests-locally>>
7+
8+
include::./custom-instrumentation.asciidoc[Custom Instrumentation]
9+
include::./sanitizing-data.asciidoc[Sanitizing Data]
10+
include::./run-tests-locally.asciidoc[Run Tests Locally]

docs/getting-started.asciidoc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
[[getting-started]]
2+
3+
ifdef::env-github[]
4+
NOTE: For the best reading experience,
5+
please view this documentation at https://www.elastic.co/guide/en/apm/agent/python/current/getting-started.html[elastic.co]
6+
endif::[]
7+
8+
== Getting started
9+
10+
Welcome to the APM Python agent docs.
11+
12+
The Elastic APM Python agent sends performance metrics and error logs to the APM Server.
13+
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.
14+
15+
[float]
16+
[[additional-components]]
17+
=== Additional Components
18+
19+
APM Agents work in conjunction with the {apm-server-ref}/index.html[APM Server], {ref}/index.html[Elasticsearch], and {kibana-ref}/index.html[Kibana].
20+
Please view the {apm-get-started-ref}/index.html[APM Overview] for details on how these components work together.
21+
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.
29+
30+
NOTE: The Elastic APM Python agent does currently not support asynchronous frameworks like Twisted or Tornado.

docs/index.asciidoc

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,25 @@
1-
= APM Python Agent Reference
2-
31
:branch: current
42
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
53

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-
184
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]
207
endif::[]
218

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
2910

30-
NOTE: The Elastic APM Python agent does currently not support asynchronous frameworks like Twisted or Tornado.
11+
include::./getting-started.asciidoc[Getting Started]
3112

3213
include::./configuration.asciidoc[Configuration]
3314

3415
include::./django.asciidoc[Django support]
3516

3617
include::./flask.asciidoc[Flask support]
3718

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]
4320

4421
include::./api.asciidoc[API documentation]
22+
4523
include::./upgrading.asciidoc[Upgrading from previous versions]
24+
4625
include::./tuning.asciidoc[Tuning and Overhead considerations]

0 commit comments

Comments
 (0)