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

Doc clarifications #2032

Merged
merged 2 commits into from
Mar 22, 2019
Merged

Doc clarifications #2032

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e71ba0
setup with extra args doesn't setup pipelines
jalvz Mar 20, 2019
78c0e2b
remove some confusing beats references from apm-server.yml
jalvz Mar 20, 2019
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
18 changes: 8 additions & 10 deletions _meta/beat.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ apm-server:
# Authorization token to be checked. If a token is set here the agents must
# send their token in the following format: Authorization: Bearer <secret-token>.
# It is recommended to use an authorization token in combination with SSL enabled,
# and save the token in the beats keystore.
# and save the token in the apm-server keystore.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this the is ok

#secret_token:

# Enable secure communication between APM agents and the server. By default ssl is disabled.
Expand Down Expand Up @@ -188,7 +188,7 @@ apm-server:
#setup.template.name: "apm-%{[observer.version]}"

# Template pattern. By default the template pattern is "apm-%{[observer.version]}-*" to apply to the default index settings.
# The first part is the version of the beat and then -* is used to match all daily indices.
# The first part is the version of apm-server and then -* is used to match all daily indices.
# The template name and pattern has to be set in case the elasticsearch index pattern is modified.
#setup.template.pattern: "apm-%{[observer.version]}-*"

Expand Down Expand Up @@ -230,7 +230,7 @@ apm-server:

#================================ Outputs =====================================

# Configure what output to use when sending the data collected by the beat.
# Configure what output to use when sending the data collected by apm-server.

#-------------------------- Elasticsearch output ------------------------------
output.elasticsearch:
Expand Down Expand Up @@ -551,8 +551,7 @@ output.elasticsearch:

# The number of times to retry publishing an event after a publishing failure.
# After the specified number of retries, the events are typically dropped.
# Some Beats, such as Filebeat, ignore the max_retries setting and retry until
# all events are published. Set max_retries to a value less than 0 to retry
# Set max_retries to a value less than 0 to retry
# until all events are published. The default is 3.
#max_retries: 3

Expand Down Expand Up @@ -656,9 +655,8 @@ output.elasticsearch:
# subdirectory inside the home path.
#path.data: ${path.home}/data

# The logs path for a apm-server installation. This is the default location for
# the Beat's log files. If not set by a CLI flag or in the configuration file,
# the default for the logs path is a logs subdirectory inside the home path.
# The logs path for an apm-server installation. If not set by a CLI flag or in the
# configuration file, the default is a logs subdirectory inside the home path.
#path.logs: ${path.home}/logs


Expand Down Expand Up @@ -724,7 +722,7 @@ output.elasticsearch:

#================================ HTTP Endpoint ======================================
#
# Each beat can expose internal metrics through a HTTP endpoint. For security
# apm-server can expose internal metrics through a HTTP endpoint. For security
# reasons the endpoint is disabled by default. This feature is currently experimental.
# Stats can be access through http://localhost:5066/stats . For pretty JSON output
# append ?pretty to the URL.
Expand Down Expand Up @@ -788,7 +786,7 @@ output.elasticsearch:
#bulk_max_size: 50

# The number of seconds to wait before trying to reconnect to Elasticsearch
# after a network error. After waiting backoff.init seconds, the Beat
# after a network error. After waiting backoff.init seconds, apm-server
# tries to reconnect. If the attempt fails, the backoff timer is increased
# exponentially up to backoff.max. After a successful connection, the backoff
# timer is reset. The default is 1s.
Expand Down
18 changes: 8 additions & 10 deletions apm-server.docker.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ apm-server:
# Authorization token to be checked. If a token is set here the agents must
# send their token in the following format: Authorization: Bearer <secret-token>.
# It is recommended to use an authorization token in combination with SSL enabled,
# and save the token in the beats keystore.
# and save the token in the apm-server keystore.
#secret_token:

# Enable secure communication between APM agents and the server. By default ssl is disabled.
Expand Down Expand Up @@ -188,7 +188,7 @@ apm-server:
#setup.template.name: "apm-%{[observer.version]}"

# Template pattern. By default the template pattern is "apm-%{[observer.version]}-*" to apply to the default index settings.
# The first part is the version of the beat and then -* is used to match all daily indices.
# The first part is the version of the apm-server and then -* is used to match all daily indices.
# The template name and pattern has to be set in case the elasticsearch index pattern is modified.
#setup.template.pattern: "apm-%{[observer.version]}-*"

Expand Down Expand Up @@ -230,7 +230,7 @@ apm-server:

#================================ Outputs =====================================

# Configure what output to use when sending the data collected by the beat.
# Configure what output to use when sending the data collected by the apm-server.

#-------------------------- Elasticsearch output ------------------------------
output.elasticsearch:
Expand Down Expand Up @@ -551,8 +551,7 @@ output.elasticsearch:

# The number of times to retry publishing an event after a publishing failure.
# After the specified number of retries, the events are typically dropped.
# Some Beats, such as Filebeat, ignore the max_retries setting and retry until
# all events are published. Set max_retries to a value less than 0 to retry
# Set max_retries to a value less than 0 to retry
# until all events are published. The default is 3.
#max_retries: 3

