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.

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

Docs improvements #548

Merged
merged 31 commits into from
Feb 1, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
24713c0
WIP on docs improvements
Jan 25, 2018
c59568b
Moved some sections around and updated with more generic beats docs
Jan 25, 2018
45fa77b
Add missing files dashboards and template-config.
Jan 25, 2018
f5eb1cd
-inging headlines like before.
Jan 25, 2018
d00e155
Update TOC for Configuring APM Server
Jan 25, 2018
518a9d9
Updated following https://github.com/elastic/beats/pull/6184/commits/…
Jan 26, 2018
3ef09a6
Added "setting up and running" to the overview TOC.
Jan 26, 2018
9a8a6d1
Updated following https://github.com/elastic/beats/pull/6186/commits/…
Jan 26, 2018
d228c8d
Updated command reference following https://github.com/elastic/beats/…
Jan 26, 2018
7f5cedd
Update SSL settings headline
Jan 26, 2018
764b69c
Updated template config following a beats update
Jan 26, 2018
63f5379
Logging config update.
Jan 26, 2018
1aab0ef
Use specific beat name in shared-kibana-config.asciidoc
Jan 26, 2018
bebc104
Add html_docs to .gitignore
Jan 30, 2018
294aeee
Add .\ for PS instruction and make it possible to remove logstash men…
Jan 31, 2018
bbfa6da
Switch kibana endpoint and kibana conf around
Jan 31, 2018
a0a482a
Introduce 'has_ml_jobs'.
Jan 31, 2018
86bb134
Less blamy text, removed 6.0 note, links to the correct place now
Jan 31, 2018
a405c89
better output config text for elasticsearch
Jan 31, 2018
7bb506d
Better wording in configuration.
Jan 31, 2018
08401f8
Only talk about Filebeat for filebeat docs
Jan 31, 2018
295b4f2
Fix list in output config
Jan 31, 2018
d55da13
It's 'warn', not 'warning'. Found by @simitt
Jan 31, 2018
3766314
Update the rest of the max_retries sections to only talk about Filebe…
Jan 31, 2018
0b79cce
Special case for apm-server as it was only introduced in 6.0
Jan 31, 2018
d3eeada
Missing double quotes caused build to fail.
Feb 1, 2018
0e5d9cf
Moved Frontend support under Configuring + more restructure.
Feb 1, 2018
2fedfbf
Add intake-api back in.
Feb 1, 2018
1bd0e7d
Removing "beta release" header.
Feb 1, 2018
222618d
Revert changes related to warn vs warning
Feb 1, 2018
0facb0f
Remove page header files
Feb 1, 2018
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@
/fields.yml
/apm-server.template-es.json

html_docs
72 changes: 30 additions & 42 deletions docs/configuring.asciidoc
Original file line number Diff line number Diff line change
@@ -1,56 +1,44 @@
[[configuring]]
== Configuring and running APM Server
[[configuring-howto-apm-server]]
= Configuring APM Server

In a production environment,
you would put APM Server on its own machines,
similar to how you run Elasticsearch.
You _can_ run it on the same machines as Elasticsearch,
but this is not recommended,
as the processes will be competing for resources.
[partintro]
--
include::./copied-from-beats/shared-configuring.asciidoc[]

To start APM Server, run:
The following topics describe how to configure APM Server:

[source,bash]
----------------------------------
./apm-server -e
----------------------------------
* <<configuring-output>>
* <<configuration-ssl>>
* <<configuration-template>>
* <<configuration-logging>>
* <<setup-kibana-endpoint>>
* <<configuration-dashboards>>
* <<frontend>>
* <<using-environ-vars>>
* <<configuration-path>>
--

You should see APM Server start up.
It will try to connect to Elasticsearch on localhost port 9200 and expose an API to agents on port 8200.
You can change the defaults by supplying a different address on the command line:
:only-elasticsearch:
:no-pipeline:
include::./copied-from-beats/outputconfig.asciidoc[]

[source,bash]
----------------------------------
./apm-server -e -E output.elasticsearch.hosts=ElasticsearchAddress:9200 -E apm-server.host=localhost:8200
----------------------------------
include::./copied-from-beats/shared-ssl-config.asciidoc[]

Or you can update the `apm-server.yml` configuration file to change the defaults.
include::./template-config.asciidoc[]

[source,yaml]
----------------------------------
apm-server:
host: localhost:8200
include::./copied-from-beats/loggingconfig.asciidoc[]

output:
elasticsearch:
hosts: ElasticsearchAddress:9200
----------------------------------
include::./copied-from-beats/shared-kibana-config.asciidoc[]

include::./copied-from-beats/dashboardsconfig.asciidoc[]

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:
include::./frontend.asciidoc[]

:standalone:
include::./copied-from-beats/shared-env-vars.asciidoc[]

include::./copied-from-beats/shared-path-config.asciidoc[]

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

See https://github.com/elastic/apm-server/blob/{doc-branch}/apm-server.reference.yml[`apm-server.reference.yml`] for more configuration options.

include::./security.asciidoc[]

include::./high-availability.asciidoc[]
2 changes: 1 addition & 1 deletion docs/context.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[float]
==== Context
=== Context
An event's context bundles information regarding the environment in which it is recorded.
It describes the `service` in which the event is captured,
the `system` in which the monitored service is running and the event's `process` information.
Expand Down
Loading