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][7.2] doc backports #2213

Merged
merged 11 commits into from
May 24, 2019
2 changes: 1 addition & 1 deletion _beats/script/build_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/copied-from-beats/outputconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down
11 changes: 11 additions & 0 deletions docs/guide/apm-data-model.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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, metadata>>.
Metadata can be indexed - <<labels-fields,`labels`>>, or not-indexed - <<custom-fields,`custom`>>.

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.

Expand Down
8 changes: 4 additions & 4 deletions docs/guide/apm-release-notes.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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>>
* <<release-highlights-7.0.0>>
* <<release-notes-6.8.0>>
* <<release-highlights-6.8.0>>
* <<release-notes-6.7.0>>
* <<release-notes-6.6.0>>
* <<release-notes-6.5.0>>
* <<release-notes-6.4.1>>
* <<release-notes-6.4.0>>

[[release-notes-7.1.0]]
[[release-highlights-7.1.0]]
=== APM version 7.1.0

No new features.
Expand All @@ -37,7 +37,7 @@ See <<breaking-7.0.0>>

* Added support for frozen indices.

[[release-notes-6.8.0]]
[[release-highlights-6.8.0]]
=== APM version 6.8.0

No new features.
Expand Down
4 changes: 4 additions & 0 deletions docs/setting-up-and-running.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ To start APM Server, run:
./apm-server -e
----------------------------------

NOTE: The `-e` <<global-flags,global flag>> 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 <<running-with-systemd,APM Server status and logs>>.

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:
Expand Down