Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/common-problems.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ This section describes common problems you might encounter with APM Server.

* <<no-data-indexed>>
* <<bad-request>>
* <<event-too-large>>
* <<unauthorized>>
* <<forbidden>>
* <<queue-full>>
Expand Down Expand Up @@ -51,7 +52,7 @@ As a result, Elasticsearch must be configured to allow {ref}/docs-index_.html#in
=== HTTP 400: Data decoding error / Data validation error

The most likely cause for this is that you are using incompatible versions of agent and APM Server.
For instance, APM Server 6.2.0 changed the Intake API spec and requires a minimum version of each agent.
For instance, APM Server 6.2 and 6.5 changed the Intake API spec and require a minimum version of each agent.

View the {apm-overview-ref-v}/agent-server-compatibility.html[agent/server compatibility matrix] for more information.

Expand Down
18 changes: 17 additions & 1 deletion docs/configuration-process.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,31 @@ Example config file:
["source","yaml"]
----
apm-server:
host: "localhost:8200"
hosts: ["localhost:8200"]
rum:
enabled: true

output:
elasticsearch:
hosts: ElasticsearchAddress:9200

queue.mem.events: 4096

max_procs: 4
----

NOTE: If you are using an X-Pack secured version of Elastic Stack,
you need to specify credentials in the config file before you run the commands that set up and start APM Server.
For example:

[source,yaml]
----
output.elasticsearch:
hosts: ["ElasticsearchAddress:9200"]
username: "elastic"
password: "elastic"
----

[float]
[[configuration-apm-server]]
=== Configuration options: `apm-server.*`
Expand Down
24 changes: 22 additions & 2 deletions docs/copied-from-beats/command-reference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@


// These attributes are used to resolve short descriptions
tag::attributes[]

:global-flags: Also see <<global-flags,Global flags>>.

Expand Down Expand Up @@ -47,6 +48,7 @@ endif::[]
:test-command-short-desc: Tests the configuration
:version-command-short-desc: Shows information about the current version

end::attributes[]

[[command-line-options]]
=== {beatname_uc} command reference
Expand Down Expand Up @@ -599,7 +601,7 @@ Or:
If index lifecycle management is enabled it also ensures that the defined ILM policy
and write alias are connected to the indices matching the index template.
The ILM policy takes care of the lifecycle of an index, when to do a rollover,
when to move an index from the hot phase to the next phase etc.
when to move an index from the hot phase to the next phase, etc.

ifndef::no_dashboards[]
* The {kib} dashboards make it easier for you to visualize {beatname_uc} data
Expand All @@ -611,11 +613,12 @@ ifdef::has_ml_jobs[]
necessary to analyze data for anomalies.
endif::[]

Use this command if you want to set up the environment without actually running
This command sets up the environment without actually running
{beatname_uc} and ingesting data.

*SYNOPSIS*

tag::setup-command-tag[]
["source","sh",subs="attributes"]
----
{beatname_lc} setup [FLAGS]
Expand Down Expand Up @@ -656,6 +659,11 @@ endif::[]
Sets up components related to Elasticsearch index management including
template, ILM policy, and write alias (if supported and configured).

ifdef::apm-server[]
*`--pipelines`*::
Registers the <<configuring-ingest-node,pipeline>> definitions set in `ingest/pipeline/definition.json`.
end::apm-server[]

*`--template`*::
deprecated:[7.2]
Sets up the index template only.
Expand Down Expand Up @@ -694,15 +702,27 @@ ifndef::no_dashboards[]
{beatname_lc} setup --index-management
-----
endif::no_dashboards[]

ifndef::apm-server[]
ifdef::no_dashboards[]
["source","sh",subs="attributes"]
-----
{beatname_lc} setup --machine-learning
{beatname_lc} setup --index-management
-----
endif::no_dashboards[]
endif::apm-server[]

ifdef::apm-server[]
["source","sh",subs="attributes"]
-----
{beatname_lc} setup --index-management
{beatname_lc} setup --pipelines
-----
endif::apm-server[]

endif::[]
end::setup-command-tag[]

[[test-command]]
==== `test` command
Expand Down
23 changes: 12 additions & 11 deletions docs/data-ingestion.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ This section explains how to adapt data ingestion according to your needs.
[[tune-apm-server]]
== Tune APM Server

Tuning topics:

* <<tune-output-config>>
* <<adjust-queue-size>>
* <<add-apm-server-instances>>
Expand Down Expand Up @@ -87,15 +85,18 @@ Increasing the <<event_rate.limit,`event_rate.limit`>> default value will help a
[[tune-es]]
== Tune Elasticsearch

Get insights about tuning the Elasticsearch ingestion rate,
especially with regards to
The Elasticsearch reference provides insight on tuning Elasticsearch.

{ref}/tune-for-indexing-speed.html[Tune for indexing speed] provides information on:

* refresh interval
* disable swapping
* optimizing filesystem cache
* considerations regarding faster hardware
* setting the indexing buffer size
* Refresh interval
* Disabling swapping
* Optimizing filesystem cache
* Considerations regarding faster hardware
* Setting the indexing buffer size

directly at the {ref}/tune-for-indexing-speed.html[Elasticsearch reference].
{ref}/tune-for-disk-usage.html[Tune for disk usage] provides information on:

You might also want to read up on how to {ref}/tune-for-disk-usage.html[tune for disk usage].
* Disabling unneeded features
* Shard size
* Shrink index
Loading