Skip to content

Commit d0e712f

Browse files
authored
docs: improve getting started experience (elastic#4222)
1 parent 705f48a commit d0e712f

28 files changed

+1210
-818
lines changed

guide/apm-breaking-changes.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This section discusses the changes that you need to be aware of when migrating y
1919
* <<breaking-6.5.0>>
2020
* <<breaking-6.4.0>>
2121

22-
Also see <<apm-release-notes>>.
22+
Also see <<whats-new>>.
2323

2424
//NOTE: The notable-breaking-changes tagged regions are re-used in the
2525
//Installation and Upgrade Guide

guide/apm-doc-directory.asciidoc

+12-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
[[components]]
2-
== Components and documentation
2+
=== Components and documentation
33

4-
Elastic APM consists of four components: *APM Agents*, *APM Server*, *Elasticsearch*, and *Kibana*.
4+
Elastic APM consists of four components: *APM agents*, *APM Server*, *Elasticsearch*, and *Kibana*.
55

66
image::images/apm-architecture-cloud.png[Architecture of Elastic APM]
77

88
[float]
9-
=== APM Agents
9+
==== APM Agents
1010

1111
APM agents are open source libraries written in the same language as your service.
1212
You may only need one, or you might use all of them.
@@ -20,12 +20,14 @@ Each agent has its own documentation:
2020
* {apm-java-ref-v}/intro.html[Java agent]
2121
* {apm-dotnet-ref-v}/intro.html[.NET agent]
2222
* {apm-node-ref-v}/intro.html[Node.js agent]
23+
// Uncomment PHP Agent when ready
24+
// * {apm-php-ref}/intro.html[PHP agent]
2325
* {apm-py-ref-v}/getting-started.html[Python agent]
2426
* {apm-ruby-ref-v}/introduction.html[Ruby agent]
2527
* {apm-rum-ref-v}/intro.html[JavaScript Real User Monitoring (RUM) agent]
2628

2729
[float]
28-
=== APM Server
30+
==== APM Server
2931

3032
APM Server is an open source application that receives performance data from your APM agents.
3133
It's a {apm-server-ref-v}/overview.html#why-separate-component[separate component by design],
@@ -34,7 +36,7 @@ which helps keep the agents light, prevents certain security risks, and improves
3436
After the APM Server has validated and processed events from the APM agents,
3537
the server transforms the data into Elasticsearch documents and stores them in corresponding
3638
{apm-server-ref-v}/exploring-es-data.html[Elasticsearch indices].
37-
In a matter of seconds you can start viewing your application performance data in the Kibana APM app.
39+
In a matter of seconds, you can start viewing your application performance data in the Kibana APM app.
3840

3941
The {apm-server-ref-v}/index.html[APM Server reference] provides everything you need when it comes to working with the server.
4042
Here you can learn more about {apm-server-ref-v}/getting-started-apm-server.html[installation],
@@ -43,14 +45,14 @@ Here you can learn more about {apm-server-ref-v}/getting-started-apm-server.html
4345
{apm-server-ref-v}/monitoring.html[monitoring], and more.
4446

4547
[float]
46-
=== Elasticsearch
48+
==== Elasticsearch
4749

4850
{ref}/index.html[Elasticsearch] is a highly scalable open source full-text search and analytics engine.
4951
It allows you to store, search, and analyze large volumes of data quickly and in near real time.
5052
Elasticsearch is used to store APM performance metrics and make use of its aggregations.
5153

5254
[float]
53-
=== Kibana APM app
55+
==== Kibana APM app
5456

5557
{kibana-ref}/index.html[Kibana] is an open source analytics and visualization platform designed to work with Elasticsearch.
5658
You use Kibana to search, view, and interact with data stored in Elasticsearch.
@@ -63,4 +65,6 @@ The following sections will help you get started:
6365
* {apm-app-ref}/apm-getting-started.html[Get started]
6466
* {apm-app-ref}/apm-how-to.html[How-to guides]
6567

66-
APM also has built-in integrations with Machine Learning. To learn more about this feature, refer to the Kibana documentation for {kibana-ref}/machine-learning-integration.html[Machine learning integration].
68+
APM also has built-in integrations with Machine learning. To learn more about this feature,
69+
or the anomaly detection feature that's built on top of it,
70+
refer to {kibana-ref}/machine-learning-integration.html[Machine learning integration].

0 commit comments

Comments
 (0)