Skip to content

Commit

Permalink
Docs improvements (elastic#548)
Browse files Browse the repository at this point in the history
Major restructure. Adds many documents from beats that are applicable to APM Server.
  • Loading branch information
roncohen authored and Ron Cohen committed Feb 1, 2018
1 parent bdb48b9 commit c58150f
Show file tree
Hide file tree
Showing 33 changed files with 3,307 additions and 102 deletions.
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

0 comments on commit c58150f

Please sign in to comment.