Skip to content
This repository was archived by the owner on Aug 14, 2024. It is now read-only.

feat: Add span data for db.system and cache.hit #917

Merged
merged 1 commit into from
Apr 26, 2023
Merged

feat: Add span data for db.system and cache.hit #917

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
40 changes: 26 additions & 14 deletions src/docs/sdk/performance/span-data-conventions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Keys on the `data` field should be lower-case and use underscores instead of cam

Below describes the conventions for the Span interface for the `data` field on the span that are currently used by the product or are important to bring up.

## General
## HTTP

| Attribute | Type | Description | Examples |
| --------------- | ------ | ------------------------------------ | --------------------- |
| `http.query` | string | The Query string present in the URL. | `?foo=bar&bar=baz` |
| `http.fragment` | string | The Fragments present in the URL. | `#foo=bar` |
| Attribute | Type | Description | Examples |
| --------------- | ------ | ------------------------------------ | ------------------ |
| `http.query` | string | The Query string present in the URL. | `?foo=bar&bar=baz` |
| `http.fragment` | string | The Fragments present in the URL. | `#foo=bar` |

## Mobile

Expand All @@ -26,12 +26,24 @@ Below describes the conventions for the Span interface for the `data` field on t

## Browser

| Attribute | Type | Description | Examples |
| ---------------------------------- | ------ | ------------------------------------------- | --------------------- |
| `url` | string | The URL of the resource that was fetched. | `https://example.com` |
| `method` | string | The HTTP method used. | `GET` |
| `type` | string | The type of the resource that was fetched. | `xhr` |
| `Encoded Body Size` | number | The encoded body size of the request. | `123` |
| `Decoded Body Size` | number | The decoded body size of the request. | `456` |
| `Transfer Size` | number | The transfer size of the request. | `789` |
| `resource.render_blocking_status` | string | The render blocking status of the resource. | `non-blocking` |
| Attribute | Type | Description | Examples |
| --------------------------------- | ------ | ------------------------------------------- | --------------------- |
| `url` | string | The URL of the resource that was fetched. | `https://example.com` |
| `method` | string | The HTTP method used. | `GET` |
| `type` | string | The type of the resource that was fetched. | `xhr` |
| `Encoded Body Size` | number | The encoded body size of the request. | `123` |
| `Decoded Body Size` | number | The decoded body size of the request. | `456` |
| `Transfer Size` | number | The transfer size of the request. | `789` |
| `resource.render_blocking_status` | string | The render blocking status of the resource. | `non-blocking` |

## Database

| Attribute | Type | Description | Examples |
| ----------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| `db.system` | string | An identifier for the database management system (DBMS) product being used. See [OpenTelemetry docs for a list of well-known identifiers](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md#notes-and-well-known-identifiers-for-dbsystem). | `postgresql` |

## Web Server

| Attribute | Type | Description | Examples |
| ----------- | ------- | -------------------------------------- | -------- |
| `cache.hit` | boolean | If the cache was hit during this span. | `true` |