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

Navigation timing

A phase of the browser's navigation timing for a document load.

Affected ops

browser.cachebrowser.dnsbrowser.connectbrowser.tls_sslbrowser.redirectbrowser.requestbrowser.responsebrowser.unload_eventbrowser.dom_content_loaded_eventbrowser.load_event

Examples

http://example.com/users/123/users/123

Paint

A paint timing entry reported by the browser.

Affected ops

browser.paint

Examples

first-paintfirst-contentful-paint

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

Examples

SELECT * FROM users WHERE id = ?

Function

Function execution

The execution of a function or a set of instructions that isn't covered by a more specific operation.

Affected ops

function

Examples

server_requesthandleSubmit

Generative AI

Inference

Generative AI inference operations. Requests to a generative AI model to perform some unit of work (e.g., autocomplete, translation, chat completion, response to a query).

Affected ops

gen_aigen_ai.chatgen_ai.embeddingsgen_ai.generate_contentgen_ai.rerankgen_ai.responsesgen_ai.text_completion

Examples

chat gpt-4responses gpt-4otext_completion gpt-3.5-turbo-instructgenerate_content gemini-2.0-flash-001embeddings text-embedding-3-smallchat

GraphQL

HTTP

Model Context Protocol (MCP)

Notification

MCP notifications. One-way messages exchanged between an MCP client and server that do not expect a response.

Affected ops

mcp.notification.client_to_servermcp.notification.server_to_client

Examples

notifications/initializednotifications/cancellednotifications/progress

Queue

Queue

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

Affected ops

queuequeue.publishqueue.createqueue.receivequeue.processqueue.settlequeue.submit.arqqueue.task.arqqueue.submit.celeryqueue.task.celeryqueue.task.dramatiqqueue.submit.hueyqueue.task.hueyqueue.task.rq

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

Routing

Serverless (FAAS)

Web server