Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cherry-pick to 7.x: docs: Update beats for APM (#20881) #20907

Merged
merged 1 commit into from
Sep 8, 2020
Merged

Cherry-pick to 7.x: docs: Update beats for APM (#20881) #20907

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions libbeat/docs/howto/load-index-templates.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{es} uses {ref}/indices-templates.html[index templates] to define:

* Settings that control the behavior of your indices. The settings include the
lifecycle policy used to manage indices as they grow and age.
lifecycle policy used to manage indices as they grow and age.
* Mappings that determine how fields are analyzed. Each mapping sets the
{ref}/mapping-types.html[{es} datatype] to use for a specific data field.

Expand All @@ -17,7 +17,7 @@ it's not overwritten unless you configure {beatname_uc} to do so.
ifndef::no-output-logstash[]
NOTE: A connection to {es} is required to load the index template. If
the output is not {es} (or {ess}), you must
<<load-template-manually,load the template manually>>.
<<load-template-manually,load the template manually>>.
endif::[]

This page shows how to change the default template loading behavior to:
Expand Down Expand Up @@ -83,9 +83,10 @@ The examples here assume that Logstash output is enabled.
endif::[]
You can omit the `-E` flags if {es} output is already enabled.


ifndef::apm-server[]
If you are connecting to a secured {es} cluster, make sure you've
configured credentials as described in the <<{beatname_lc}-installation-configuration>>.
endif::[]

If the host running {beatname_uc} does not have direct connectivity to
{es}, see <<load-template-manually-alternate>>.
Expand Down
8 changes: 5 additions & 3 deletions libbeat/docs/shared/configuring-intro.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@

ifndef::apm-server[]
TIP: To get started quickly, read <<{beatname_lc}-installation-configuration>>.
endif::[]

To configure {beatname_uc}, edit the configuration file. The default
configuration file is called +{beatname_lc}.yml+. The location of the file
varies by platform. To locate the file, see <<directory-layout>>.
varies by platform. To locate the file, see <<directory-layout>>.

ifeval::["{beatname_lc}"!="apm-server"]
There’s also a full example configuration file called +{beatname_lc}.reference.yml+
ifndef::apm-server[]
There’s also a full example configuration file called +{beatname_lc}.reference.yml+
that shows all non-deprecated options.
endif::[]

Expand Down