-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(profiling): add wizard onboarding docs #5778
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 21 additions & 0 deletions
21
src/wizard/android/profiling-onboarding/android/1.install.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
name: Android | ||
doc_link: https://docs.sentry.io/platforms/android/profiling/ | ||
support_level: production | ||
type: language | ||
--- | ||
|
||
#### Install | ||
|
||
For the Profiling integration to work, you must have the Sentry Android package (minimum version 6.0.0). You can choose between automatic and manual installation methods, using Sentry’s Android Gradle Plugin (shown below). Learn more about installation methods in our [full documentation](https://docs.sentry.io/platforms/android/#install). | ||
|
||
```groovy | ||
buildscript { | ||
repositories { | ||
mavenCentral() | ||
} | ||
} | ||
plugins { | ||
id "io.sentry.android.gradle" version "{{ packages.version('sentry.java.android.gradle-plugin', '3.0.0') }}" | ||
} | ||
``` |
18 changes: 18 additions & 0 deletions
18
src/wizard/android/profiling-onboarding/android/2.configure-performance.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
name: Android | ||
doc_link: https://docs.sentry.io/platforms/android/profiling/ | ||
support_level: production | ||
type: language | ||
--- | ||
|
||
#### Configure Performance | ||
|
||
Sentry’s performance monitoring product has to be enabled in order for Profiling to work. To enable performance monitoring in the SDK: | ||
|
||
```xml {filename:AndroidManifest.xml} | ||
<application> | ||
<meta-data android:name="io.sentry.dsn" android:value="___PUBLIC_DSN___" /> | ||
<!-- We recommend adjusting this value in production --> | ||
<meta-data android:name="io.sentry.traces.sample-rate" android:value="1.0" /> | ||
</application> | ||
``` |
17 changes: 17 additions & 0 deletions
17
src/wizard/android/profiling-onboarding/android/3.configure-profiling.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
name: Android | ||
doc_link: https://docs.sentry.io/platforms/android/profiling/ | ||
support_level: production | ||
type: language | ||
--- | ||
|
||
#### Configure Profiling | ||
|
||
Sentry’s performance monitoring product has to be enabled in order for Profiling to work. To enable performance monitoring in the SDK: | ||
|
||
```xml {filename:AndroidManifest.xml} | ||
<application> | ||
<!-- SDK Config --> | ||
<meta-data android:name="io.sentry.traces.profiling.sample-rate" android:value="1.0" /> | ||
</application> | ||
``` |
10 changes: 10 additions & 0 deletions
10
src/wizard/android/profiling-onboarding/android/4.upload.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
name: Android | ||
doc_link: https://docs.sentry.io/platforms/android/profiling/ | ||
support_level: production | ||
type: language | ||
--- | ||
|
||
#### Upload Proguard Mappings | ||
|
||
If your app uses Sentry’s Android Gradle Plugin, the Proguard maps will be automatically uploaded when you publish your next build on Google Play. Learn more about Sentry’s Gradle Plugin in our [full documentation](https://docs.sentry.io/platforms/android/profiling/). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
name: iOS | ||
doc_link: https://docs.sentry.io/platforms/apple/guides/ios/profiling/ | ||
support_level: production | ||
type: language | ||
--- | ||
|
||
#### Install | ||
|
||
For the Profiling integration to work, you must have the Sentry Cocoa package (minimum version 7.23.0). We offer installation methods for Carthage (shown below), CocoaPods, and Swift Package Manager. Learn more about installation methods in our [full documentation](/platforms/apple/install/). | ||
|
||
```ruby | ||
github "getsentry/sentry-cocoa" "{{ packages.version('sentry.cocoa','7.23.0') }}" | ||
``` |
20 changes: 20 additions & 0 deletions
20
src/wizard/apple/profiling-onboarding/ios/2.configure-performance.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: iOS | ||
doc_link: https://docs.sentry.io/platforms/apple/guides/ios/profiling/ | ||
support_level: production | ||
type: language | ||
--- | ||
|
||
#### Configure Performance | ||
|
||
Sentry’s performance monitoring product has to be enabled in order for Profiling to work. To enable performance monitoring in the SDK: | ||
|
||
```swift {tabTitle:Swift} | ||
import Sentry | ||
|
||
SentrySDK.start { options in | ||
options.dsn = "___PUBLIC_DSN___" | ||
// We recommend adjusting this value in production | ||
options.tracesSampleRate = 1.0 | ||
} | ||
``` |
19 changes: 19 additions & 0 deletions
19
src/wizard/apple/profiling-onboarding/ios/3.configure-profiling.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: iOS | ||
doc_link: https://docs.sentry.io/platforms/apple/guides/ios/profiling/ | ||
support_level: production | ||
type: language | ||
--- | ||
|
||
#### Configure Profiling | ||
|
||
Add the `profilesSampleRate` option to your SDK config. | ||
|
||
```swift {tabTitle:Swift} | ||
import Sentry | ||
|
||
SentrySDK.start { options in | ||
// ... SDK config | ||
options.profilesSampleRate = 1.0 | ||
} | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
name: iOS | ||
doc_link: https://docs.sentry.io/platforms/apple/guides/ios/profiling/ | ||
support_level: production | ||
type: language | ||
--- | ||
|
||
#### Upload Debug Symbols | ||
|
||
Upload the dSYM file using either sentry-cli, the Fastlane action, or set up the Sentry App Store Connect integration. Learn more about uploading debug symbols in our [full documentation](https://docs.sentry.io/platforms/apple/guides/ios/profiling/). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
name: Node | ||
doc_link: https://discord.gg/zrMjKA4Vnz | ||
support_level: alpha | ||
type: language | ||
--- | ||
|
||
<div class='alert warning'> | ||
Profiling in Node is currently in Alpha, and there may be some bugs. We recognize the irony. If you have any questions or feedback, join our <a href="https://discord.gg/zrMjKA4Vnz">discord channel</a>. | ||
</div> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
name: Node | ||
doc_link: https://discord.gg/zrMjKA4Vnz | ||
support_level: alpha | ||
type: language | ||
--- | ||
|
||
#### Install | ||
|
||
For the Profiling integration to work, you must have the Sentry Node SDK package (minimum version 7.x) installed. | ||
|
||
```bash | ||
# Using yarn | ||
yarn add @sentry/node @sentry/tracing @sentry/profiling-node | ||
|
||
# Using npm | ||
npm install --save @sentry/node @sentry/tracing @sentry/profiling-node | ||
``` |
23 changes: 23 additions & 0 deletions
23
src/wizard/node/profiling-onboarding/node/2.configure-performance.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: Node | ||
doc_link: https://discord.gg/zrMjKA4Vnz | ||
support_level: alpha | ||
type: language | ||
--- | ||
|
||
#### Configure Performance | ||
|
||
Sentry’s performance monitoring product has to be enabled in order for Profiling to work. To enable performance monitoring in the SDK: | ||
|
||
```javascript | ||
import * as Sentry from "@sentry/node"; | ||
import "@sentry/tracing"; | ||
|
||
Sentry.init({ | ||
dsn: "___PUBLIC_DSN___", | ||
// Set tracesSampleRate to 1.0 to capture 100% | ||
// of transactions for performance monitoring. | ||
// We recommend adjusting this value in production | ||
eliashussary marked this conversation as resolved.
Show resolved
Hide resolved
|
||
tracesSampleRate: 1.0, | ||
}); | ||
``` |
26 changes: 26 additions & 0 deletions
26
src/wizard/node/profiling-onboarding/node/3.configure-profiling.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
name: Node | ||
doc_link: https://discord.gg/zrMjKA4Vnz | ||
support_level: alpha | ||
type: language | ||
--- | ||
|
||
#### Configure Profiling | ||
|
||
Add the `profilesSampleRate` option to your SDK config. | ||
|
||
```javascript | ||
import * as Sentry from "@sentry/node"; | ||
// NOTE: @sentry/tracing should be imported before @sentry/profiling-node | ||
import "@sentry/tracing"; | ||
eliashussary marked this conversation as resolved.
Show resolved
Hide resolved
|
||
import {ProfilingIntegration} from "@sentry/profiling-node"; | ||
|
||
Sentry.init({ | ||
// ... SDK config | ||
eliashussary marked this conversation as resolved.
Show resolved
Hide resolved
|
||
integrations: [ | ||
// add profiling integration | ||
new ProfilingIntegration() | ||
] | ||
profilesSampleRate: 1.0, | ||
}); | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
name: Python | ||
doc_link: https://discord.gg/zrMjKA4Vnz | ||
support_level: alpha | ||
type: language | ||
--- | ||
|
||
<div class='alert warning'> | ||
Profiling in Python is currently in Alpha, and there may be some bugs. We recognize the irony. If you have any questions or feedback, join our <a href="https://discord.gg/zrMjKA4Vnz">discord channel</a>. | ||
</div> |
14 changes: 14 additions & 0 deletions
14
src/wizard/python/profiling-onboarding/python/1.install.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
name: Python | ||
doc_link: https://discord.gg/zrMjKA4Vnz | ||
support_level: alpha | ||
type: language | ||
--- | ||
|
||
#### Install | ||
|
||
For the Profiling integration to work, you must have the Sentry Python SDK package (minimum version 1.11.0) installed. | ||
|
||
```bash | ||
pip install --upgrade sentry-sdk | ||
``` |
22 changes: 22 additions & 0 deletions
22
src/wizard/python/profiling-onboarding/python/2.configure-performance.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
name: Python | ||
doc_link: https://discord.gg/zrMjKA4Vnz | ||
support_level: alpha | ||
type: language | ||
--- | ||
|
||
#### Configure Performance | ||
|
||
Sentry’s performance monitoring product has to be enabled in order for Profiling to work. To enable performance monitoring in the SDK: | ||
|
||
```python | ||
import sentry_sdk | ||
|
||
sentry_sdk.init( | ||
dsn="___PUBLIC_DSN___", | ||
# Set tracesSampleRate to 1.0 to capture 100% | ||
# of transactions for performance monitoring. | ||
# We recommend adjusting this value in production | ||
traces_sample_rate=1.0, | ||
); | ||
``` |
21 changes: 21 additions & 0 deletions
21
src/wizard/python/profiling-onboarding/python/3.configure-profiling.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
name: Python | ||
doc_link: https://discord.gg/zrMjKA4Vnz | ||
support_level: alpha | ||
type: language | ||
--- | ||
|
||
#### Configure Profiling | ||
|
||
Add the `profiles_sample_rate` option to your SDK config. | ||
|
||
```python | ||
import sentry_sdk | ||
|
||
sentry_sdk.init( | ||
# ... SDK config | ||
_experiments={ | ||
"profiles_sample_rate": 1.0, | ||
} | ||
) | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.