Skip to content

Commit a1ed83a

Browse files
Update SDK docs (#10720)
1 parent 1f40a8f commit a1ed83a

File tree

13 files changed

+82
-196
lines changed

13 files changed

+82
-196
lines changed

docs/platforms/dotnet/index.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
---
22
title: .NET
33
sdk: sentry.dotnet
4+
description: Learn how to set up and run Sentry's .NET SDK, which will automatically report errors and exceptions in your application.
45
caseStyle: PascalCase
56
supportLevel: production
67
aliases:
78
- C#
89
---
910

10-
On this page, we get you up and running with Sentry's .NET SDK, automatically reporting errors and exceptions in your application.
11-
1211
<Note>
1312

1413
If you don't already have an account and Sentry project established, head over to [sentry.io](https://sentry.io/signup/), then return to this page.
Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
11
---
22
title: Node.js
3-
description: "Learn about using Sentry with Node.js."
3+
description: "Learn how to set up Sentry in your Node.js application."
44
sdk: sentry.javascript.node
55
categories:
66
- server
77
---
88

99
<PlatformContent includePath="getting-started-primer" />
1010

11-
This guide explains how to set up Sentry in your Node.js application.
12-
13-
<PlatformContent includePath="alert-using-a-framework" noGuides />
14-
1511
<PlatformContent includePath="getting-started-node" />

docs/platforms/php/guides/laravel/index.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,12 @@ sidebar_order: 0
55
description: "Laravel is a PHP web application framework with expressive, elegant syntax. Learn how to set it up with Sentry."
66
---
77

8-
Laravel is supported using a native package: [sentry-laravel](https://github.com/getsentry/sentry-laravel).
8+
## Prerequisites
99

10-
This guide is for Laravel 11.x. We also provide instructions for [other versions](/platforms/php/guides/laravel/other-versions/) as well as [Lumen-specific instructions](/platforms/php/guides/laravel/other-versions/lumen/).
10+
* You need a [Sentry account](https://sentry.io/signup/) and project
11+
* Your Laravel application needs to run on PHP 7.2 or later
12+
* Your Laravel version needs to be 11.x or higher
13+
* Read one of these guides if you use an [older version](/platforms/php/guides/laravel/other-versions/) or need [Lumen-specific instructions](/platforms/php/guides/laravel/other-versions/lumen/)
1114

1215
## Install
1316

@@ -41,12 +44,8 @@ return Application::configure(basePath: dirname(__DIR__))
4144
})->create();
4245
```
4346

44-
<Note>
45-
4647
Alternatively, you can configure Sentry in your [Laravel Log Channel](usage/#log-channels), allowing you to log `info` and `debug` as well.
4748

48-
</Note>
49-
5049
## Configure
5150

5251
Configure the Sentry DSN with this command:

docs/platforms/php/guides/symfony/index.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ sdk: sentry.php.symfony
44
description: "Symfony is a set of reusable PHP components and a PHP framework to build web applications and services. Learn how to set it up with Sentry."
55
---
66

7-
Symfony is supported via the [`sentry-symfony`](https://github.com/getsentry/sentry-symfony) package as a native bundle.
7+
## Prerequisites
8+
9+
* You need a [Sentry account](https://sentry.io/signup/) and project
10+
* Your Symfony application needs to run on PHP 7.2 or later
811

912
## Install
1013

docs/platforms/php/index.mdx

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,18 @@ title: PHP
33
sdk: sentry.php
44
caseStyle: snake_case
55
supportLevel: production
6-
description: PHP (or Hypertext Preprocessor) is an open source, general-purpose scripting language that's well-suited for web development. It can be embedded into HTML.
6+
description: Learn how to set up Sentry in your PHP application.
77
---
88

9-
On this page, we get you up and running with Sentry's PHP SDK, automatically reporting errors and exceptions in your application. The SDK provides support for PHP 7.2 or later. If you're using a previous version of the PHP SDK, you can access the <Link rel="nofollow" to="/platforms/php/legacy-sdk/">legacy SDK documentation</Link>.
9+
## Prerequisites
1010

11-
<Note>
11+
* You need a [Sentry account](https://sentry.io/signup/) and project
12+
* Your application needs to run on PHP 7.2 or later
13+
* Read one of these other guides if you use <PlatformLink to="/guides/laravel">Laravel</PlatformLink> or <PlatformLink to="/guides/symfony">Symfony</PlatformLink>
1214

13-
If you don't already have an account and Sentry project established, head over to [sentry.io](https://sentry.io/signup/), then return to this page.
15+
## Features
1416

15-
</Note>
16-
17-
<GuideGrid platform="php" />
18-
19-
Sentry captures data by using an SDK within your application’s runtime. Our SDKs are platform-specific and allow Sentry to have a deep understanding of how your application works.
20-
21-
## Install
17+
<p className="mb-5">Select which Sentry features you'd like to install in addition to Error Monitoring to get the corresponding installation and configuration instructions below.</p>
2218

2319
<OnboardingOptionButtons
2420
options={[
@@ -28,15 +24,17 @@ Sentry captures data by using an SDK within your application’s runtime. Our SD
2824
]}
2925
/>
3026

31-
Install the SDK using [Composer](https://getcomposer.org/).
27+
## Install
28+
29+
Install the Sentry SDK using [Composer](https://getcomposer.org/):
3230

3331
```bash
3432
composer require sentry/sentry
3533
```
3634

3735
<OnboardingOption optionId="profiling">
3836

39-
Install the Excimer extension via PECL:
37+
To use Profiling, you'll also need to install the Excimer extension via PECL:
4038

4139
```bash
4240
pecl install excimer

docs/platforms/python/common/metrics/index.mdx

Lines changed: 0 additions & 98 deletions
This file was deleted.

docs/platforms/python/index.mdx

Lines changed: 38 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,60 @@ sdk: sentry.python
77
showIntegrationsInSearch: true
88
---
99

10-
On this page, we get you up and running with Sentry's SDK.
10+
## Prerequisites
1111

12-
<Alert level="info" title="Using a framework?">
12+
* You need a [Sentry account](https://sentry.io/signup/) and project
13+
* Read one of our dedicated guides if you use any of the <PlatformLink to="/integrations/#web-frameworks">frameworks</PlatformLink> we support
1314

14-
See our <PlatformLink to="/integrations/">Integrations</PlatformLink> page or choose from the left-hand dropdown to get started.
15+
## Features
1516

16-
</Alert>
17+
<p className="mb-5">Select which Sentry features you'd like to install in addition to Error Monitoring to get the corresponding installation and configuration instructions below.</p>
1718

18-
Don't already have an account and Sentry project established? Head over to [sentry.io](https://sentry.io/signup/), then return to this page.
19-
20-
If you prefer to follow video instructions, see [How to Install the Sentry Python SDK in 60 Seconds](https://vimeo.com/899368672).
19+
<OnboardingOptionButtons
20+
options={[
21+
'error-monitoring',
22+
'performance',
23+
'profiling',
24+
]}
25+
/>
2126

2227
## Install
2328

24-
Sentry captures data by using an SDK within your application’s runtime.
29+
Install the Sentry SDK using [`pip`](https://pip.pypa.io/en/stable/):
2530

26-
<PlatformContent includePath="getting-started-install" />
31+
```bash
32+
pip install --upgrade sentry-sdk
33+
```
2734

2835
## Configure
2936

30-
<PlatformContent includePath="getting-started-config" />
37+
Configuration should happen as early as possible in your application's lifecycle.
38+
39+
<SignInNote />
40+
41+
42+
```python {"onboardingOptions": {"performance": "5-7", "profiling": "8-11"}}
43+
import sentry_sdk
44+
45+
sentry_sdk.init(
46+
dsn="___PUBLIC_DSN___",
47+
# Set traces_sample_rate to 1.0 to capture 100%
48+
# of transactions for tracing.
49+
traces_sample_rate=1.0,
50+
# Set profiles_sample_rate to 1.0 to profile 100%
51+
# of sampled transactions.
52+
# We recommend adjusting this value in production.
53+
profiles_sample_rate=1.0,
54+
)
55+
```
3156

3257
## Verify
3358

3459
Add this intentional error to your application to test that everything is working right away.
3560

36-
<PlatformContent includePath="getting-started-verify" />
61+
```py
62+
division_by_zero = 1 / 0
63+
```
3764

3865
<Note>
3966

docs/platforms/python/tracing/index.mdx

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,30 @@
11
---
22
title: Set Up Tracing
3-
description: "Learn how to enable tracing in your Python SDK and get valuable performance insights about your application."
3+
description: "With Tracing, Sentry tracks your software performance, measuring metrics like throughput and latency, and displays the impact of errors across multiple systems."
44
sidebar_order: 4000
55
---
66

7-
With [tracing](/product/performance/), Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems. Sentry captures distributed traces consisting of transactions and spans, which measure individual services and individual operations within those services. Learn more about our model in [Distributed Tracing](/product/sentry-basics/tracing/distributed-tracing/).
7+
## Prerequisites
88

9-
<Note>
9+
* You have the <PlatformLink to="/">Python SDK installed</PlatformLink> (version 0.11.2 or higher)
1010

11-
If you’re adopting Tracing in a high-throughput environment, we recommend testing prior to deployment to ensure that your service’s performance characteristics maintain expectations.
11+
## Configure
1212

13-
</Note>
13+
To enable tracing in your application, adjust the `traces_sample_rate` based on the number of trace samples you want to send to Sentry by adding the highlighted code snippet below. (Setting a value of `1.0` will send 100% of your traces.)
1414

15-
<Include name="opentelemetry-available.mdx" />
15+
<SignInNote />
1616

17-
## Configure
17+
```python {diff}
18+
import sentry_sdk
1819

19-
<PlatformContent includePath="performance/configure-sample-rate" />
20+
sentry_sdk.init(
21+
dsn="___PUBLIC_DSN___",
22+
+ # We recommend adjusting this value in production
23+
+ traces_sample_rate=1.0,
24+
)
25+
```
26+
27+
If you’re adopting Tracing in a high-throughput environment, we recommend testing prior to deployment to ensure that your service’s performance characteristics maintain expectations.
2028

2129
Learn more about tracing <PlatformLink to="/configuration/options/#tracing-options">options</PlatformLink>, how to use the <PlatformLink to="/configuration/sampling/#setting-a-sampling-function">traces_sampler</PlatformLink> function, or how to <PlatformLink to="/configuration/sampling/#sampling-transaction-events">sample transactions</PlatformLink>.
2230

platform-includes/getting-started-config/python.mdx

Lines changed: 0 additions & 26 deletions
This file was deleted.

platform-includes/getting-started-install/python.mdx

Lines changed: 0 additions & 5 deletions
This file was deleted.

platform-includes/getting-started-verify/python.mdx

Lines changed: 0 additions & 3 deletions
This file was deleted.

platform-includes/performance/configure-sample-rate/python.mdx

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)