Merge branch 'master' into antonpirker/develop-docs-sidebar

Author: antonpirker

apps/changelog/package.json

@@ -14,6 +14,9 @@
     "lint": "next lint",
     "migrate:dev": "dotenv -e .env.development -- yarn prisma migrate reset"
   },
+  "prisma": {
+    "seed": "node prisma/seed/seed.mjs"
+  },
   "dependencies": {
     "@auth/prisma-adapter": "^1.2.0",
     "@google-cloud/storage": "^7.7.0",

apps/changelog/prisma/seed/seed.mjs

@@ -76,6 +76,7 @@ async function seed() {
     console.log('Seed data created successfully!');
   } catch (error) {
     console.error('Error seeding data:', error);
+    process.exit(1);
   } finally {
     await prisma.$disconnect();
   }

develop-docs/api-server/api/public.mdx

@@ -483,6 +483,30 @@ NOTE: The `openapi-diff` test is supposed to fail when CI runs on your pull requ
 
 ---
 
+**Problem**: `drf_spectacular.plumbing.UnableToProceedError' <class 'serializer_path.FooSerializer'> ... raise UnableToProceedError(hint)`
+
+**Solution**: Check that the response of your API documentation is using a TypedDict rather than a serializer.
+
+If the schema looks something like this:
+```python
+...
+200: inline_sentry_response_serializer(
+                "ListDocIntegrationResponse", list[FooSerializer]
+            ),
+```
+
+Then you need to change it to use a TypedDict by first typing the serializer, then updating the schema to use the TypedDict:
+```python
+...
+200: inline_sentry_response_serializer(
+                "ListDocIntegrationResponse", list[FooSerializerResponse]
+            ),
+```
+
+Refer to the section above on [Success Responses](#success-responses) for more information.
+
+---
+
 ## Requesting an API to be public
 
 Are you a Sentry user who wants an endpoint to be public?

develop-docs/sdks/data-model/event-payloads/contexts.mdx

@@ -832,3 +832,37 @@ The required field is `package` which should contain the package or framework wh
   }
 }
 ```
+
+## Feature Flag Context
+
+The feature flag context contains information about the flags evaluated prior to an error occurring. Flag evaluation results are placed into the `values` key which is an array of 0 or more flag evaluation result objects.
+
+`flag`
+
+: **Required.** The name of the flag which was evaluated.
+
+- Example: `"feature-is-enabled"`
+
+`result`
+
+: **Required.** The boolean result of flag evaluation.
+
+- Example: `false`
+
+
+### Example Feature Flag Context
+
+```json
+{
+  "contexts": {
+    "flags": {
+      "values": [
+        {
+          "flag": "my_flag_name",
+          "result": true
+        }
+      ]
+    }
+  }
+}
+```

develop-docs/sdks/expected-features/index.mdx

@@ -91,6 +91,27 @@ Local variable names and values for each stack frame, where possible. Restrictio
 
 This functionality should be gated behind the `includeLocalVariables` option, which is `true` by default.
 
+## Feature Flags
+
+An SDK may expose a Scope property for tracking feature flag evaluations. When the scope forks, it's important to clone the feature flags property. Leaking flag evaluations between threads could lead to inaccurate feature flag evaluation logs.
+
+The Scope's flag property should have a capped capacity and should prefer recently-evaluated flags over less-recently-evaluated flags. The recommended data structure is a LRU-cache but it is not required so long as the data structure behaves similarly. Serious deviations from the behavior of an LRU-cache should be documented for your language.
+
+The Scope's flag property should expose two methods: `get/0` and `set/2`. `set/2` takes two arguments. The first argument is the name of the flag. It is of type string. The second argument is the evaluation result. It is of type boolean. `set/2` should remove all entries from the LRU-cache which match the provided flag's name and append the new evaluation result to the end of the queue. `get/0` accepts zero arguments. The `get/0` method must return a list of serialized flag evaluation results in order of evaluation. Oldest values first, newest values last. See the <Link to="/sdk/data-model/event-payload/contexts/#feature-flag-context">Feature Flag Context</Link> protocol documentation for details.
+
+### Integrations
+
+Integrations automate the work of tracking feature flag evaluations and serializing them on error context. An integration should hook into third-party SDK and record feature flag evaluations using the current scope. For example, in Python an integration would call `sentry_sdk.get_current_scope().flags.set(...)` on each flag evaluation.
+
+An integration is also responsible for registering an "on error" hook with the Sentry SDK. When an error occurs the integration should request the current scope and serialize the flags property. For example, in Python an integration might define this callback function:
+
+```python
+def flag_error_processor(event, exc_info):
+    scope = sentry_sdk.get_current_scope()
+    event["contexts"]["flags"] = {"values": scope.flags.get()}
+    return event
+```
+
 ## Desymbolication
 
 Turn compiled or obfuscated code/method names in stack traces back into the original. Desymbolication always requires Sentry backend support. Not necessary for many languages.

develop-docs/sdks/processes/releases.mdx

@@ -47,8 +47,8 @@ We're just interested in making a GitHub release and a PyPI release so our
 ```yaml
 minVersion: 0.28.1
 targets:
