Skip to content

Commit

Permalink
fix(profiling): add beta note and decrease titles (#7567)
Browse files Browse the repository at this point in the history
* fix(profiling): add beta note and decrease titles

* style(lint): Auto commit lint changes

---------

Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>
  • Loading branch information
JonasBa and getsantry[bot] authored Jul 31, 2023
1 parent eb3cc3c commit 384bc13
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 6 deletions.
6 changes: 6 additions & 0 deletions src/platforms/javascript/common/profiling/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ supported:
description: "Learn what transactions are captured after tracing is enabled."
---

<Note>

Browser Profiling is currently in beta. Beta features are still in-progress and may have bugs. We recognize the irony.

</Note>

Because our browser profiling integration is built on top of the profiler exposed by the [JS Self-Profiling API](https://wicg.github.io/js-self-profiling/), it's in beta and will likely only move out once the official spec progresses and gains adoption. As with any beta package, there are risks involved in using it - see platform [status](https://chromestatus.com/feature/5170190448852992)

Please note, that since profiling API is currently only implemented in Chromium based browsers, the profiles collected will inherently be biased towards that demographic. This is something you'll need to consider if you're basing your decisions on the data collected. We hope that as the API gains adoption, other browsers will implement it as well. If you find browser profiling feature helpful and would like to see it gain further adoption, please consider supporting the spec at the official [WICG repository](https://github.com/WICG/js-self-profiling).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ support_level: beta
type: framework
---

## Install
<Note>

Browser Profiling is currently in beta. Beta features are still in-progress and may have bugs. We recognize the irony.

</Note>

#### Install

Because our browser profiling integration is built on top of the profiler exposed by the [JS Self-Profiling API](https://wicg.github.io/js-self-profiling/), it's in beta and will likely only move out once the official spec progresses and gains adoption. As with any beta package, there are risks involved in using it - see platform [status](https://chromestatus.com/feature/5170190448852992)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ support_level: beta
type: framework
---

## Add Document-Policy: js-profiling header
#### Add Document-Policy: js-profiling header

In order for the profiler to start, the document response header has to include a `Document-Policy` header key with the `js-profiling` value.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ support_level: beta
type: framework
---

## Configure
#### Configure

Configuration should happen as early as possible in your application's lifecycle. Once this is done, Sentry's JavaScript SDK will capture all unhandled exceptions and transactions.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ support_level: beta
type: framework
---

## Install
<Note>

Browser Profiling is currently in beta. Beta features are still in-progress and may have bugs. We recognize the irony.

</Note>

#### Install

Because our browser profiling integration is built on top of the profiler exposed by the [JS Self-Profiling API](https://wicg.github.io/js-self-profiling/), it's in beta and will likely only move out once the official spec progresses and gains adoption. As with any beta package, there are risks involved in using it - see platform [status](https://chromestatus.com/feature/5170190448852992).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ support_level: beta
type: framework
---

## Add Document-Policy: js-profiling header
#### Add Document-Policy: js-profiling header

In order for the profiler to start, the document response header has to include a `Document-Policy` header key with the `js-profiling` value.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ support_level: beta
type: framework
---

## Configure
#### Configure

Configuration should happen as early as possible in your application's lifecycle. Once this is done, Sentry's JavaScript SDK will capture all unhandled exceptions and transactions.

Expand Down

1 comment on commit 384bc13

@vercel
Copy link

@vercel vercel bot commented on 384bc13 Jul 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

sentry-docs – ./

sentry-docs.sentry.dev
sentry-docs-git-master.sentry.dev
docs.sentry.io

Please sign in to comment.