Skip to content

Commit

Permalink
Fix Sentry capitalization (#7695)
Browse files Browse the repository at this point in the history
  • Loading branch information
shanamatthews committed Aug 25, 2023
1 parent 0a347bf commit 66f62bc
Show file tree
Hide file tree
Showing 24 changed files with 37 additions and 37 deletions.
2 changes: 1 addition & 1 deletion src/docs/clients/react-native/codepush.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This SDK has been superseded by the new React Native SDK. Sentry preserves this

</Alert>

If you want to use sentry together with CodePush you have to send us the CodePush version:
If you want to use Sentry together with CodePush you have to send us the CodePush version:

```javascript
import codePush from "react-native-code-push";
Expand Down
2 changes: 1 addition & 1 deletion src/docs/clients/react-native/config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,6 @@ Sentry.captureBreadcrumb({
},
});

// This will trigger a crash in the native sentry client
// This will trigger a crash in the native Sentry client
//Sentry.nativeCrash();
```
2 changes: 1 addition & 1 deletion src/docs/clients/react-native/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Upon linking the following changes will be performed:

- add the sentry-java package for native crash reporting on Android
- add the sentry-cocoa package for native crash reporting on iOS
- enable the sentry gradle build step for android
- enable the Sentry gradle build step for android
- patch _AppDelegate.m_ for iOS
- patch _MainApplication.java_ for Android
- configure Sentry for the supplied DSN in your _index.js/App.js_ files
Expand Down
2 changes: 1 addition & 1 deletion src/docs/clients/react-native/manual-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ fi

[ -z "$NODE_BINARY" ] && export NODE_BINARY="node"

# Run sentry cli script to upload debug symbols
# Run Sentry cli script to upload debug symbols
$NODE_BINARY ../node_modules/@sentry/cli/bin/sentry-cli debug-files upload "$DWARF_DSYM_FOLDER_PATH"
```

Expand Down
2 changes: 1 addition & 1 deletion src/docs/product/accounts/sso/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ You may refer to the [OneLogin documentation](https://onelogin.service-now.com/s

In your Rippling admin dashboard, locate the Sentry app in the list of suggested apps and select it.

When prompted with the Rippling Metadata URL, copy this into the Sentry Rippling provider configuration. You will have to complete the Rippling application configuration before completing the sentry provider configuration.
When prompted with the Rippling Metadata URL, copy this into the Sentry Rippling provider configuration. You will have to complete the Rippling application configuration before completing the Sentry provider configuration.

#### Jumpcloud

Expand Down
6 changes: 3 additions & 3 deletions src/docs/product/cli/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,11 @@ The following settings are available (first is the environment variable, the val

`SENTRY_DSN` (_auth.dsn_):

: The DSN to use to connect to sentry.
: The DSN to use to connect to Sentry.

`SENTRY_URL` (_defaults.url_):

: The URL to use to connect to sentry. This defaults to `https://sentry.io/`.
: The URL to use to connect to Sentry. This defaults to `https://sentry.io/`.

`SENTRY_ORG` (_defaults.org_):

Expand Down Expand Up @@ -146,7 +146,7 @@ The following settings are available (first is the environment variable, the val

(_dif.max_upload_size_):

: Sets the maximum upload size in bytes (before compression) of debug symbols into one batch. The default is 35MB or 100MB (depending on the version of sentry-cli) which is suitable for sentry.io but if you are using a different sentry server you might want to change this limit if necessary. (Prior to version 1.72.0, this option was called `dsym.max_upload_size`.)
: Sets the maximum upload size in bytes (before compression) of debug symbols into one batch. The default is 35MB or 100MB (depending on the version of sentry-cli) which is suitable for sentry.io but if you are using a different Sentry server you might want to change this limit if necessary. (Prior to version 1.72.0, this option was called `dsym.max_upload_size`.)

(_dif.max_item_size_):

Expand Down
4 changes: 2 additions & 2 deletions src/docs/product/cli/send-event.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ For basic message events, you just need to provide the `--message` or `-m` param
sentry-cli send-event -m "Hello from Sentry"
```

This will send a single message to sentry and record it as an event. Along with that event, it sends basic information about the machine you are running `sentry-cli` on. You can provide `-m` multiple times to send multiple lines:
This will send a single message to Sentry and record it as an event. Along with that event, it sends basic information about the machine you are running `sentry-cli` on. You can provide `-m` multiple times to send multiple lines:

```bash
sentry-cli send-event -m "Hello from Sentry" -m "This is more text"
Expand Down Expand Up @@ -94,7 +94,7 @@ Releases can be sent with the `--release` parameter. A default release is picked

## Bash Hook

For bash scripts you can also enable automatic error sending by using the sentry-cli bash hook. That enables `set -e` and will send a sentry event for unhandled errors.
For bash scripts you can also enable automatic error sending by using the sentry-cli bash hook. That enables `set -e` and will send a Sentry event for unhandled errors.

The limitations for this are:

Expand Down
2 changes: 1 addition & 1 deletion src/docs/product/security-policy-reporting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Alternatively you can setup CSP reports to simply send reports rather than actua
Content-Security-Policy-Report-Only: ...; report-uri https://___ORG_INGEST_DOMAIN___/api/___PROJECT_ID___/security/?sentry_key=___PUBLIC_KEY___
```

When defining your policy it is important to ensure that `sentry.io` or your self-hosted sentry domain is in your `default-src` or `connect-src` policy, or browsers will block requests that submit policy violations.
When defining your policy it is important to ensure that `sentry.io` or your self-hosted Sentry domain is in your `default-src` or `connect-src` policy, or browsers will block requests that submit policy violations.

For more information, see the article on [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ namespace AspNetMvc

protected void Application_Start()
{
// Set up the sentry SDK
// Set up the Sentry SDK
_sentry = SentrySdk.Init(o =>
{
// We store the DSN inside Web.config; make sure to use your own DSN!
Expand Down
4 changes: 2 additions & 2 deletions src/platforms/android/configuration/gradle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ sentry {
// NOTE: if you have a higher version of the sentry-android SDK or integrations on the classpath, this setting will have no effect
// as Gradle will resolve it to the latest version.
//
// Defaults to the latest published sentry version.
// Defaults to the latest published Sentry version.
sentryVersion = '{{@inject packages.version('sentry.java.android', '5.0.0') }}'
}
Expand Down Expand Up @@ -223,7 +223,7 @@ sentry {
// NOTE: if you have a higher version of the sentry-android SDK or integrations on the classpath, this setting will have no effect
// as Gradle will resolve it to the latest version.
//
// Defaults to the latest published sentry version.
// Defaults to the latest published Sentry version.
sentryVersion.set("{{@inject packages.version('sentry.java.android', '5.0.0') }}")
}

Expand Down
2 changes: 1 addition & 1 deletion src/platforms/android/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ plugins {
}
```

Alternatively, you can tell the plugin to use your version of the sentry NDK:
Alternatively, you can tell the plugin to use your version of the Sentry NDK:

```groovy
sentry {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ repositories:
- **HTTP Symbol Server**: An HTTP server that serves debug files at a
configurable path. Lookups in the server should generally be case-insensitive,
although an explicit casing can be configured in the settings. Note
that sentry requires a minimum download speed of 4Mb/s to fetch DIFs
that Sentry requires a minimum download speed of 4Mb/s to fetch DIFs
from custom HTTP symbol servers.

- **Amazon S3 Bucket**: Either an entire S3 bucket or a subdirectory. This
Expand Down
2 changes: 1 addition & 1 deletion src/platforms/common/profiling/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ gem 'stackprof'
gem 'sentry-ruby'
```

Then, make sure both `traces_sample_rate` and `profiles_sample_rate` are set and non-zero in your sentry initializer.
Then, make sure both `traces_sample_rate` and `profiles_sample_rate` are set and non-zero in your Sentry initializer.

<SignInNote />

Expand Down
4 changes: 2 additions & 2 deletions src/platforms/dotnet/guides/nlog/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -164,11 +164,11 @@ To ignore log messages that don't contain an exception.

#### SendEventPropertiesAsData

Determines whether event-level properties will be sent to sentry as additional data. Defaults to true.
Determines whether event-level properties will be sent to Sentry as additional data. Defaults to true.

#### SendEventPropertiesAsTags

Determines whether event properties will be sent to sentry as Tags or not. Defaults to false.
Determines whether event properties will be sent to Sentry as Tags or not. Defaults to false.

#### IncludeEventDataOnBreadcrumbs

Expand Down
4 changes: 2 additions & 2 deletions src/platforms/elixir/configuration/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,15 @@ The backend can also be configured to capture Logger metadata, which is detailed

`included_environments`

: The list of environments you want to send reports to sentry, this defaults to `[:prod]`.
: The list of environments you want to send reports to Sentry, this defaults to `[:prod]`.

`tags`

: The default tags to send with each report.

`release`

: The release to send to sentry with each report. This defaults to nothing.
: The release to send to Sentry with each report. This defaults to nothing.

`server_name`

Expand Down
2 changes: 1 addition & 1 deletion src/platforms/flutter/upload-debug.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ sentry:

`auth_token`

: The sentry auth token, which will look like `<64 random characters>`. Required. This is a `string` type. The alternative environmental variable is `SENTRY_AUTH_TOKEN`.
: The Sentry auth token, which will look like `<64 random characters>`. Required. This is a `string` type. The alternative environmental variable is `SENTRY_AUTH_TOKEN`.

`upload_debug_symbols`

Expand Down
2 changes: 1 addition & 1 deletion src/platforms/go/common/configuration/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ type ClientOptions struct {
// disabled.
Dsn string
// In debug mode, the debug information is printed to stdout to help you
// understand what sentry is doing.
// understand what Sentry is doing.
Debug bool
// Configures whether SDK should generate and attach stack traces to pure
// capture message calls.
Expand Down
2 changes: 1 addition & 1 deletion src/platforms/javascript/common/install/loader.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ For Session Replay, the defaults are set to `replaysSessionSampleRate: 0.1` and

When using the Loader Script with just errors, the script injects the SDK asynchronously. This means that only _unhandled errors_ and _unhandled promise rejections_ will be caught and buffered before the SDK is fully loaded. Specifically, capturing [breadcrumb data](../../enriching-events/breadcrumbs/) will not be available until the SDK is fully loaded and initialized. To reduce the amount of time these features are unavailable, set `data-lazy="no"` or call `forceLoad()` as described above.

If you want to understand the inner workings of the loader itself, you can read the documented source code in all its glory over at the [sentry repository](https://github.com/getsentry/sentry/blob/master/src/sentry/templates/sentry/js-sdk-loader.ts).
If you want to understand the inner workings of the loader itself, you can read the documented source code in all its glory over at the [Sentry repository](https://github.com/getsentry/sentry/blob/master/src/sentry/templates/sentry/js-sdk-loader.ts).

## CDN

Expand Down
2 changes: 1 addition & 1 deletion src/platforms/javascript/legacy-sdk/config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ autoBreadcrumbs: {
'console': false, // console logging
'dom': true, // DOM interactions, i.e. clicks/typing
'location': false, // url changes, including pushState/popState
'sentry': true // sentry events
'sentry': true // Sentry events
}
```

Expand Down
4 changes: 2 additions & 2 deletions src/platforms/python/guides/beam/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@ sentry_sdk.init(

- The functions get injected with an inspect function to patch getting the [function signature](https://github.com/apache/beam/blob/release-2.13.0/sdks/python/apache_beam/transforms/core.py#L288L298).

- The integration requires sentry to be installed on all the worker computers using a `--requirements_file`.
- The integration requires Sentry to be installed on all the worker computers using a `--requirements_file`.

- The main computer invoking the pipeline requires the same version of sentry as the worker nodes.
- The main computer invoking the pipeline requires the same version of Sentry as the worker nodes.
6 changes: 3 additions & 3 deletions src/platforms/python/guides/pyspark/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,13 @@ if __name__ == '__main__':
...
```

In your `spark_submit` command, add the following configuration options so the spark clusters can use the sentry integration.
In your `spark_submit` command, add the following configuration options so the spark clusters can use the Sentry integration.

| Command Line Options | Parameter | Usage |
| -------------------- | ---------------------------------------- | --------------------------------------------------------------- |
| --py-files | sentry_daemon.py | Sends the `sentry_daemon.py` file to your Spark clusters |
| --conf | spark.python.use.daemon=true | Configures Spark to use a daemon to execute it's Python workers |
| --conf | spark.python.daemon.module=sentry_daemon | Configures Spark to use the sentry custom daemon |
| --conf | spark.python.daemon.module=sentry_daemon | Configures Spark to use the Sentry custom daemon |

```bash
./bin/spark-submit \
Expand All @@ -89,7 +89,7 @@ In your `spark_submit` command, add the following configuration options so the s

## Behavior

- You must have the sentry python sdk installed on all your clusters to use the Spark integration. The easiest way to do this is to run an initialization script on all your clusters:
- You must have the Sentry python sdk installed on all your clusters to use the Spark integration. The easiest way to do this is to run an initialization script on all your clusters:

```bash
easy_install pip
Expand Down
4 changes: 2 additions & 2 deletions src/platforms/python/legacy-sdk/breadcrumbs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ Breadcrumbs are enabled by default but starting with Raven 5.15 you can disable

## Enabling / Disabling Instrumentation {#enabling-disabling-instrumentation}

When a sentry client is constructed then the raven library will by default automatically instrument some popular libraries. There are a few ways this can be controlled by passing parameters to the client constructor:
When a Sentry client is constructed then the raven library will by default automatically instrument some popular libraries. There are a few ways this can be controlled by passing parameters to the client constructor:

`install_logging_hook`:

: If this keyword argument is set to _False_ the Python logging system will not be instrumented. Note that this is a global instrumentation so that if you are using multiple sentry clients at once you need to disable this on all of them.
: If this keyword argument is set to _False_ the Python logging system will not be instrumented. Note that this is a global instrumentation so that if you are using multiple Sentry clients at once you need to disable this on all of them.

`hook_libraries`:

Expand Down
8 changes: 4 additions & 4 deletions src/platforms/python/legacy-sdk/integrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ See the [_Raven.js documentation_](/platforms/javascript/legacy-sdk/) for more i

### Integration with `logging`

To integrate with the standard library’s `logging` module, and send all ERROR and above messages to sentry, the following config can be used:
To integrate with the standard library’s `logging` module, and send all ERROR and above messages to Sentry, the following config can be used:

```python
LOGGING = {
Expand Down Expand Up @@ -1139,7 +1139,7 @@ pip install raven --upgrade

### Setup

The first thing you’ll need to do is to initialize sentry client under your application
The first thing you’ll need to do is to initialize Sentry client under your application

```python
import tornado.web
Expand All @@ -1159,7 +1159,7 @@ application.sentry_client = AsyncSentryClient(

### Usage

Once the sentry client is attached to the application, request handlers can automatically capture uncaught exceptions by inheriting the _SentryMixin_ class.
Once the Sentry client is attached to the application, request handlers can automatically capture uncaught exceptions by inheriting the _SentryMixin_ class.

```python
import tornado.web
Expand Down Expand Up @@ -1253,7 +1253,7 @@ To learn more, see:

> [zconfig.readthedocs.io/en/latest/using-logging.html](https://zconfig.readthedocs.io/en/latest/using-logging.html)
To use with sentry, use the sentry handler tag:
To use with Sentry, use the Sentry handler tag:

```xml
<logger>
Expand Down
2 changes: 1 addition & 1 deletion src/platforms/react-native/manual-setup/hermes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ redirect_from:
- /platforms/react-native/hermes/
---

Sentry added support for `react-native` builds that use the `hermes` engine, which required changes to the sentry SDK, `sentry-cli` as well as Sentry itself.
Sentry added support for `react-native` builds that use the `hermes` engine, which required changes to the Sentry SDK, `sentry-cli` as well as Sentry itself.

Sentry customers using the SaaS product (sentry.io) will need to update the SDK, and `sentry-cli`.
The minimum required version for the SDK is `@sentry/react-native` [SDK version `1.3.3`](https://github.com/getsentry/sentry-react-native/releases/tag/1.3.3),
Expand Down

1 comment on commit 66f62bc

@vercel
Copy link

@vercel vercel bot commented on 66f62bc Aug 25, 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 – ./

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

Please sign in to comment.