-- name: pypi
-- name: github
+  - name: pypi
+  - name: github
 ```
 
 ### `scripts/bump-version.sh`
@@ -147,6 +147,64 @@ add a label to.
 
 [issue in `publish`]: https://github.com/getsentry/publish/issues
 
+## Version name conventions
+
+To keep versioning consistent across SDKs, we generally follow [semantic versioning (semver)](https://semver.org/), with language- or platform-specific conventions around semver (if applicable).
+Craft has some precautionary checks to ensure we only publish valid, semver-like versions.
+Specifically, craft expects versions following this format:
+
+```txt
+<major>.<minor>.<patch>(-<prerelease>)?(-<build>)?
+```
+
+While the major, minor and patch version numbers are required, pre-release and build properties are optional but can also be combined.
+
+### Pre-releases (`<prerelease>`)
+
+If you want to create a preview or pre-release of your SDK, you can append a pre-release identifier, as well as an optional incremental pre-release number to your version.
+This will ensure that various craft publishing targets will treat the release as a pre-release, meaning for example that it will not get assigned a `latest` tag in package repositories.
+Likewise, pre-releases will not be inserted into our internal release-registry, which is used by the Sentry product as well as our docs and other tools to query the latest or specific releases of our packages.
+
+Importantly, we have strict rules around which identifiers we accept as a pre-release, meaning the `<prerelease>` part of your version has to be one of the following: `preview|pre|rc|dev|alpha|beta|unstable|a|b`.
+Therefore, we **do not accept** arbitrary strings as pre-release identifiers. Using any other identifiers will result in a release being considered stable instead. This means, it will get assigned a `latest` tag in package repositories and inserted into our release-registry.
+
+Examples:
+
+```txt
+// valid
+1.0.0-preview
+1.0.0-alpha.0
+1.0.0-beta.1
+1.0.0-rc.20
+1.0.0-a
+
+// invalid or incorrectly treated
+1.0.0-foo
+1.0.0-canary.0
+```
+
+#### Special Case: Post Releases
+
+Python has the concept of post releases, which craft handles implicitly. A post release is indicated by a `-\d+` suffix to the semver version, for example: `1.0.0-1`.
+Given that we only consider certain identifiers as [valid pre-release identifiers](#pre-releases-prerelease), post releases are considered stable releases.
+
+### Build identifiers (`<build>`)
+
+In some cases, you can append a build identifier to your version, for example if you release the same package version for different platforms or architectures.
+You can also combine build and pre-release identifiers but in this case, the pre-release identifier has to come first.
+
+Examples:
+
+```txt
+// valid
+1.0.0+x86_64
+1.0.0-rc.1+x86_64
+
+// invalid or incorrectly treated
+1.0.0+rc.1+x86_64
+1.0.0+x86_64-beta.0
+```
+
 ## [Optional] Using Multiple Craft Configs in a Repo
 
 In some cases, we need to maintain multiple or diverging publishing configs in a repository.
@@ -165,7 +223,7 @@ Add `craft_config_from_merge_target: true` when calling `getsentry/action-prepar
 jobs:
   release:
     runs-on: ubuntu-latest
-    name: 'Release a new version'
+    name: "Release a new version"
     steps:
       # ...
       - name: Prepare release

docs/concepts/migration/index.mdx

@@ -7,7 +7,7 @@ description: "Learn more about the reasons to move to Sentry's SaaS solution, wh
 Sentry offers a cloud-hosted, software-as-a-service (SaaS) solution in addition to a self-hosted solution, which are both functionally the same. However, many customers find that self-hosted Sentry can quickly become expensive to maintain, scale, and support, making our SaaS product the better and less costly option. To facilitate moving from self-hosted to SaaS, we provide a self-serve process known as "relocation".
 
 <Alert>
