From fa9f9af0d9edc9d3e436554854a48aa562cc12a6 Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Fri, 24 May 2019 10:26:37 -0700 Subject: [PATCH] [docs][7.2] doc backports (#2213) --- _beats/script/build_docs.sh | 2 +- docs/copied-from-beats/outputconfig.asciidoc | 2 +- docs/guide/apm-data-model.asciidoc | 11 +++++++++++ docs/guide/apm-release-notes.asciidoc | 8 ++++---- docs/setting-up-and-running.asciidoc | 4 ++++ 5 files changed, 21 insertions(+), 6 deletions(-) diff --git a/_beats/script/build_docs.sh b/_beats/script/build_docs.sh index b085233911e..3224b2c710c 100755 --- a/_beats/script/build_docs.sh +++ b/_beats/script/build_docs.sh @@ -37,5 +37,5 @@ do params="$params --resource=${resource_dir}" fi - $docs_dir/build_docs.pl $params --doc "$index" -out "$dest_dir" + $docs_dir/build_docs $params --doc "$index" --out "$dest_dir" done diff --git a/docs/copied-from-beats/outputconfig.asciidoc b/docs/copied-from-beats/outputconfig.asciidoc index ad5de7eb79f..8f1742a9588 100644 --- a/docs/copied-from-beats/outputconfig.asciidoc +++ b/docs/copied-from-beats/outputconfig.asciidoc @@ -79,7 +79,7 @@ output.elasticsearch: If the Elasticsearch nodes are defined by `IP:PORT`, then add `protocol: https` to the yaml file. -["source","yaml",subs="attributes,callouts"] +[source,yaml] ------------------------------------------------------------------------------ output.elasticsearch: hosts: ["localhost"] diff --git a/docs/guide/apm-data-model.asciidoc b/docs/guide/apm-data-model.asciidoc index f352b3bbc5a..87b495d52de 100644 --- a/docs/guide/apm-data-model.asciidoc +++ b/docs/guide/apm-data-model.asciidoc @@ -97,6 +97,17 @@ which are points in time relative to the start of the transaction with some labe In addition, agents provide options for users to capture custom <>. Metadata can be indexed - <>, or not-indexed - <>. +Transactions are grouped by their `type` and `name` in the APM UI's +{kibana-ref}/transactions.html[Transaction overview]. +If you're using a supported framework, APM agents will automatically handle the naming for you. +If you're not, or if you wish to override the default, +all agents have API methods to manually set the `type` and `name`. + +* `type` should be a keyword of specific relevance in the service's domain, +e.g. `request`, `backgroundjob`, etc. +* `name` should be a generic designation of a transaction in the scope of a single service, +e.g. `GET /users/:id`, `UsersController#show`, etc. + TIP: Most agents limit keyword fields (e.g. `labels`) to 1024 characters, non-keyword fields (e.g. `span.db.statement`) to 10,000 characters. diff --git a/docs/guide/apm-release-notes.asciidoc b/docs/guide/apm-release-notes.asciidoc index a3de1d74d3c..3c9bb13eb7a 100644 --- a/docs/guide/apm-release-notes.asciidoc +++ b/docs/guide/apm-release-notes.asciidoc @@ -7,16 +7,16 @@ For a full list of changes, see the {apm-server-ref-v}/release-notes.html[APM Server Release Notes] or the {kibana-ref}/release-notes.html[Kibana Release Notes]. -* <> +* <> * <> -* <> +* <> * <> * <> * <> * <> * <> -[[release-notes-7.1.0]] +[[release-highlights-7.1.0]] === APM version 7.1.0 No new features. @@ -37,7 +37,7 @@ See <> * Added support for frozen indices. -[[release-notes-6.8.0]] +[[release-highlights-6.8.0]] === APM version 6.8.0 No new features. diff --git a/docs/setting-up-and-running.asciidoc b/docs/setting-up-and-running.asciidoc index 5a66e04fdde..95327a8e200 100644 --- a/docs/setting-up-and-running.asciidoc +++ b/docs/setting-up-and-running.asciidoc @@ -16,6 +16,10 @@ To start APM Server, run: ./apm-server -e ---------------------------------- +NOTE: The `-e` <> enables logging to stderr and disables syslog/file output. +Remove this flag if you've enabled logging in the configuration file. +For linux systems, see <>. + 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: