Develop docs content #10330

* fix(apidocs): update note about full path * Update src/docs/api/public.mdx Co-authored-by: Seiji Chew <[email protected]> * Update public.mdx --------- Co-authored-by: Seiji Chew <[email protected]>

Update `Making an API Public` section with more recent `@extend_schema` example, new `OpenApiExample` that includes `request_only=True` addition, and warning to update all requests in one endpoint in the same PR if multiple requests in the endpoint previously used manual JSON build.

Co-authored-by: Michi Hoffmann <[email protected]>

Co-authored-by: Karl Heinz Struggl <[email protected]>

Mention new insufficient_data reason for client discard introduced in getsentry/snuba#4407.

Adds the optional monitor_config and contexts to the check-in payload

Clarify that origin should rarely change.

- Handle multiple connections (as we have those now) - Make all imports self contained so that the example is easier to copy/paste.

… deps (#986)

* updated ttid/ttfd docs for app start timestamp and measurements --------- Co-authored-by: Philipp Hofmann <[email protected]>

* docs(issue-platform): Add docs for writing a detector This adds docs for writing a new detector for the issue platform. Content taken from https://www.notion.so/sentry/New-Issues-Vertical-Team-Guide-b4b57f027be949908cbcb8351c171306#78fae32e7bac457987d615235f5d4666 * small fix * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Dameli Ushbayeva <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Matt Quinn <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Matt Quinn <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Matt Quinn <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Matt Quinn <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Matt Quinn <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Matt Quinn <[email protected]> * Update src/docs/issue-platform-detectors.mdx Co-authored-by: Matt Quinn <[email protected]> * Update src/docs/issue-platform-detectors.mdx * Update src/docs/issue-platform-detectors.mdx * Update src/docs/issue-platform-detectors.mdx * Update src/docs/issue-platform-detectors.mdx * Update src/docs/issue-platform-detectors.mdx * Update src/docs/issue-platform-detectors.mdx * Update src/docs/issue-platform-detectors.mdx * Update src/docs/issue-platform-detectors.mdx * Update src/docs/issue-platform-detectors.mdx * Update src/docs/issue-platform-detectors.mdx * Update src/docs/issue-platform-detectors.mdx * fix code blocks and remove unused screenshot * add titles --------- Co-authored-by: Dameli Ushbayeva <[email protected]> Co-authored-by: Matt Quinn <[email protected]>

Add in-line serializer example

…t mutation section (#997)

`released`

Co-authored-by: Alexander Dinauer <[email protected]>

…ag (#1003) Co-authored-by: Manoel Aranda Neto <[email protected]>

* add hard stop for 23.6.2 due to django upgrade * add note around skipping 23.7.0

… and section naming (#1013)

* Add Discord integration docs * Add info message about the url verification failing * Make suggested changes * Add whitespace to create_bot so image isn't so tall * Except with a white background this time

… docs. (#1023) * (dev-doc-detector-threshold-configs): Updated issue platform detector docs to include section highlighting detector threshold configurations. * (dev-doc-detector-threshold-configs): Reverted change to package.json * (dev-doc-detector-threshold-configs): Minor Fixes. --------- Co-authored-by: Abdullah Khan <[email protected]>

For normalizing where we store the HTTP response code in our events we invented the response context: getsentry/team-sdks#9 This PR adds documentation on how this response context should look like.

* docs(apis): Adding API basics * Apply suggestions from code review apply suggested changes Co-authored-by: Shana Matthews <[email protected]> --------- Co-authored-by: Shana Matthews <[email protected]>

Add an SDK Setup Wizards page to the SDK development documentation. The purpose of this page is to - Formulate high-level requirements for setup wizards - Provide instructions around implementing new wizards such as the expected flow, which wizards to base new work on, helper functions and a few UI guidelines.

* docs(api): Add notes on designing new APIs * adding django link * addressing feedback

* docs(api): Update publishing docs * addressed feedback

…1038) The `pyenv_setup.sh` script which runs when you call `make setup-pyenv` in the `sentry` repo only considers the case for zsh wherein the user has their zsh config in `~/.zprofile`. For anyone who doesn't, the script therefore doesn't work. This adds a note to the `zsh` tab of the code snippet telling people to do that part of the setup manually in that case.

View updated instructions [here](https://develop-git-seiji-choreupdate-api-instructions-with-body-5c7898.sentry.dev/api/public/) This PR updates instructions about how to use body params. It also clarifies how optional/nullable fields work in TypedDicts, and also cleans up some language to be more smooth.

* feat: Add example for adding a column to a large table - Add example of deploying schema changes to large tables. We'd like to move away from having SRE run column add migrations and need to document the self-service flow. - Revise TOC to contain more sections and less nesting. - Apply suggestions from code review Co-authored-by: Evan Purkhiser <[email protected]>

Add graphql.validate and graphql.parse as span operations.

We don't need to add columns with dangerous migrations anymore. All column adds can be done as deploy time migrations.

* Add missing slash, to do like other examples * Update src/docs/integrations/slack/index.mdx --------- Co-authored-by: Liza Mock <[email protected]>

…izer info (#1053) * update instructions * add bit more

* spans: add thread label and id to span data conventions * spans: reword thread label and id

Refs getsentry/sentry#58361

…ing docs (#1048)

* docs: Add note to restart snuba after enabling relay After enabling Relay and Kafka, the snuba container configuration needs to be updated, this only happens when re-creating the container.

Refs getsentry/self-hosted#2521

* Initial version of distributed tracing documentation.

* ref(mail): Add mail preview docs * apple stuff * mention using icloud

* Document trial plan properties * Clarify plan flags

…ns (#1079) * docs(issue-platform): Update docs to reflect supported functionality * docs(issue-platform): Update docs for issue platform updates * Status change updates * Update from feedback * Update status change * add space * minor fixes * Fix link * Fix other link * Update src/docs/issue-platform.mdx Co-authored-by: Snigdha Sharma <[email protected]> * Update issue-platform.mdx --------- Co-authored-by: Snigdha Sharma <[email protected]>

the staging environment no longer exists

* Add timer to sending-metrics-sdk Documenting missing capability/example to send timers * Update sending-metrics-sdk.mdx --------- Co-authored-by: Armin Ronacher <[email protected]>

--------- Co-authored-by: Ivana Kellyerova <[email protected]>

These docs now mention the newly introduced relocation scopes, as well as the `sentry-admin.sh` tool.

Add total, slow and frozen frames to span data conventions.

* Rename DDM to Sentry Developer Metrics * Rename DDM to Metrics

…ary (#1110) * docs(stories): Add some initial docs for the /stories/ Component Library * updates from reviewers * undo extra formatting change * also write about stories ownership, and ideas for what to include

…wrappers (#1115) * docs(stories): Add a note about using storyBook() with hooks and HoC wrappers * Update src/docs/frontend/component-library.mdx Co-authored-by: Malachi Willey <[email protected]> --------- Co-authored-by: Malachi Willey <[email protected]>

- we're not on python 2 - we're using pyuwsgi - uwsgi no longer needs to match the compiled python

* Port "Frontend PR Previews" doc from notion * Apply suggestions from code review Co-authored-by: Michelle Zhang <[email protected]> --------- Co-authored-by: Michelle Zhang <[email protected]>

…ary helper (#1122) * docs(ui-lib): Write a blurb about the <ThemeToggle> UI Component Library helper * use tsx highlighting instead of typescript

…ayloads (#1128) Update docs for StatusChangeMessage

Explain how to solve Android emulator events not showing up in local Sentry instance.

* update backup/restore docs to allow parameterization for scripts * change backup/restore options to lowercase

* Update ui.mdx * Update sidebar screenshot * Update ui.mdx

* docs(backup): Describe encryption * sentry-admin.sh -> ./sentry-admin.sh

We dont' use CamelCase, we use camelBacked. While camelBack is generally synonymous with CamelCase, the first letter should be lowercase.

We are currently refactoring our internal concepts of Hubs and Scopes. This page is the starting point of documenting this, making it easier for other SDK developers to implement this in their respective SDK.

According to the example config file, it should be `PyMemcacheCache` not `PyMemcachedCache`

…n trace context (#1157) Added new fields to trace context which could be set by SDKs and are typed out in Relay

Add docs for the performance metric frames delay.

Text edit.

* docs(self-hosted): enabling preview features section * Update index.mdx Co-authored-by: Hubert Deng <[email protected]> --------- Co-authored-by: Hubert Deng <[email protected]>

* add pagination section for apis * Apply suggestions from code review Co-authored-by: Liza Mock <[email protected]> * add sentence about stnardization around self.paginate --------- Co-authored-by: Liza Mock <[email protected]>

* Clarify when normalization should be applied * Clarify flush interval to be 5s * Add section for before_emit_metric callback

There are tips there about the local server that are usefule and best to direct right away

Working on explaining the WHY of doing the refactoring and coming up with a content structure that works. --------- Co-authored-by: Anton Pirker <[email protected]>

* Clarify metrics span seeking/creating mode * Clarify span op/description * Improve wording * Improve wording

Trying to refine hubs/scopes merge docs.

* Update span-data-conventions.mdx * Update span-data-conventions.mdx

Explain what the various subdomains are in a DSN and explain the backwards compatibility for US accounts

* Update index.mdx * Update sidebar.tsx

With the work on hubs and scopes refactoring, this page needs a disclaimer even more than before https://develop.sentry.dev/sdk/hub_and_scope_refactoring/ --------- Co-authored-by: Anton Pirker <[email protected]> Co-authored-by: Alexander Dinauer <[email protected]>

* document POTEL learnings from Java research * wording changes etc. * remove TODOs * Apply suggestions from code review Co-authored-by: Ivana Kellyerova <[email protected]> --------- Co-authored-by: Ivana Kellyerova <[email protected]>

* Expand database migration docs to also cover migration deployment as it is now tool based instead of process based. * Give more context on when to use postdeploy migrations * Fix image paths

Adds a new rate limit component to quota limits in the `x-sentry-rate-limits` header that communicates the namespace(s) that a metrics rate limit should apply to. The data category of limits that have this component is always `metric_bucket`, in other quotas this component will not be set. SDKs are instructed not to send metrics for a certain namespace if a rate limit for that same namespace is active. The default namespace for metrics (used by DDM) is "custom". --------- Co-authored-by: Luca Forstner <[email protected]>

* Add a mapping from old to new hub API * Update hub_and_scope_refactoring.mdx * Update hub_and_scope_refactoring.mdx * Update hub_and_scope_refactoring.mdx * missing parentheses * trying some formatting * more formatting * Update hub_and_scope_refactoring.mdx * Update hub_and_scope_refactoring.mdx * Table reformat * Update hub_and_scope_refactoring.mdx * Polishing the table * Use <code> instead of <pre> * Missing ` -> <code> * typo * Update src/docs/sdk/hub_and_scope_refactoring.mdx Co-authored-by: Daniel Szoke <[email protected]> --------- Co-authored-by: Daniel Szoke <[email protected]>

Co-authored-by: Jan Michael Auer <[email protected]>

Add a recommendation for the memory footprint of the aggregator for mobile SDKs.

Co-authored-by: Lukas Stracke <[email protected]>

* adds user-agent format * adds info about semicolon separator * adds examples for basic user agent * Update src/docs/sdk/overview.mdx Co-authored-by: Joris Bayer <[email protected]> --------- Co-authored-by: Joris Bayer <[email protected]>

* Add link to live workshop about migrating to SaaS Add link to workshop until April 30th, then change to recorded video once date passes. * Update src/docs/self-hosted/index.mdx * Update src/docs/self-hosted/index.mdx

* Add docs for options based feature flags Add docs for the new way to use options based feature flags * fixes

… of the repo (#1238)

)

* removes lockreason from sidebar & adds note * adds link to Threads interface

Add a new field features to the sdk event payload, which is handy for tracking the adoption of features.

* feat: Add `app.app_arch` context * also fix typos

* feat: add Linux distributions to the os context * Link to official docs and a list of distribution identifiers Also mention the /etc/os-release keys and how they map to the ones in the distribution object.

* fix(handbook): add type decl section * Update src/docs/frontend/index.mdx Co-authored-by: Ryan Albrecht <[email protected]> --------- Co-authored-by: Ryan Albrecht <[email protected]>

* docs(frontend): Add a page for Using Styled Components * review comments * Update src/docs/frontend/using-styled-components.mdx Co-authored-by: Michelle Zhang <[email protected]> * Update src/docs/frontend/using-styled-components.mdx Co-authored-by: Michelle Zhang <[email protected]> --------- Co-authored-by: Michelle Zhang <[email protected]>

…me the version (#1256)

Minor grammar correction

* Add ttid/ttfd contribution flags to span data convention * Move ttid/ttfd to new ui namespace * Update src/docs/sdk/performance/span-data-conventions.mdx Co-authored-by: Philipp Hofmann <[email protected]> --------- Co-authored-by: Philipp Hofmann <[email protected]>

…e PRs (#1259)

We generally prefer people to use options automator, so remove references to flagr. We can update this with instructions for flagpole once it is completed.

* Update relevant span data conventions * Add Requests module documentation

* Move these out of notion into an easier to find long-term home. More multiregion docs will be added as they are completed. * Use better aside markup --------- Co-authored-by: Matt Duncan <[email protected]>

- Add docs on how to run siloed servers locally - Add docs on maintaining split silo databases --------- Co-authored-by: Matt Duncan <[email protected]>

Add high-level functional docs for the api gateway, integration proxy, and webhook forwarding systems of multi-region sentry. * Update port list * Use mermaid.live for diagrams. * Fix image link --------- Co-authored-by: Matt Duncan <[email protected]>

…1255) * docs(self-hosted): recommend users to rerun install.sh for restart * docs(self-hosted): use stronger words for install.sh

* feat: Add docs for cross-region RPC * Apply suggestions from code review --------- Co-authored-by: Matt Duncan <[email protected]>

Add docs on multi-region testing helpers

Include multi-region architecture diagram and context on how other diagrams fit together.

* docs(trace-view): Updating docs referencing the trace view. * Update src/docs/sdk/research/performance/index.mdx Co-authored-by: Liza Mock <[email protected]> --------- Co-authored-by: Abdullah Khan <[email protected]> Co-authored-by: Liza Mock <[email protected]>

)

…1281)

* Docs for LLM monitoring * Add notes field to table

* WIP - design tenets port from notion * Add one image, drop the rest * Update src/docs/frontend/design-tenets.mdx

…1284) Documents the conditions for collecting span metrics to satisfy the screen loads module. The screen loads module filters for specifically ui.load transactions and will surface data from the following spans.

propogate -> propagate

* Made more easy to read * Updated outdataed information

- explain required vs. optional parameters - clean up structure - add more detail to example

Co-authored-by: Mark Story <[email protected]>

Added three missing categories, sorted the list of categories and formatted the doc.

move develoer docs content to sdk docs

Commits on Aug 7, 2023

Fix typo in testing.mdx (#1012 )

michellewzhang committed Aug 7, 2023

Configuration menu

View commit details

Copy full SHA for 811767c

Browse repository at this point

Copy the full SHA

811767c View commit details

Browse the repository at this point in the history

Commits on Aug 9, 2023

Add new database span data (#1016 )

AbhiPrasad committed Aug 9, 2023

Configuration menu

View commit details

Copy full SHA for 938969b

Browse repository at this point

Copy the full SHA

938969b View commit details

Browse the repository at this point in the history

Commits on Aug 14, 2023

devenv: update createuser stuff (#1017 )

joshuarli committed Aug 14, 2023

Configuration menu

View commit details

Copy full SHA for 89875a7

Browse repository at this point

Copy the full SHA

89875a7 View commit details

Browse the repository at this point in the history

Commits on Nov 8, 2023

Update sending-metrics-sdk.mdx (#1078 )

mitsuhiko committed Nov 8, 2023

Configuration menu

View commit details

Copy full SHA for 9176c1e

Browse repository at this point

Copy the full SHA

9176c1e View commit details

Browse the repository at this point in the history

Commits on Nov 17, 2023

Update HTTP Client Integration (#1084 )

cleptric committed Nov 17, 2023

Configuration menu

View commit details

Copy full SHA for 0201381

Browse repository at this point

Copy the full SHA

0201381 View commit details

Browse the repository at this point in the history

Commits on Dec 7, 2023

Added metrics development docs (#1098 )

mitsuhiko committed Dec 7, 2023

Configuration menu

View commit details

Copy full SHA for 7bd2f00

Browse repository at this point

Copy the full SHA

7bd2f00 View commit details

Browse the repository at this point in the history

Commits on Dec 14, 2023

Fix typo (#1109 )

cdelst committed Dec 14, 2023

Configuration menu

View commit details

Copy full SHA for 2873297

Browse repository at this point

Copy the full SHA

2873297 View commit details

Browse the repository at this point in the history

Commits on Jan 9, 2024

Update metrics.mdx (#1123 )

cleptric committed Jan 9, 2024

Configuration menu

View commit details

Copy full SHA for cdf73ed

Browse repository at this point

Copy the full SHA

cdf73ed View commit details

Browse the repository at this point in the history

Commits on Jan 10, 2024

Update fidelity-and-biases.mdx (#1085 )

TBS1996 committed Jan 10, 2024

Configuration menu

View commit details

Copy full SHA for 54c03c7

Browse repository at this point

Copy the full SHA

54c03c7 View commit details

Browse the repository at this point in the history

Commits on Jan 23, 2024

remove prop types (#1138 )

JonasBa committed Jan 23, 2024

Configuration menu

View commit details

Copy full SHA for 907600d

Browse repository at this point

Copy the full SHA

907600d View commit details

Browse the repository at this point in the history

Commits on Feb 26, 2024

Removed obsolete warning (#1168 )

antonpirker committed Feb 26, 2024

Configuration menu

View commit details

Copy full SHA for 6daec5b

Browse repository at this point

Copy the full SHA

6daec5b View commit details

Browse the repository at this point in the history

Commits on May 6, 2024

Queue Integration (#1248 )

cleptric committed May 6, 2024

Configuration menu

View commit details

Copy full SHA for c89d88e

Browse repository at this point

Copy the full SHA

c89d88e View commit details

Browse the repository at this point in the history

Commits on May 23, 2024

Update caches.mdx (#1289 )

cleptric committed May 23, 2024

Configuration menu

View commit details

Copy full SHA for 6c1b2b2

Browse repository at this point

Copy the full SHA

6c1b2b2 View commit details

Browse the repository at this point in the history

Commits on May 24, 2024

Fix typo (#1265)

propogate -> propagate

andrii-st committed May 24, 2024

Configuration menu

View commit details

Copy full SHA for 9717389

Browse repository at this point

Copy the full SHA

9717389 View commit details

Browse the repository at this point in the history

Commits on May 27, 2024

Update ui.mdx

matejminar committed May 27, 2024

Configuration menu

View commit details

Copy full SHA for f60c2b4

Browse repository at this point

Copy the full SHA

f60c2b4 View commit details

Browse the repository at this point in the history

Develop docs content #10330

Develop docs content #10330

Commits on Jun 8, 2023

Commits on Jun 12, 2023

Commits on Jun 14, 2023

Commits on Jun 22, 2023

Commits on Jun 23, 2023

Commits on Jun 25, 2023

Commits on Jun 26, 2023

Commits on Jun 27, 2023

Commits on Jun 29, 2023

Commits on Jun 30, 2023

Commits on Jul 4, 2023

Commits on Jul 7, 2023

Commits on Jul 10, 2023

Commits on Jul 12, 2023

Commits on Jul 13, 2023

Commits on Jul 17, 2023

Commits on Jul 18, 2023

Commits on Jul 20, 2023

Commits on Jul 25, 2023

Commits on Jul 26, 2023

Commits on Jul 27, 2023

Commits on Jul 31, 2023

Commits on Aug 2, 2023

Commits on Aug 4, 2023

Commits on Aug 7, 2023

Commits on Aug 8, 2023

Commits on Aug 9, 2023

Commits on Aug 11, 2023

Commits on Aug 14, 2023

Commits on Aug 16, 2023

Commits on Aug 17, 2023

Commits on Aug 29, 2023

Commits on Sep 8, 2023

Commits on Sep 12, 2023

Commits on Sep 14, 2023

Commits on Sep 15, 2023

Commits on Sep 19, 2023

Commits on Sep 21, 2023

Commits on Sep 25, 2023

Commits on Sep 28, 2023

Commits on Oct 3, 2023

Commits on Oct 4, 2023

Commits on Oct 6, 2023

Commits on Oct 10, 2023

Commits on Oct 11, 2023

Commits on Oct 16, 2023

Commits on Oct 17, 2023

Commits on Oct 18, 2023

Commits on Oct 19, 2023

Commits on Oct 23, 2023

Commits on Oct 26, 2023

Commits on Oct 31, 2023

Commits on Nov 3, 2023

Commits on Nov 6, 2023

Commits on Nov 7, 2023

Commits on Nov 8, 2023

Commits on Nov 9, 2023

Commits on Nov 11, 2023

Commits on Nov 13, 2023

Commits on Nov 16, 2023

Commits on Nov 17, 2023

Commits on Nov 21, 2023

Commits on Nov 24, 2023

Commits on Nov 28, 2023

Commits on Dec 1, 2023

Commits on Dec 6, 2023

Commits on Dec 7, 2023

Commits on Dec 11, 2023

Commits on Dec 12, 2023

Commits on Dec 13, 2023

Commits on Dec 14, 2023

Commits on Dec 18, 2023

Commits on Dec 19, 2023

Commits on Dec 21, 2023

Commits on Dec 22, 2023

Commits on Jan 2, 2024

Commits on Jan 8, 2024

Commits on Jan 9, 2024