Skip to content

Commit

Permalink
[docs] Documentation changes from APM Server (elastic#13292)
Browse files Browse the repository at this point in the history
  • Loading branch information
bmorelli25 authored Aug 23, 2019
1 parent ab7b732 commit bdd4c79
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 6 deletions.
7 changes: 6 additions & 1 deletion libbeat/docs/monitoring/monitoring-beats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@
--

You can use the {stack} {monitor-features} to gain insight into the health of
{beatname_uc} agents running in your environment.
ifndef::apm-server[]
{beatname_uc} instances running in your environment.
endif::[]
ifdef::apm-server[]
{beatname_uc}.
endif::[]

To monitor {beatname_uc}, make sure monitoring is enabled on your {es} cluster,
then configure the method used to collect {beatname_uc} metrics. You
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,11 @@ that are part of the monitoring cluster.

ifndef::serverless[]
. <<{beatname_lc}-starting,Start {beatname_uc}>>.
endif::serverless[]
endif::[]

ifdef::serverless[]
. <<{beatname_lc}-deploying,Deploy {beatname_uc}>>.
endif::serverless[]
endif::[]

. {kibana-ref}/monitoring-data.html[View the monitoring data in {kib}].

Expand Down
13 changes: 10 additions & 3 deletions libbeat/docs/monitoring/monitoring-metricbeat.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ For more information, see

ifndef::serverless[]
. <<{beatname_lc}-starting,Start {beatname_uc}>>.
endif::serverless[]
endif::[]

[float]
[[configure-metricbeat]]
Expand All @@ -108,7 +108,6 @@ locations.
endif::[]

. Enable the `beat-xpack` module in {metricbeat}. +
endif::[]
+
--
// tag::enable-beat-module[]
Expand Down Expand Up @@ -153,7 +152,15 @@ By default, the module collects {beatname_uc} monitoring data from
`localhost:5066`. If you exposed the metrics on a different host or port when
you enabled the HTTP endpoint, update the `hosts` setting.

To monitor multiple {beats} agents, specify a list of hosts, for example:
To monitor multiple
ifndef::apm-server[]
{beats} agents,
endif::[]
ifdef::apm-server[]
APM Server instances,
endif::[]
specify a list of hosts, for example:

[source,yaml]
----------------------------------
hosts: ["http://localhost:5066","http://localhost:5067","http://localhost:5068"]
Expand Down
5 changes: 5 additions & 0 deletions libbeat/docs/outputconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -498,6 +498,9 @@ output.elasticsearch:
With this configuration, all events with `processor.event: transaction` are sent to a pipeline
named `transaction_pipeline`. Similarly, all events with `processor.event: error` are sent to a
pipeline named `error_pipeline`.

The default pipeline is `apm`. It adds user agent and geo ip information to events.
To disable this, or any other pipeline, set `output.elasticsearch.pipeline: _none`.
endif::apm-server[]

TIP: To learn how to add custom fields to events, see the
Expand Down Expand Up @@ -632,6 +635,8 @@ output.elasticsearch:
With this configuration, all events with `processor.event: transaction` are sent to a pipeline
named `transaction_pipeline`, all events with `processor.event: error` are sent to a
pipeline named `error_pipeline`, etc.

NOTE: Defining any pipeline will deactivate the default `apm` pipeline.
endif::apm-server[]

For more information about ingest node pipelines, see
Expand Down
2 changes: 2 additions & 0 deletions libbeat/docs/security/users.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,8 @@ data:

|`kibana_user` and `apm_user`
|Use the APM UI
|`admin`
|Read and update APM Agent configuration via Kibana
|====
endif::apm-server[]

Expand Down

0 comments on commit bdd4c79

Please sign in to comment.