You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/concepts/key-terms/key-terms.mdx
+13-9
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,21 @@
1
1
---
2
-
title: Key Terms
2
+
title: Key Terms & Features
3
3
sidebar_order: 05
4
-
description: "Learn about the key concepts and features of Sentry."
4
+
description: "A few key terms and features to help you get a better understanding of Sentry."
5
5
---
6
6
7
-
These key terms and concepts are the fundamentals of Sentry. While we define new terms as you come across them throughout our documentation, having an understanding of the key concepts and features here will make it easier to learn more complex ideas about the product.
7
+
Some of the bellow terms have corresponding features with the same name (in upper case) in the [Key Features](#key-features) section.
8
8
9
-
## Key Concepts
10
-
11
-
Some of the following key concepts have corresponding features with the same name listed (in upper case) in the [Key Features](#key-features) section.
9
+
## Key Terms
12
10
13
11
-**alerts** - Alerts let you know about problems with your code in real-time by sending you notifications when certain alert rule conditions are met. There are several types of alerts available with customizable thresholds and integrations.
14
12
15
13
-**attachments** - Stored additional files, such as config or log files that are related to an error event.
16
14
17
15
-**data** - Anything you send to Sentry. This includes, events (errors or transactions), attachments, and event metadata.
18
16
17
+
-**distributed trace** - When a trace includes work in multiple services, it's called a [distributed trace](/concepts/key-terms/tracing/distributed-tracing/), because the trace is distributed across those services.
18
+
19
19
-**DSN** - Data Source Name. A DSN tells the Sentry SDK where to send events so the events are associated with the correct project. Sentry automatically assigns you a DSN when you create a project. Learn more in our full [DSN documentation](/product/sentry-basics/dsn-explainer/).
20
20
21
21
-**environment** - `environment` is a Sentry-supported tag that you can add to your SDK that's intended to refer to your code deployments' naming convention, such as _development_, _testing_, _staging_, or _production_. Environments help you better filter issues and transactions among other uses. Learn more in our full [Environments documentation](/product/sentry-basics/environments/).
@@ -38,23 +38,27 @@ Some of the following key concepts have corresponding features with the same nam
38
38
39
39
-**Sentry SDKs** - Sentry's programming language/framework-specific libraries for application monitoring. When you add one of our SDKs to your application, event data from your application is captured and sent to Sentry, so we can provide you with error and performance reports.
40
40
41
+
-**span** - A [span](/concepts/key-terms/tracing/distributed-tracing/#traces-transactions-and-spans) is the basic unit that traces are composed of. Multiple groups of parent-child spans make up a trace in Sentry and share a trace_id, which can help you get to the root cause of a problem faster.
42
+
41
43
-**team** - Teams are associated with your Sentry projects, and their members receive issue notifications as a group. Learn more about [setting up teams](/organization/getting-started/#2-set-up-teams).
42
44
45
+
-**trace** - A [trace](/concepts/key-terms/tracing/) is the record of the entire operation you want to measure or track - like page load, an instance of a user completing some action in your application, or a cron job in your backend.
46
+
43
47
-**transaction** - A transaction represents a single instance of a service being called to support an operation you want to measure or track, like a page load, page navigation, or asynchronous task. Transaction events are grouped by the transaction name.
44
48
45
49
## Key Features
46
50
47
-
Each of these key features in [sentry.io](https://sentry.io) is represented by a page (or set of pages) in the application.
51
+
Each of these key features have their own page (or set of pages) in the[sentry.io](https://sentry.io) application.
48
52
49
53
-**Alerts** - Where you can create new alert rules and manage existing ones. Learn more in the full [Alerts documentation](/product/alerts/).
50
54
51
55
-**Dashboards** - Provide you with a broad overview of your application’s health by allowing you to navigate through error and performance data across multiple projects. Dashboards are made up of one or more widgets, and each widget visualizes one or more **Discover** or **Issues** queries. Learn more in the full [Dashboards documentation](/product/dashboards/).
52
56
53
-
-**Discover** - Allows you to query events across environments, providing you with visibility into your errors and transactions and unlocking insights into the health of your entire system. The **Discover** page visualizes the results of queries. Learn more in the full [Discover documentation](/product/discover-queries/).
57
+
-**Discover** - Allows you to query events across environments, providing you with visibility into your errors and transactions and unlocking insights into the health of your entire system. The **Discover** page visualizes the results of queries. Learn more in the full [Discover documentation](/product/explore/discover-queries/).
54
58
55
59
-**Issues** - Displays information about grouped problems in your application. From here, you can go to the **Issue Details** page for a more granular view of any issue. Learn more in the full [Issues documentation](/product/issues/).
56
60
57
-
-**Performance** - The main view in [sentry.io](http://sentry.io) where you can search or browse for transaction data. The page displays graphs that visualize transactions or trends, as well as a table where you can view relevant transactions and drill down to more information about them. Learn more in the full [Performance documentation](/product/performance/).
61
+
-**Performance** - The main view in [sentry.io](http://sentry.io) where you can search or browse for transaction data. The page displays graphs that visualize transactions or trends, as well as a table where you can view relevant transactions and drill down to more information about them. Learn more in the full [Tracing documentation](/product/performance/).
58
62
59
63
-**Projects** - Lists the projects of which you're a member, by team, and provides you with a high-level overview of your projects. From here, you can go to the **Project Details** page of each project for a more granular view. Learn more in the full [Projects documentation](/product/projects/).
Copy file name to clipboardExpand all lines: docs/concepts/key-terms/tracing/distributed-tracing.mdx
+6-5
Original file line number
Diff line number
Diff line change
@@ -184,12 +184,13 @@ The majority of the data in a transaction resides in the individual spans the tr
184
184
-`op`: short string identifying the type or category of operation the span is measuring. Details on the structure of span operations can be [found in the Sentry developer documentation](https://develop.sentry.dev/sdk/performance/span-operations/).
185
185
-`start_timestamp`: when the span was opened
186
186
-`end_timestamp`: when the span was closed
187
-
-`description`: longer description of the span's operation, which uniquely identifies the span but is consistent across instances of the span (optional)
188
-
-`status`: short code indicating operation's status (optional)
189
-
-`tags`: key-value pairs holding additional data about the span (optional)
190
-
-`data`: arbitrarily-structured additional data about the span (optional)
187
+
-`description`: longer description of the span's operation, which uniquely identifies the span but is consistent across instances of the span
188
+
-`status`: short code indicating operation's status
189
+
-`tags`: key-value pairs holding additional data about the span
190
+
-`data`: arbitrarily-structured additional data about the span
191
191
192
192
An example use of the `op` and `description` properties together is `op: db.query` and `description: SELECT * FROM users WHERE last_active < %s`. The `status` property is often used to indicate the success or failure of the span's operation, or for a response code in the case of HTTP requests. Finally, `tags` and `data` allow you to attach further contextual information to the span, such as `function: middleware.auth.is_authenticated` for a function call or `request: {url: ..., headers: ... , body: ...}` for an HTTP request.
193
+
To search span data see [Searchable Properties](/concepts/search/searchable-properties/spans/)
193
194
194
195
### Important Information About Tracing, Spans & Transactions
195
196
@@ -249,4 +250,4 @@ Dynamic sampling ensures complete traces by retaining all transactions associate
249
250
250
251
## Viewing Trace Data
251
252
252
-
Through [Performance](/product/performance/) and [Discover](/product/discover-queries/), you can view trace data in the [Trace Details](/concepts/key-terms/tracing/trace-view/) page.
253
+
Through [Performance](/product/performance/) and [Discover](/product/explore/discover-queries/), you can view trace data in the [Trace Details](/concepts/key-terms/tracing/trace-view/) page.
Copy file name to clipboardExpand all lines: docs/concepts/search/index.mdx
+1-1
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,7 @@ Here are some examples of valid comparison operator searches:
50
50
51
51
<Note>
52
52
53
-
`OR` and `AND` search conditions are only available for [Discover](/product/discover-queries/), [Performance](/product/performance/), and [Metric Alerts](/product/alerts-notifications/metric-alerts/).
53
+
`OR` and `AND` search conditions are only available for [Discover](/product/explore/discover-queries/), [Performance](/product/performance/), and [Metric Alerts](/product/alerts-notifications/metric-alerts/).
Copy file name to clipboardExpand all lines: docs/concepts/search/searchable-properties/events.mdx
+12-11
Original file line number
Diff line number
Diff line change
@@ -342,43 +342,43 @@ Returns results with a matching maximum value for the field entered.
342
342
343
343
### `measurements.app_start_cold`
344
344
345
-
A [cold start](/product/performance/mobile-vitals/#app-start) refers to when the app launches for the first time after a reboot or update. The app is not in memory and no process exists.
345
+
A [cold start](/product/insights/mobile-vitals/#app-start) refers to when the app launches for the first time after a reboot or update. The app is not in memory and no process exists.
346
346
347
347
-**Type:** duration
348
348
349
349
### `measurements.app_start_warm`
350
350
351
-
A [warm start](/product/performance/mobile-vitals/#app-start) refers to when the app has already launched at least once and is partially in memory. For instance, the user backs out of your app, but then re-launches it. The process may have continued to run, but the app must recreate the activity from scratch.
351
+
A [warm start](/product/insights/mobile-vitals/#app-start) refers to when the app has already launched at least once and is partially in memory. For instance, the user backs out of your app, but then re-launches it. The process may have continued to run, but the app must recreate the activity from scratch.
352
352
353
353
-**Type:** duration
354
354
355
355
### `measurements.cls`
356
356
357
-
[Cumulative Layout Shift (CLS)](/product/performance/web-vitals/web-vitals-concepts/#cumulative-layout-shift-cls) is the sum of individual layout shift scores for every unexpected element shift during the rendering process.
357
+
[Cumulative Layout Shift (CLS)](/product/insights/web-vitals/web-vitals-concepts/#cumulative-layout-shift-cls) is the sum of individual layout shift scores for every unexpected element shift during the rendering process.
358
358
359
359
-**Type:** number
360
360
361
361
### `measurements.fcp`
362
362
363
-
[First Contentful Paint (FCP)](/product/performance/web-vitals/web-vitals-concepts/#first-contentful-paint-fcp) measures the time for the first content to render in the viewport.
363
+
[First Contentful Paint (FCP)](/product/insights/web-vitals/web-vitals-concepts/#first-contentful-paint-fcp) measures the time for the first content to render in the viewport.
364
364
365
365
-**Type:** duration
366
366
367
367
### `measurements.fid`
368
368
369
-
[First Input Delay (FID)](/product/performance/web-vitals/web-vitals-concepts/#first-input-delay-fid) measures the response time when the user tries to interact with the viewport.
369
+
[First Input Delay (FID)](/product/insights/web-vitals/web-vitals-concepts/#first-input-delay-fid) measures the response time when the user tries to interact with the viewport.
370
370
371
371
-**Type:** duration
372
372
373
373
### `measurements.fp`
374
374
375
-
[First Paint (FP)](/product/performance/web-vitals/web-vitals-concepts/#first-paint-fp) measures the amount of time the first pixel takes to appear in the viewport, rendering any visual change from what was previously displayed.
375
+
[First Paint (FP)](/product/insights/web-vitals/web-vitals-concepts/#first-paint-fp) measures the amount of time the first pixel takes to appear in the viewport, rendering any visual change from what was previously displayed.
376
376
377
377
-**Type:** duration
378
378
379
379
### `measurements.frames_frozen`
380
380
381
-
[Slow and frozen frames](/product/performance/mobile-vitals/#slow-and-frozen-frames) measure the responsiveness of your app.
381
+
[Slow and frozen frames](/product/insights/mobile-vitals/#slow-and-frozen-frames) measure the responsiveness of your app.
382
382
383
383
-**Type:** number
384
384
@@ -390,7 +390,7 @@ Returns results with a matching rate of frozen frames. That is, `measurements.fr
390
390
391
391
### `measurements.frames_slow`
392
392
393
-
[Slow and frozen frames](/product/performance/mobile-vitals/#slow-and-frozen-frames) measure the responsiveness of your app.
393
+
[Slow and frozen frames](/product/insights/mobile-vitals/#slow-and-frozen-frames) measure the responsiveness of your app.
394
394
395
395
-**Type:** number
396
396
@@ -408,7 +408,7 @@ Returns results with a matching total number of frames.
408
408
409
409
### `measurements.lcp`
410
410
411
-
[Largest Contentful Paint (LCP)](/product/performance/web-vitals/web-vitals-concepts/#largest-contentful-paint-lcp) measures the render time for the largest content to appear in the viewport.
411
+
[Largest Contentful Paint (LCP)](/product/insights/web-vitals/web-vitals-concepts/#largest-contentful-paint-lcp) measures the render time for the largest content to appear in the viewport.
412
412
413
413
-**Type:** duration
414
414
@@ -438,7 +438,7 @@ The [total stall time](/platforms/react-native/performance/instrumentation/autom
438
438
439
439
### `measurements.ttfb`
440
440
441
-
[Time To First Byte (TTFB)](/product/performance/web-vitals/web-vitals-concepts/#time-to-first-byte-ttfb) measures the time that it takes for a user's browser to receive the first byte of page content.
441
+
[Time To First Byte (TTFB)](/product/insights/web-vitals/web-vitals-concepts/#time-to-first-byte-ttfb) measures the time that it takes for a user's browser to receive the first byte of page content.
442
442
443
443
-**Type:** duration
444
444
@@ -480,7 +480,8 @@ Returns results with an approximate percentile of the field to the level. The le
480
480
481
481
### `platform`
482
482
483
-
Name of the platform. This is only a metrics property for [valid platforms](https://github.com/getsentry/relay/blob/9d0d2dc54233d46043a369e1dacf7db900953c14/relay-general/src/protocol/constants.rs#L1-L21), defaulting to `other`.
483
+
Name of the platform. This defaults to `other` and is only a property for platforms from this list:
0 commit comments