Expand Down Expand Up @@ -656,9 +655,8 @@ output.elasticsearch:
# subdirectory inside the home path.
#path.data: ${path.home}/data

# The logs path for a apm-server installation. This is the default location for
# the Beat's log files. If not set by a CLI flag or in the configuration file,
# the default for the logs path is a logs subdirectory inside the home path.
# The logs path for an apm-server installation. If not set by a CLI flag or in the
# configuration file, the default is a logs subdirectory inside the home path.
#path.logs: ${path.home}/logs


Expand Down Expand Up @@ -724,7 +722,7 @@ output.elasticsearch:

#================================ HTTP Endpoint ======================================
#
# Each beat can expose internal metrics through a HTTP endpoint. For security
# apm-server can expose internal metrics through a HTTP endpoint. For security
# reasons the endpoint is disabled by default. This feature is currently experimental.
# Stats can be access through http://localhost:5066/stats . For pretty JSON output
# append ?pretty to the URL.
Expand Down Expand Up @@ -788,7 +786,7 @@ output.elasticsearch:
#bulk_max_size: 50

# The number of seconds to wait before trying to reconnect to Elasticsearch
# after a network error. After waiting backoff.init seconds, the Beat
# after a network error. After waiting backoff.init seconds, apm-server
# tries to reconnect. If the attempt fails, the backoff timer is increased
# exponentially up to backoff.max. After a successful connection, the backoff
# timer is reset. The default is 1s.
Expand Down
18 changes: 8 additions & 10 deletions apm-server.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ apm-server:
# Authorization token to be checked. If a token is set here the agents must
# send their token in the following format: Authorization: Bearer <secret-token>.
# It is recommended to use an authorization token in combination with SSL enabled,
# and save the token in the beats keystore.
# and save the token in the apm-server keystore.
#secret_token:

# Enable secure communication between APM agents and the server. By default ssl is disabled.
Expand Down Expand Up @@ -188,7 +188,7 @@ apm-server:
#setup.template.name: "apm-%{[observer.version]}"

# Template pattern. By default the template pattern is "apm-%{[observer.version]}-*" to apply to the default index settings.
# The first part is the version of the beat and then -* is used to match all daily indices.
# The first part is the version of apm-server and then -* is used to match all daily indices.
# The template name and pattern has to be set in case the elasticsearch index pattern is modified.
#setup.template.pattern: "apm-%{[observer.version]}-*"

Expand Down Expand Up @@ -230,7 +230,7 @@ apm-server:

#================================ Outputs =====================================

# Configure what output to use when sending the data collected by the beat.
# Configure what output to use when sending the data collected by apm-server.

#-------------------------- Elasticsearch output ------------------------------
output.elasticsearch:
Expand Down Expand Up @@ -551,8 +551,7 @@ output.elasticsearch:

# The number of times to retry publishing an event after a publishing failure.
# After the specified number of retries, the events are typically dropped.
# Some Beats, such as Filebeat, ignore the max_retries setting and retry until
# all events are published. Set max_retries to a value less than 0 to retry
# Set max_retries to a value less than 0 to retry
# until all events are published. The default is 3.
#max_retries: 3

Expand Down Expand Up @@ -656,9 +655,8 @@ output.elasticsearch:
# subdirectory inside the home path.
#path.data: ${path.home}/data

# The logs path for a apm-server installation. This is the default location for
# the Beat's log files. If not set by a CLI flag or in the configuration file,
# the default for the logs path is a logs subdirectory inside the home path.
# The logs path for an apm-server installation. If not set by a CLI flag or in the
# configuration file, the default is a logs subdirectory inside the home path.
#path.logs: ${path.home}/logs


Expand Down Expand Up @@ -724,7 +722,7 @@ output.elasticsearch:

#================================ HTTP Endpoint ======================================
#
# Each beat can expose internal metrics through a HTTP endpoint. For security
# apm-server can expose internal metrics through a HTTP endpoint. For security
# reasons the endpoint is disabled by default. This feature is currently experimental.
# Stats can be access through http://localhost:5066/stats . For pretty JSON output
# append ?pretty to the URL.
Expand Down Expand Up @@ -788,7 +786,7 @@ output.elasticsearch:
#bulk_max_size: 50

# The number of seconds to wait before trying to reconnect to Elasticsearch
# after a network error. After waiting backoff.init seconds, the Beat
# after a network error. After waiting backoff.init seconds, apm-server
# tries to reconnect. If the attempt fails, the backoff timer is increased
# exponentially up to backoff.max. After a successful connection, the backoff
# timer is reset. The default is 1s.
Expand Down
2 changes: 1 addition & 1 deletion package-README.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ localhost first. After that, start APM Server with:
./{{.BeatName}} -c {{.BeatName}}.yml -e

This will start APM Server and send the data to your Elasticsearch instance. To
load the Elasticsearch template and pipelines for APM Server into Kibana, run:
load the Elasticsearch template for APM Server into Kibana, run:

./{{.BeatName}} setup -e

Expand Down