Skip to content

Commit

Permalink
fix some develop 404s (#10763)
Browse files Browse the repository at this point in the history
* fix some develop 404s

* fix crash reporter url

* fix relay protocol url

* fix relay protocol url
  • Loading branch information
stephanie-anderson authored Jul 17, 2024
1 parent a5a65df commit b237d05
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 18 deletions.
6 changes: 3 additions & 3 deletions develop-docs/application/dynamic-sampling/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Inside the project configuration there is a field dedicated to sampling, named `

#### The Rule Definition

A **rule** is the core component of the sampling configuration and is defined as [SamplingRule](https://getsentry.github.io/relay/relay_sampling/struct.SamplingRule.html) in Relay.
A **rule** is the core component of the sampling configuration and is defined as [SamplingRule](https://getsentry.github.io/relay/relay_sampling/config/struct.SamplingRule.html) in Relay.

An example of rule encoded in JSON is the following:

Expand Down Expand Up @@ -68,14 +68,14 @@ A sampling decision involves:

_In case no match is found, or there are problems during matching, Relay will accept the event under the assumption that we prefer to oversample rather than drop events._

Relay samples with two [SamplingConfig](https://getsentry.github.io/relay/relay_sampling/struct.SamplingConfig.html) instances, namely **non-root sampling configuration** and **root sampling configuration**. The non-root config is the config of the project to which the incoming event belongs, whereas the root config is the config of the project to which the head transaction of the trace belongs. _In case no root sampling configuration is available, only transaction sampling will be performed._
Relay samples with two [SamplingConfig](https://getsentry.github.io/relay/relay_sampling/config/struct.SamplingConfig.html) instances, namely **non-root sampling configuration** and **root sampling configuration**. The non-root config is the config of the project to which the incoming event belongs, whereas the root config is the config of the project to which the head transaction of the trace belongs. _In case no root sampling configuration is available, only transaction sampling will be performed._

Once both configurations are fetched, Relay will **compute a merged configuration** (following the algorithm defined [here](https://getsentry.github.io/relay/relay_sampling/fn.merge_rules_from_configs.html)) consisting of all the transaction rules of the non-root project, **concatenated** to all the trace rules of the root project. This will result in a single configuration containing all the rules that Relay is going to try and match (**from top to bottom**). _The order of the rules of the same type is important, as it will influence the sampling decision._

With the merged configurations, Relay is ready to match the rules. During matching, Relay will inspect two payloads:

- [Event](https://getsentry.github.io/relay/relay_general/protocol/struct.Event.html): inspected when the non-root project to has at least one transaction sampling rule.
- [Dynamic Sampling Context (DSC)](https://getsentry.github.io/relay/relay_sampling/struct.DynamicSamplingContext.html): inspected when the root project (the project of the head of the trace) has at least one trace sampling rule.
- [Dynamic Sampling Context (DSC)](https://getsentry.github.io/relay/relay_sampling/dsc/struct.DynamicSamplingContext.html): inspected when the root project (the project of the head of the trace) has at least one trace sampling rule.

The matching that Relay will perform is going to be based on the `samplingValue` of the rules encountered. As specified in the section above, based on the type of `samplingValue`, we will either immediately return or continue matching other rules. More details about the matching algorithm can be found in the implementation [here](https://getsentry.github.io/relay/relay_sampling/struct.SamplingMatch.html#method.match_against_rules).

Expand Down
2 changes: 1 addition & 1 deletion develop-docs/integrations/azuredevops.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ vsts.client-id: your-app-id
vsts.client-secret: your-client-secret
```
Follow our [documentation on installing and configuring the Azure DevOps integration](https://docs.sentry.io/product/integrations/azure-devops/) to finish installation and use the integration.
Follow our [documentation on installing and configuring the Azure DevOps integration](https://docs.sentry.io/organization/integrations/source-code-mgmt/azure-devops/) to finish installation and use the integration.
2 changes: 1 addition & 1 deletion develop-docs/integrations/msteams/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ msteams.client-secret: 'your-bot-secret'
You should see a message in the General channel that says "Welcome to Sentry for Microsoft Teams". If you do not get this message, it means was something went wrong and you'll need to uninstall, fix the problem, and re-install it.
Follow our [documentation on using the Microsoft Teams integration](https://docs.sentry.io/product/integrations/msteams/) to use the integration.
Follow our [documentation on using the Microsoft Teams integration](https://docs.sentry.io/organization/integrations/notification-incidents/msteams/) to use the integration.
## Troubleshooting
Expand Down
2 changes: 1 addition & 1 deletion develop-docs/sdk/event-payloads/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ code.

If documentation is lacking or outdated, please let us know by [opening an issue](https://github.com/getsentry/develop/issues/new).

SDK developers might benefit from consulting the [source code defining the protocol as understood by the server](https://github.com/getsentry/relay/tree/master/relay-general/src/protocol).
SDK developers might benefit from consulting the [documentation](https://getsentry.github.io/relay/relay_event_schema/protocol/index.html) and [source code](https://github.com/getsentry/relay/tree/master/relay-event-schema/src/protocol) defining the protocol as understood by the server.

</markdown></Alert>

Expand Down
18 changes: 9 additions & 9 deletions develop-docs/sdk/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Sentry provides the following endpoints:
- <Link to="/sdk/envelopes">/envelope/</Link> for any submission using Envelopes.
- <Link to="/sdk/store">/store/</Link> for plain JSON event submission.
- [`/minidump/`](https://docs.sentry.io/platforms/native/minidump/) for multipart requests containing Minidumps.
- [`/unreal/`](https://docs.sentry.io/platforms/native/ue4/) for Unreal
- [`/unreal/`](https://docs.sentry.io/platforms/unreal/configuration/setup-crashreporter/) for Unreal
Engine 4 crash reports.
- [`/security/`](https://docs.sentry.io/error-reporting/security-policy-reporting/) for Browser
CSP reports, usually configured in a browser instead of an SDK.
Expand Down Expand Up @@ -194,18 +194,18 @@ it’s possible to send these values via the querystring:
`sentry_client`

: **Recommended.** An arbitrary string that identifies your SDK, including its version. The
typical pattern for this is `client_name/client_version`.<br/>
typical pattern for this is `client_name/client_version`.<br/>
For example, the Python SDK might send this as `sentry.python/1.0`.

`sentry_timestamp`

: The unix timestamp representing the time at which this event was generated.<br/>
: The unix timestamp representing the time at which this event was generated.<br/>
*This key is effectively deprecated, and it is ignored on the receiving side.
Use the [`sent_at` envelope header](/sdk/envelopes/#envelope-headers) instead.*

`sentry_secret`

: The secret key which should be provided as part of the SDK configuration.<br/>
: The secret key which should be provided as part of the SDK configuration.<br/>
*This key is effectively deprecated, and no longer needs to be set. However, since it was required in older versions,
it should still be allowed and passed through to Sentry if set.*

Expand All @@ -232,8 +232,8 @@ The following additional headers are permitted as per CORS policy:

### User Agent

All SDKs are expected to report their name and version via the `user-agent` header.
The following format should be used (unless required or recommended differently by the platform,
All SDKs are expected to report their name and version via the `user-agent` header.
The following format should be used (unless required or recommended differently by the platform,
e.g. for browser SDKs, where the user agent header must be set by the browser itself):

`{sdk-name}/{sdk-version}`
Expand All @@ -244,13 +244,13 @@ For example:
- `sentry-ruby/5.17.3`
- `sentry.cocoa/8.24.0`
Additional information about the runtime, operating system, and others can be
Additional information about the runtime, operating system, and others can be
appended as comments in parentheses, separated by `; ` (semicolon and space), like so:
`{sdk-name}/{sdk-version} ({runtime-name} {runtime-version}; {os-name} {os-version})`
There is no expectation towards the presence or order of fields. The user agent
must not contain PII or otherwise sensitive data. In general it should not contain
There is no expectation towards the presence or order of fields. The user agent
must not contain PII or otherwise sensitive data. In general it should not contain
any information that is not already present in the payload.
Expand Down
4 changes: 1 addition & 3 deletions develop-docs/sdk/performance/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ This should give an overview of the APIs that SDKs need to implement, without
mandating internal implementation details.

Reference implementations:

- [`@sentry/tracing`
(JavaScript)](https://github.com/getsentry/sentry-javascript/tree/master/packages/tracing)
- [JavaScript SDK](https://github.com/getsentry/sentry-javascript/tree/master/packages/core/src/tracing)
- [Python SDK](https://github.com/getsentry/sentry-python/blob/master/sentry_sdk/tracing.py)

## SDK Configuration
Expand Down

0 comments on commit b237d05

Please sign in to comment.