Skip to content

docs: add tip/warning to labels #1030

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

Merged
merged 1 commit into from
Apr 29, 2019
Merged

docs: add tip/warning to labels #1030

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 19 additions & 2 deletions docs/agent-api.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,9 @@ If an error is captured,
the context from the active transaction is used as context for the captured error,
and any custom context given as the 2nd argument to <<apm-capture-error,`apm.captureError`>> takes precedence and is shallow merged on top.

TIP: Before using custom context, ensure you understand the different types of
{apm-overview-ref-v}/metadata.html[metadata] that are available.

[[apm-set-tag]]
==== `apm.setTag(name, value)`

Expand Down Expand Up @@ -235,7 +238,14 @@ You can set multiple labels on the same transaction.
If an error happens during the current transaction,
it will also get tagged with the same label.

Labels are key/value pairs that are indexed by Elasticsearch and therefore searchable (as opposed to data set via <<apm-set-custom-context,`apm.setCustomContext()`>>).
TIP: Labels are key/value pairs that are indexed by Elasticsearch and therefore searchable
(as opposed to data set via <<apm-set-custom-context,`apm.setCustomContext()`>>).
Before using custom labels, ensure you understand the different types of
{apm-overview-ref-v}/metadata.html[metadata] that are available.

WARNING: Avoid defining too many user-specified labels.
Defining too many unique fields in an index is a condition that can lead to a
{ref}/mapping.html#mapping-limit-settings[mapping explosion].

[[apm-add-tags]]
==== `apm.addTags({ [name]: value })`
Expand Down Expand Up @@ -280,7 +290,14 @@ You can add labels multiple times.
If an error happens during the current transaction,
it will also get tagged with the same labels.

Labels are key/value pairs that are indexed by Elasticsearch and therefore searchable (as opposed to data set via <<apm-set-custom-context,`apm.setCustomContext()`>>).
TIP: Labels are key/value pairs that are indexed by Elasticsearch and therefore searchable
(as opposed to data set via <<apm-set-custom-context,`apm.setCustomContext()`>>).
Before using custom labels, ensure you understand the different types of
{apm-overview-ref-v}/metadata.html[metadata] that are available.

WARNING: Avoid defining too many user-specified labels.
Defining too many unique fields in an index is a condition that can lead to a
{ref}/mapping.html#mapping-limit-settings[mapping explosion].

[[apm-capture-error]]
==== `apm.captureError(error[, options][, callback])`
Expand Down