-Check out this video on [**Migrating to Sentry SaaS**](https://sentry.io/resources/migrate-to-sentry-saas-workshop/) to learn about our relocation tooling.
+Check out this video on <a href="https://sentry.io/resources/migrate-to-sentry-saas-workshop/" className="plausible-event-name=migrating+to+saas+video">**Migrating to Sentry SaaS**</a> to learn about our relocation tooling.
 </Alert>
 
 For additional reading on considering SaaS, take a look at:

docs/contributing/pages/banners.mdx

@@ -0,0 +1,72 @@
+---
+title: Banners
+noindex: true
+sidebar_order: 80
+---
+
+You can add arbitrary banners to the top of a page by adding adding an entry to the `BANNERS` array on
+the `banner/index.tsx` file. The `BANNERS` array is an array of objects with the following properties:
+
+```typescript {filename:banner/index.tsx}
+type BannerType = {
+  /** This is an array of strings or RegExps to feed into new RegExp() */
+  appearsOn: (string | RegExp)[];
+  /** The label for the call to action button */
+  linkText: string;
+  /** The destination url of the call to action button */
+  linkURL: string;
+  /** The main text of the banner */
+  text: string;
+  /** Optional ISO Date string that will hide the banner after this date without the need for a rebuild */
+  expiresOn?: string;
+};
+```
+
+ You can add as many banners as you like. If you need to disable all banners, simply delete them from the array.
+
+ Each banner is evaluated in order, and the first one that matches will be shown.
+
+Examples:
+
+```typescript {filename:banner/index.tsx}
+// ...
+// appearsOn = [];              // This is disabled
+// appearsOn = ['^/$'];         // This is enabled on the home page
+// appearsOn = ['^/welcome/'];  // This is enabled on the "/welcome" page
+// ...
+
+const BANNERS = [
+  // This one will take precedence over the last banner in the array
+  // (which matches all /platforms pages), because it matches first.
+  {
+    appearsOn: ['^/platforms/javascript/guides/astro/'],
+    text: 'This banner appears on the Astro guide',
+    linkURL: 'https://sentry.io/thought-leadership',
+    linkText: 'Get webinarly',
+  },
+
+  // This one will match the /welcome page and all /for pages
+  {
+    appearsOn: ['^/$', '^/platforms/'],
+    text: 'This banner appears on the home page and all /platforms pages',
+    linkURL: 'https://sentry.io/thought-leadership',
+    linkText: 'Get webinarly',
+  },
+];
+
+```
+
+Optionally, you can add an `expiresOn` property to a banner to hide it after a certain date without requiring a rebuild or manual removeal.
+the ISO Date string should be in the format `YYYY-MM-DDTHH:MM:SSZ` to be parsed correctly and account for timezones.
+
+```typescript {filename:banner/index.tsx}
+const BANNERS = [
+  {
+    appearsOn: ['^/$'],
+    text: 'This home page banner will disappear after 2024-12-06',
+    linkURL: 'https://sentry.io/party',
+    linkText: 'RSVP',
+    expiresOn: '2024-12-06T00:00:00Z',
+  },
+];
+```

docs/organization/integrations/index.mdx

@@ -16,6 +16,7 @@ For more details, see the [full Integration Platform documentation](/organizatio
 
 | Integration                                                              | Issue alerts | Metric alerts | Link Unfurling |
 | ------------------------------------------------------------------------ | ------------ | ------------- | -------------- |
+| [All Quiet](https://docs.allquiet.app/integrations/inbound/sentry)               | X            |               |                |
 | [Blar](/organization/integrations/notification-incidents/blar/)               | X            |               |                |
 | [Datadog](https://docs.datadoghq.com/integrations/sentry/)               | X            |               |                |
 | [Microsoft Teams](/organization/integrations/notification-incidents/msteams/) | X            | X             |                |

docs/organization/integrations/notification-incidents/index.mdx

@@ -4,6 +4,7 @@ sidebar_order: 20
 description: "Learn more about Sentry's notification and incidents integrations."
 ---
 
+- [All Quiet](https://docs.allquiet.app/integrations/inbound/sentry)
 - [Blar](/organization/integrations/notification-incidents/blar/)
 - [Datadog](https://docs.datadoghq.com/integrations/sentry/)
 - [Microsoft Teams](/organization/integrations/notification-incidents/msteams/)