Span Description Documentation

This page contains documentation for known span descriptions. You can use this documentation to understand how to create the sentry.description attribute for a span, when you have the span's other attributes.

Generating Descriptions

Span descriptions are generated via string template. Each span category of work has a set of templates for the span description. Curly brackets in the template indicate that the contents inside the curly brackets should be replaced with the contents of the span attribute of the name within the brackets.

The templates should be evaluated in order of appearance. Every template references at least one attribute.

Example

Given template:

  1. {{db.query.text}}

And attribute db.query.text = "SELECT * FROM users WHERE id = ?":

Result: "SELECT * FROM users WHERE id = ?"

Browser

Cache

Operations

Operations that interact with a cache, such as reading or writing cached values.

Affected ops

cachecache.getcache.putcache.remove

Templates

  1. {{cache.key}}

Examples

my-cache-key

Database

Queries

Operations that act on the data in a database. Includes operations like fetching, updating, and deleting records. Does not include operations like connecting to the database server.

Affected ops

dbdb.querydb.sql.querydb.sql.prismadb.sql.active_recorddb.sql.executedb.sql.roomdb.sql.transactiondb.redisredis

Templates

  1. {{db.query.text}}

Examples

SELECT * FROM users WHERE id = ?

HTTP

Queue

Queue

Operations that represent working with message queues, including publishing, receiving, processing, and settling messages.

Affected ops

queuequeue.publishqueue.createqueue.receivequeue.processqueue.settle

Examples

order-events

Resource

Resources

Loading of resources in the browser.

Affected ops

resourceresource.scriptresource.cssresource.linkresource.imgresource.audioresource.videoresource.iframeresource.other

Templates

  1. {{url.full}}

Examples

https://example.com/static/app.js