profiling: add why profiling section to setup steps (#8803)

JonasBa · lizokm · shanamatthews · web-flow · commit e85a7bf0814b · 2024-01-29T08:32:58.000-08:00
* profiling: add why profiling section

* profiling: trim browser profiling beta doc

* Update src/platform-includes/profiling/index/why-profiling/_default.mdx

* Update src/platform-includes/profiling/index/why-profiling/javascript.mdx

Co-authored-by: Shana Matthews &lt;shana.l.matthews@gmail.com&gt;

* Update src/platform-includes/profiling/index/why-profiling/javascript.mdx

Co-authored-by: Steven Eubank &lt;47563310+smeubank@users.noreply.github.com&gt;

* Update src/platforms/javascript/common/profiling/index.mdx

Co-authored-by: Shana Matthews &lt;shana.l.matthews@gmail.com&gt;

* Update src/platforms/javascript/common/profiling/index.mdx

Co-authored-by: Shana Matthews &lt;shana.l.matthews@gmail.com&gt;

* Update src/platform-includes/profiling/index/why-profiling/_default.mdx

Co-authored-by: Shana Matthews &lt;shana.l.matthews@gmail.com&gt;

* Update src/platform-includes/profiling/index/why-profiling/javascript.mdx

* [getsentry/action-github-commit] Auto commit

---------

Co-authored-by: Liza Mock &lt;liza.mock@sentry.io&gt;
Co-authored-by: Shana Matthews &lt;shana.l.matthews@gmail.com&gt;
Co-authored-by: Steven Eubank &lt;47563310+smeubank@users.noreply.github.com&gt;
Co-authored-by: getsantry[bot] &lt;66042841+getsantry[bot]@users.noreply.github.com&gt;
diff --git a/src/platform-includes/profiling/index/why-profiling/_default.mdx b/src/platform-includes/profiling/index/why-profiling/_default.mdx
@@ -0,0 +1 @@
+With [profiling](/product/profiling/), Sentry tracks your software's performance by sampling your program's call stack in a variety of environments. This feature collects function-level information about your code and enables you to fine-tune your program's performance. Sentry's profiler captures function calls and their exact locations, aggregates them, and shows you the most common code paths of your program. This highlights areas you could optimize to help increase both the performance of your code and increase user satisfaction, as well as drive down costs.
diff --git a/src/platform-includes/profiling/index/why-profiling/javascript.mdx b/src/platform-includes/profiling/index/why-profiling/javascript.mdx
@@ -0,0 +1,3 @@
+With [profiling](/product/profiling/), Sentry tracks your software's performance by sampling your program's call stack in a variety of environments. This feature collects function-level information about your code and enables you to fine-tune your program's performance. Sentry's profiler captures function calls and their exact locations, aggregates them, and shows you the most common code paths of your program. This highlights areas you could optimize to help increase both the performance of your code and user satisfaction.
+
+In a browser environment, profiling can help you pinpoint causes of UI jank, surface why values like interaction to next paint (INP) are performing poorly, or why a long task was keeping the browser from repainting the screen and causing frame drops. All of this information enables you to fix real world performance issues and deliver a snappier user experience to your users.
diff --git a/src/platforms/android/profiling/index.mdx b/src/platforms/android/profiling/index.mdx
@@ -5,8 +5,7 @@ sidebar_order: 5000
 ---
 
 <PlatformContent includePath="profiling/index/preface" />
-
-With [profiling](/product/profiling/), Sentry allows you to collect and analyze performance profiles from real user devices in production to give you a complete picture of how your application performs in a variety of environments.
+<PlatformContent includePath="profiling/index/why-profiling" />
 
 ## Enable Performance Monitoring
 
diff --git a/src/platforms/apple/common/profiling/index.mdx b/src/platforms/apple/common/profiling/index.mdx
@@ -5,8 +5,7 @@ sidebar_order: 5000
 ---
 
 <PlatformContent includePath="profiling/index/preface" />
-
-With [profiling](/product/profiling/), Sentry allows you to collect and analyze performance profiles from real user devices in production to give you a complete picture of how your application performs in a variety of environments.
+<PlatformContent includePath="profiling/index/why-profiling" />
 
 ## Enable Performance Monitoring
 
diff --git a/src/platforms/flutter/profiling/index.mdx b/src/platforms/flutter/profiling/index.mdx
@@ -5,8 +5,7 @@ sidebar_order: 5000
 ---
 
 <PlatformContent includePath="profiling/index/preface" />
-
-With [profiling](/product/profiling/), Sentry allows you to collect and analyze performance profiles from real user devices in production to give you a complete picture of how your application performs in a variety of environments.
+<PlatformContent includePath="profiling/index/why-profiling" />
 
 ## Enable Performance Monitoring
 
diff --git a/src/platforms/go/common/profiling/index.mdx b/src/platforms/go/common/profiling/index.mdx
@@ -5,8 +5,7 @@ sidebar_order: 5000
 ---
 
 <PlatformContent includePath="profiling/index/preface" />
-
-With [profiling](/product/profiling/), Sentry allows you to collect and analyze performance profiles from real user devices in production to give you a complete picture of how your application performs in a variety of environments.
+<PlatformContent includePath="profiling/index/why-profiling" />
 
 ## Enable Performance Monitoring
 
diff --git a/src/platforms/javascript/common/profiling/index.mdx b/src/platforms/javascript/common/profiling/index.mdx
@@ -16,9 +16,11 @@ Browser Profiling is currently in beta. Beta features are still in progress and
 
 </Note>
 
-Because our JavaScript 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)
+The browser profiling integration is built using [JS Self-Profiling API](https://wicg.github.io/js-self-profiling/) and will likely only move out of beta once the specification progresses and gains adoption. See platform [status](https://chromestatus.com/feature/5170190448852992).
 
-Unlike Chrome DevTools profiler, which runs locally and is intended primarily as a debugging tool, Sentry's JavaScript Profiler runs in production. It captures profiling data from real users and reflects real-world performance.
+Note that since the profiling API is currently only exposed in Chromium, profiles collected only include that demographic. This is obvious, but should not be forgotten when analyzing the data collected. We hope that as the API gains adoption, other browsers will implement it as well.
+
+<PlatformContent includePath="profiling/index/why-profiling" />
 
 ## Prerequisites
 
diff --git a/src/platforms/python/profiling/index.mdx b/src/platforms/python/profiling/index.mdx
@@ -5,8 +5,7 @@ sidebar_order: 5000
 ---
 
 <PlatformContent includePath="profiling/index/preface" />
-
-With [profiling](/product/profiling/), Sentry allows you to collect and analyze performance profiles from real user devices in production to give you a complete picture of how your application performs in a variety of environments.
+<PlatformContent includePath="profiling/index/why-profiling" />
 
 ## Enable Performance Monitoring
 
diff --git a/src/platforms/react-native/profiling/index.mdx b/src/platforms/react-native/profiling/index.mdx
@@ -5,8 +5,7 @@ sidebar_order: 5000
 ---
 
 <PlatformContent includePath="profiling/index/preface" />
-
-With [profiling](/product/profiling/), Sentry allows you to collect and analyze performance profiles from real user devices in production to give you a complete picture of how your application performs in a variety of environments.
+<PlatformContent includePath="profiling/index/why-profiling" />
 
 ## Enable Performance Monitoring
 
diff --git a/src/platforms/ruby/common/profiling/index.mdx b/src/platforms/ruby/common/profiling/index.mdx
@@ -5,8 +5,7 @@ sidebar_order: 5000
 ---
 
 <PlatformContent includePath="profiling/index/preface" />
-
-With [profiling](/product/profiling/), Sentry allows you to collect and analyze performance profiles from real user devices in production to give you a complete picture of how your application performs in a variety of environments.
+<PlatformContent includePath="profiling/index/why-profiling" />
 
 ## Enable Performance Monitoring
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+With [profiling](/product/profiling/), Sentry tracks your software's performance by sampling your program's call stack in a variety of environments. This feature collects function-level information about your code and enables you to fine-tune your program's performance. Sentry's profiler captures function calls and their exact locations, aggregates them, and shows you the most common code paths of your program. This highlights areas you could optimize to help increase both the performance of your code and increase user satisfaction, as well as drive down costs.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+With [profiling](/product/profiling/), Sentry tracks your software's performance by sampling your program's call stack in a variety of environments. This feature collects function-level information about your code and enables you to fine-tune your program's performance. Sentry's profiler captures function calls and their exact locations, aggregates them, and shows you the most common code paths of your program. This highlights areas you could optimize to help increase both the performance of your code and user satisfaction.
	`2`	`+`
	`3`	`+In a browser environment, profiling can help you pinpoint causes of UI jank, surface why values like interaction to next paint (INP) are performing poorly, or why a long task was keeping the browser from repainting the screen and causing frame drops. All of this information enables you to fix real world performance issues and deliver a snappier user experience to your users.`