Skip to content
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

Update SDK docs #10720

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update SDK docs #10720

wants to merge 1 commit into from

Conversation

stephanie-anderson
Copy link
Contributor

No description provided.

Copy link

vercel bot commented Jul 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 15, 2024 5:26pm
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 15, 2024 5:26pm

Copy link

codecov bot commented Jul 15, 2024

Bundle Report

Changes will decrease total bundle size by 949 bytes ⬇️

Bundle name Size Change
sentry-docs-server 9.25MB 1.02kB ⬇️
sentry-docs-edge-server 252.86kB 3 bytes ⬇️
sentry-docs-client 7.88MB 71 bytes ⬆️

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

Thanks so much for adding this!

@@ -1,14 +1,13 @@
---
title: .NET
sdk: sentry.dotnet
description: On this page, we get you up and running with Sentry's .NET SDK, automatically reporting errors and exceptions in your application.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
description: On this page, we get you up and running with Sentry's .NET SDK, automatically reporting errors and exceptions in your application.
description: Learn how to set up and run Sentry's .NET SDK, which will automatically report errors and exceptions in your application.

@@ -1,15 +1,11 @@
---
title: Node.js
description: "Learn about using Sentry with Node.js."
description: "This guide explains how to set up Sentry in your Node.js application."
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
description: "This guide explains how to set up Sentry in your Node.js application."
description: "Learn how to set up Sentry in your Node.js application."

* You need a [Sentry account](https://sentry.io/signup/) and project
* Your Laravel application needs to run on PHP 7.2 or later
* Your Laravel version needs to be 11.x or higher
* Switch to other guides, if you use [older versions](/platforms/php/guides/laravel/other-versions/) or need [Lumen-specific instructions](/platforms/php/guides/laravel/other-versions/lumen/)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Switch to other guides, if you use [older versions](/platforms/php/guides/laravel/other-versions/) or need [Lumen-specific instructions](/platforms/php/guides/laravel/other-versions/lumen/)
* Read one of these guides if you use an [older versions](/platforms/php/guides/laravel/other-versions/) or need [Lumen-specific instructions](/platforms/php/guides/laravel/other-versions/lumen/).

<Note>
* You need a [Sentry account](https://sentry.io/signup/) and project
* Your application needs to run on PHP 7.2 or later
* Switch to the dedicated guide, if you use <PlatformLink to="/guides/laravel">Laravel</PlatformLink> or <PlatformLink to="/guides/symfony">Symfony</PlatformLink>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Switch to the dedicated guide, if you use <PlatformLink to="/guides/laravel">Laravel</PlatformLink> or <PlatformLink to="/guides/symfony">Symfony</PlatformLink>
* Read one of these other guides if you use <PlatformLink to="/guides/laravel">Laravel</PlatformLink> or <PlatformLink to="/guides/symfony">Symfony</PlatformLink>

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.

## Install
<p className="mb-5">Depending on which Sentry features you chose below, we will update the installation and configuration instructions on this page. Error Monitoring is always activated.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<p className="mb-5">Depending on which Sentry features you chose below, we will update the installation and configuration instructions on this page. Error Monitoring is always activated.</p>
<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>


```bash
composer require sentry/sentry
```

<OnboardingOption optionId="profiling">

Install the Excimer extension via PECL:
In order to use Profiling, you also need to install the Excimer extension via PECL:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
In order to use Profiling, you also need to install the Excimer extension via PECL:
To use Profiling, you'll also need to install the Excimer extension via PECL:


<Alert level="info" title="Using a framework?">
* You need a [Sentry account](https://sentry.io/signup/) and project
* Switch to the dedicated guide, if you use any of the <PlatformLink to="/integrations/#web-frameworks">frameworks</PlatformLink> we support
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Switch to the dedicated guide, if you use any of the <PlatformLink to="/integrations/#web-frameworks">frameworks</PlatformLink> we support
* Read one of our dedicated guides if you use any of the <PlatformLink to="/integrations/#web-frameworks">frameworks</PlatformLink> we support


</Alert>
<p className="mb-5">Depending on which Sentry features you chose below, we will update the installation and configuration instructions on this page. Error Monitoring is always activated.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<p className="mb-5">Depending on which Sentry features you chose below, we will update the installation and configuration instructions on this page. Error Monitoring is always activated.</p>
<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>

@@ -1,22 +1,30 @@
---
title: Set Up Tracing
description: "Learn how to enable tracing in your Python SDK and get valuable performance insights about your application."
description: "With Tracing, Sentry tracks your software performance, measuring metrics like throughput and latency, and displays the impact of errors across multiple systems."
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
description: "With Tracing, Sentry tracks your software performance, measuring metrics like throughput and latency, and displays the impact of errors across multiple systems."
description: "With Tracing, Sentry tracks your software performance, measuring metrics like throughput and latency, and showing the impact of errors across multiple systems."


</Note>
To enable tracing in your application, add the following to your initialization code of the Sentry SDK. Adjust the `traces_sample_rate` depending on how many samples of traces you want to send to Sentry. Setting a value of `1.0` will send 100% of all traces.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To enable tracing in your application, add the following to your initialization code of the Sentry SDK. Adjust the `traces_sample_rate` depending on how many samples of traces you want to send to Sentry. Setting a value of `1.0` will send 100% of all traces.
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.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants