Metadata
editMetadata
editMetadata can enrich your events and make application performance monitoring even more useful. Let’s explore the different types of metadata that Elastic APM offers.
Labels
editLabels add indexed information to transactions, spans, and errors. Indexed means the data is searchable and aggregatable in Elasticsearch. Add additional key-value pairs to define multiple labels.
- Indexed: Yes
- Elasticsearch type: object
-
Elasticsearch field:
labels - Applies to: Transactions | Spans | Errors
Label values can be a string, boolean, or number, although some agents only support string values at this time.
Because labels for a given key, regardless of agent used, are stored in the same place in Elasticsearch,
all label values of a given key must have the same data type.
Multiple data types per key will throw an exception, for example: {foo: bar} and {foo: 42} is not allowed.
Avoid defining too many user-specified labels. Defining too many unique fields in an index is a condition that can lead to a mapping explosion.
-
Go:
SetLabel -
Java:
setLabel -
.NET:
SetLabel -
Node.js:
setLabel|addLabels -
PHP:
TransactionsetLabel|SpansetLabel -
Python:
elasticapm.label() -
Ruby:
set_label -
Rum:
addLabels
Custom context
editCustom context adds non-indexed, custom contextual information to transactions and errors. Non-indexed means the data is not searchable or aggregatable in Elasticsearch, and you cannot build dashboards on top of the data. This also means you don’t have to worry about mapping explosions, as these fields are not added to the mapping.
Non-indexed information is useful for providing contextual information to help you quickly debug performance issues or errors.
- Indexed: No
- Elasticsearch type: object
-
Elasticsearch fields:
transaction.custom|error.custom - Applies to: Transactions | Errors
Setting a circular object, a large object, or a non JSON serializable object can lead to errors.
-
Go:
SetCustom - iOS: coming soon
-
Java:
addCustomContext - .NET: coming soon
-
Node.js:
setCustomContext - PHP: coming soon
-
Python:
set_custom_context -
Ruby:
set_custom_context -
Rum:
setCustomContext
User context
editUser context adds indexed user information to transactions and errors. Indexed means the data is searchable and aggregatable in Elasticsearch.
- Indexed: Yes
- Elasticsearch type: keyword
-
Elasticsearch fields:
user.email|user.name|user.id - Applies to: Transactions | Errors
-
Go:
SetUsername|SetUserID|SetUserEmail - iOS: coming soon
-
Java:
setUser - .NET coming soon
-
Node.js:
setUserContext - PHP: coming soon
-
Python:
set_user_context -
Ruby:
set_user -
Rum:
setUserContext