Tagging traces can help you enrich the data collected as part of the trace for two main reasons:
- To pinpoint a specific event in our application.
- To detect trends based on a unique-business dimension.
Tagging adds more context to an existing trace in the form of key=value. For example, we can add the following tag: userId=123. In this scenario, we will be able to filter all traces that matched a specific user in our application. These are some good tags that can be used:
| Type | Description |
|---|---|
| Identifiers | Help us to pinpoint an event based on our application unique identifiers. For example user ID, customer ID, item ID, etc. |
| Flow control | Help us understand what happened in the code. For example, event type, item category, etc. |
| Business metrics | Help us to understand some unique business KPIs. For example, the quantity of items in cart, minutes watched, etc |
Tags use cases
Tags help us in the following scenarios:
- Correlate incidents and customers – Looking for a problem that happened to a specific user/customer in our application.
- Insights into the customer experience – Understanding the performance metrics of a specific event in our system.
- Business trends – Looking at trends for business KPIs.
Tagging in Epsagon
Tagging can be done simply by calling the following snippet in your code:
epsagon.label('key', 'value')
For example with an Express.js application, you can tag your user ID:
router.get('/test', (req, res, next) => {
req.epsagon.label('userId', req.query.userId)
res.send('success')
})
Once your application generates traces with the new tag, you'll be able to see it in the Trace View, under Labels:
Indexing custom tags
You can configure Epsagon to index additional tags from your traces, even ones that are inside nested JSON payloads. This will allow you to search traces and create alerts based on your own custom tags.
For example, you may have a trace of an SNS message where the message itself is a JSON object, and you are interested in indexing the user field, like so:
- To index custom tags, click Index Tags, and select the tag you want to be indexed.
- To manage custom indexed tags, go to Custom Indexed Tags.
Once you added an indexed tag, Epsagon will search your payloads for those tags, and index them in addition to other tags within a few minutes. Once a trace with the new tag is sent, you will be able to filter it via the trace search page:
Updated 4 days ago