{"componentChunkName":"component---src-templates-platform-tsx","path":"/platforms/dotnet/configuration/options/","result":{"data":{"file":{"id":"1f215086-69e5-5dec-aaf5-cca7c0665afb","relativePath":"common/configuration/options.mdx","sourceInstanceName":"platforms","childMarkdownRemark":null,"childMdx":{"body":"function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }\n\nfunction _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }\n\nfunction _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }\n\n/* @jsx mdx */\nvar _frontmatter = {\n  \"title\": \"Basic Options\",\n  \"sidebar_order\": 1,\n  \"description\": \"Learn more about how to configure the SDK. These options are set when the SDK is first initialized, passed to the `init()` as an object.\"\n};\n\nvar makeShortcode = function makeShortcode(name) {\n  return function MDXDefaultShortcode(props) {\n    console.warn(\"Component \" + name + \" was not imported, exported, or provided by MDXProvider as global scope\");\n    return mdx(\"div\", props);\n  };\n};\n\nvar PlatformContent = makeShortcode(\"PlatformContent\");\nvar ConfigKey = makeShortcode(\"ConfigKey\");\nvar PlatformSection = makeShortcode(\"PlatformSection\");\nvar layoutProps = {\n  _frontmatter: _frontmatter\n};\nvar MDXLayout = \"wrapper\";\nreturn function MDXContent(_ref) {\n  var components = _ref.components,\n      props = _objectWithoutProperties(_ref, [\"components\"]);\n\n  return mdx(MDXLayout, _extends({}, layoutProps, props, {\n    components: components,\n    mdxType: \"MDXLayout\"\n  }), mdx(\"p\", null, \"SDKs are configurable using a variety of options. The options are largely standardized among SDKs, but there are some differences to better accommodate platform peculiarities. Options are set when the SDK is first\\ninitialized.\"), mdx(PlatformContent, {\n    includePath: \"configuration/config-intro\",\n    mdxType: \"PlatformContent\"\n  }), mdx(\"h2\", {\n    \"id\": \"common-options\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", _extends({\n    parentName: \"h2\"\n  }, {\n    \"href\": \"#common-options\",\n    \"aria-label\": \"common options permalink\",\n    \"className\": \"anchor before\"\n  }), mdx(\"svg\", _extends({\n    parentName: \"a\"\n  }, {\n    \"viewBox\": \"0 0 24 24\",\n    \"xmlns\": \"http://www.w3.org/2000/svg\"\n  }), mdx(\"path\", _extends({\n    parentName: \"svg\"\n  }, {\n    \"d\": \"M10.879 6.05L15 1.93A5.001 5.001 0 0 1 22.071 9l-4.121 4.121a1 1 0 0 1-1.414-1.414l4.12-4.121a3 3 0 1 0-4.242-4.243l-4.121 4.121a1 1 0 1 1-1.414-1.414zm2.242 11.9L9 22.07A5 5 0 1 1 1.929 15l4.121-4.121a1 1 0 0 1 1.414 1.414l-4.12 4.121a3 3 0 1 0 4.242 4.243l4.121-4.121a1 1 0 1 1 1.414 1.414zm-8.364-.122l13.071-13.07a1 1 0 0 1 1.415 1.414L6.172 19.242a1 1 0 1 1-1.415-1.414z\",\n    \"fill\": \"currentColor\"\n  })))), \"Common Options\"), mdx(\"p\", null, \"The list of common options across SDKs. These work more or less the same in all SDKs, but some subtle differences will exist to better support the platform. Options that can be read from an environment variable or your \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"~/.sentryclirc\"), \" file (\", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"SENTRY_DSN\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"SENTRY_ENVIRONMENT\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"SENTRY_RELEASE\"), \") are read automatically. See \", mdx(\"a\", _extends({\n    parentName: \"p\"\n  }, {\n    \"href\": \"/product/cli/configuration/#sentry-cli-working-with-projects\"\n  }), \"Working with Projects\"), \" for more information.\"), mdx(ConfigKey, {\n    name: \"dsn\",\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"The \", mdx(\"em\", {\n    parentName: \"p\"\n  }, \"DSN\"), \" tells the SDK where to send the events. If this value is not provided, the SDK will try to read it from the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"SENTRY_DSN\"), \" environment variable. If that variable also does not exist, the SDK will just not send any events.\"), mdx(\"p\", null, \"In runtimes without a process environment (such as the browser) that fallback does not apply.\"))), mdx(ConfigKey, {\n    name: \"debug\",\n    notSupported: [\"php\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"Turns debug mode on or off. If debug is enabled SDK will attempt to print out useful debugging information if something goes wrong with sending the event. The default is always \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"false\"), \". It's generally not recommended to turn it on in production, though turning \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"debug\"), \" mode on will not cause any safety concerns.\"))), mdx(ConfigKey, {\n    name: \"release\",\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"Sets the release. Some SDKs will try to automatically configure a release out of the box but it's a better idea to manually set it to guarantee that the release is in sync with your deploy integrations or source map uploads. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in\\xA0\", mdx(\"a\", _extends({\n    parentName: \"p\"\n  }, {\n    \"href\": \"/product/releases/\"\n  }), \"the releases documentation\"), \".\"), mdx(\"p\", null, \"By default the SDK will try to read this value from the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"SENTRY_RELEASE\"), \" environment variable (in the browser SDK, this will be read off of the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"window.SENTRY_RELEASE\"), \" if available).\"))), mdx(ConfigKey, {\n    name: \"environment\",\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"Sets the environment. This string is freeform and not set by default. A release can be associated with more than one environment to separate them in the UI (think \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"staging\"), \" vs \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"prod\"), \" or similar).\"), mdx(\"p\", null, \"By default the SDK will try to read this value from the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"SENTRY_ENVIRONMENT\"), \" environment variable (except for the browser SDK where this is not applicable).\"))), mdx(ConfigKey, {\n    name: \"error_types\",\n    supported: [\"php\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"Sets which errors are reported. It takes the same values as PHP's \", mdx(\"a\", _extends({\n    parentName: \"p\"\n  }, {\n    \"href\": \"https://www.php.net/manual/errorfunc.configuration.php#ini.error-reporting\"\n  }), mdx(\"inlineCode\", {\n    parentName: \"a\"\n  }, \"error_reporting\")), \" configuration parameter.\"), mdx(\"p\", null, \"By default all types of errors are be reported (equivalent to \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"E_ALL\"), \").\"))), mdx(ConfigKey, {\n    name: \"sample-rate\",\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"Configures the sample rate for error events, in the range of \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"0.0\"), \" to \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"1.0\"), \". The default is \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"1.0\"), \" which means that 100% of error events are sent. If set to \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"0.1\"), \" only 10% of error events will be sent. Events are picked randomly.\"))), mdx(ConfigKey, {\n    name: \"max-breadcrumbs\",\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"This variable controls the total amount of breadcrumbs that should be captured. This defaults to \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"100\"), \".\"))), mdx(ConfigKey, {\n    name: \"attach-stacktrace\",\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"When enabled, stack traces are automatically attached to all messages logged. Stack traces are always attached to exceptions; however, when this option is set, stack traces are also sent with messages. This option, for instance, means that stack traces appear next to all log messages.\"), mdx(\"p\", null, \"This option is\\xA0\", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"off\"), \"\\xA0by default.\"), mdx(\"p\", null, \"Grouping in Sentry is different for events with stack traces and without. As a result, you will get new groups as you enable or disable this flag for certain events.\"))), mdx(ConfigKey, {\n    name: \"send-default-pii\",\n    supported: [\"python\", \"java\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent.\"), mdx(\"p\", null, \"If possible, we recommended turning on this feature to send all such data by default, and manually remove what you don't want to send using our features for managing \", mdx(\"a\", _extends({\n    parentName: \"p\"\n  }, {\n    \"href\": \"../../data-management/sensitive-data/\"\n  }), mdx(\"em\", {\n    parentName: \"a\"\n  }, \"Sensitive Data\")), \".\"))), mdx(ConfigKey, {\n    name: \"server-name\",\n    supported: [\"python\", \"node\", \"ruby\", \"php\", \"java\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"This option can be used to supply a \\\"server name.\\\" When provided, the name of the server is sent along and persisted in the event. For many integrations the server name actually corresponds to the device hostname, even in situations where the machine is not actually a server. Most SDKs\\nwill attempt to auto-discover this value.\"))), mdx(ConfigKey, {\n    name: \"deny-urls\",\n    supported: [\"javascript\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"A list of strings or regex patterns that match error URLs that should not be sent to Sentry. By default, all errors will be sent. This is a \\\"contains\\\" match to the entire file URL. As a result, if you add \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"foo.com\"), \" to it, it will also match on \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"https://bar.com/myfile/foo.com\"), \". By default, all errors will be sent.\"))), mdx(ConfigKey, {\n    name: \"allow-urls\",\n    supported: [\"javascript\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"A legacy alias for a list of strings or regex patterns that match error URLs which should exclusively be sent to Sentry. By default, all errors\\nwill be sent. This is a \\\"contains\\\" match to the entire file URL. As a result, if you add \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"foo.com\"), \" to it, it will also match on \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"[https://bar.com/myfile/foo.com](https://bar.com/myfile/foo.com)\"), \" By default, all errors will be sent.\"))), mdx(ConfigKey, {\n    name: \"in-app-include\",\n    supported: [\"python\", \"rust\", \"csharp\", \"php\", \"java\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"A list of string prefixes of module names that belong to the app. This option takes precedence over \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"in-app-exclude\"), \".\"))), mdx(ConfigKey, {\n    name: \"in-app-exclude\",\n    supported: [\"python\", \"rust\", \"csharp\", \"php\", \"java\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"A list of string prefixes of module names that do not belong to the app, but rather to third-party packages. Modules considered not part of the app will be hidden from stack traces by default.\"), mdx(\"p\", null, \"This option can be overridden using \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"in-app-include\"), \".\"))), mdx(ConfigKey, {\n    name: \"request-bodies\",\n    supported: [\"python\", \"php\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"This parameter controls if integrations should capture HTTP request bodies. It can be set to one of the following values:\"), mdx(\"ul\", null, mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"never\"), \": request bodies are never sent\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"small\"), \": only small request bodies will be captured where the cutoff for small depends on the SDK (typically 4KB)\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"medium\"), \": medium and small requests will be captured (typically 10KB)\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"always\"), \": the SDK will always capture the request body for as long as Sentry can make sense of it\")))), mdx(ConfigKey, {\n    name: \"with-locals\",\n    supported: [\"python\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"When enabled, local variables are sent along with stackframes. This can have a performance and PII impact. Enabled by default on platforms where this is available.\"))), mdx(ConfigKey, {\n    name: \"ca-certs\",\n    supported: [\"python\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"A path to an alternative CA bundle file in PEM-format.\"))), mdx(ConfigKey, {\n    name: \"normalize-depth\",\n    supported: [\"javascript\", \"node\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"Sentry SDKs normalize any contextual data to a given depth. Any keys containing data with a structure deeper than this will be trimmed and marked using its type instead (\", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"[Object]\"), \" or \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"[Array]\"), \"), without walking the tree any further. By default, walking is performed \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"3\"), \" levels deep.\"))), mdx(PlatformSection, {\n    supported: [\"javascript\", \"python\", \"node\"],\n    mdxType: \"PlatformSection\"\n  }, mdx(\"markdown\", null, mdx(\"h2\", {\n    \"id\": \"integration-configuration\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", _extends({\n    parentName: \"h2\"\n  }, {\n    \"href\": \"#integration-configuration\",\n    \"aria-label\": \"integration configuration permalink\",\n    \"className\": \"anchor before\"\n  }), mdx(\"svg\", _extends({\n    parentName: \"a\"\n  }, {\n    \"viewBox\": \"0 0 24 24\",\n    \"xmlns\": \"http://www.w3.org/2000/svg\"\n  }), mdx(\"path\", _extends({\n    parentName: \"svg\"\n  }, {\n    \"d\": \"M10.879 6.05L15 1.93A5.001 5.001 0 0 1 22.071 9l-4.121 4.121a1 1 0 0 1-1.414-1.414l4.12-4.121a3 3 0 1 0-4.242-4.243l-4.121 4.121a1 1 0 1 1-1.414-1.414zm2.242 11.9L9 22.07A5 5 0 1 1 1.929 15l4.121-4.121a1 1 0 0 1 1.414 1.414l-4.12 4.121a3 3 0 1 0 4.242 4.243l4.121-4.121a1 1 0 1 1 1.414 1.414zm-8.364-.122l13.071-13.07a1 1 0 0 1 1.415 1.414L6.172 19.242a1 1 0 1 1-1.415-1.414z\",\n    \"fill\": \"currentColor\"\n  })))), \"Integration Configuration\"), mdx(\"p\", null, \"For many platform SDKs integrations can be configured alongside it. On some platforms that happen as part of the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"init()\"), \" call, in some others, different patterns apply.\"), mdx(ConfigKey, {\n    name: \"integrations\",\n    mdxType: \"ConfigKey\"\n  }), mdx(\"p\", null, \"In some SDKs, the integrations are configured through this parameter on library initialization. For more information, please see our documentation for a specific integration.\"), mdx(ConfigKey, {\n    name: \"default-integrations\",\n    mdxType: \"ConfigKey\"\n  }), mdx(\"p\", null, \"This can be used to disable integrations that are added by default. When set to \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"false\"), \", no default integrations are added.\"))), mdx(\"h2\", {\n    \"id\": \"hooks\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", _extends({\n    parentName: \"h2\"\n  }, {\n    \"href\": \"#hooks\",\n    \"aria-label\": \"hooks permalink\",\n    \"className\": \"anchor before\"\n  }), mdx(\"svg\", _extends({\n    parentName: \"a\"\n  }, {\n    \"viewBox\": \"0 0 24 24\",\n    \"xmlns\": \"http://www.w3.org/2000/svg\"\n  }), mdx(\"path\", _extends({\n    parentName: \"svg\"\n  }, {\n    \"d\": \"M10.879 6.05L15 1.93A5.001 5.001 0 0 1 22.071 9l-4.121 4.121a1 1 0 0 1-1.414-1.414l4.12-4.121a3 3 0 1 0-4.242-4.243l-4.121 4.121a1 1 0 1 1-1.414-1.414zm2.242 11.9L9 22.07A5 5 0 1 1 1.929 15l4.121-4.121a1 1 0 0 1 1.414 1.414l-4.12 4.121a3 3 0 1 0 4.242 4.243l4.121-4.121a1 1 0 1 1 1.414 1.414zm-8.364-.122l13.071-13.07a1 1 0 0 1 1.415 1.414L6.172 19.242a1 1 0 1 1-1.415-1.414z\",\n    \"fill\": \"currentColor\"\n  })))), \"Hooks\"), mdx(\"p\", null, \"These options can be used to hook the SDK in various ways to customize the reporting of events.\"), mdx(ConfigKey, {\n    name: \"before-send\",\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"This function is called with an SDK-specific event object, and can return a modified event object or nothing to skip reporting the event. This can be used, for instance, for manual PII stripping before sending.\"))), mdx(ConfigKey, {\n    name: \"before-breadcrumb\",\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"This function is called with an SDK-specific breadcrumb object before the breadcrumb is added to the scope. When nothing is returned from the function, the breadcrumb is dropped. To pass the breadcrumb through, return the first argument, which contains the breadcrumb object.\\nThe callback typically gets a second argument (called a \\\"hint\\\") which contains the original object from which the breadcrumb was created to further customize what the breadcrumb should look like.\"))), mdx(PlatformSection, {\n    supported: [\"javascript\", \"java\", \"python\", \"node\", \"php\"],\n    mdxType: \"PlatformSection\"\n  }, mdx(\"markdown\", null, mdx(\"h2\", {\n    \"id\": \"transport-options\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", _extends({\n    parentName: \"h2\"\n  }, {\n    \"href\": \"#transport-options\",\n    \"aria-label\": \"transport options permalink\",\n    \"className\": \"anchor before\"\n  }), mdx(\"svg\", _extends({\n    parentName: \"a\"\n  }, {\n    \"viewBox\": \"0 0 24 24\",\n    \"xmlns\": \"http://www.w3.org/2000/svg\"\n  }), mdx(\"path\", _extends({\n    parentName: \"svg\"\n  }, {\n    \"d\": \"M10.879 6.05L15 1.93A5.001 5.001 0 0 1 22.071 9l-4.121 4.121a1 1 0 0 1-1.414-1.414l4.12-4.121a3 3 0 1 0-4.242-4.243l-4.121 4.121a1 1 0 1 1-1.414-1.414zm2.242 11.9L9 22.07A5 5 0 1 1 1.929 15l4.121-4.121a1 1 0 0 1 1.414 1.414l-4.12 4.121a3 3 0 1 0 4.242 4.243l4.121-4.121a1 1 0 1 1 1.414 1.414zm-8.364-.122l13.071-13.07a1 1 0 0 1 1.415 1.414L6.172 19.242a1 1 0 1 1-1.415-1.414z\",\n    \"fill\": \"currentColor\"\n  })))), \"Transport Options\"), mdx(\"p\", null, \"Transports are used to send events to Sentry. Transports can be customized to some degree to better support highly specific deployments.\"), mdx(ConfigKey, {\n    name: \"transport\",\n    supported: [\"javascript\", \"php\", \"python\", \"java\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"Switches out the transport used to send events. How this works depends on the SDK. It can, for instance, be used to capture events for unit-testing or to send it through some more complex setup that requires proxy authentication.\"))), mdx(ConfigKey, {\n    name: \"http-proxy\",\n    supported: [\"node\", \"php\", \"python\", \"java\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"When set, a proxy can be configured that should be used for outbound requests. This is also used for HTTPS requests unless a separate \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"https-proxy\"), \" is configured. However, not all SDKs support a separate HTTPS proxy. SDKs will attempt to default to the system-wide configured proxy, if possible. For instance, on Unix systems, the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"http_proxy\"), \" environment variable will be picked up.\"))), mdx(ConfigKey, {\n    name: \"https-proxy\",\n    supported: [\"python\", \"node\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"Configures a separate proxy for outgoing HTTPS requests. This value might not be supported by all SDKs. When not supported the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"http-proxy\"), \" value is also used for HTTPS requests at all times.\"))), mdx(ConfigKey, {\n    name: \"shutdown-timeout\",\n    supported: [\"python\", \"node\", \"java\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"Controls how many seconds to wait before shutting down. Sentry SDKs send events from a background queue. This queue is given a certain amount to drain pending events. The default is SDK specific but typically around two seconds. Setting this value too low may cause problems for sending events from command line applications. Setting the value too high will cause the application to block for a long time for users experiencing network connectivity problems.\"))))), mdx(\"h2\", {\n    \"id\": \"tracing-options\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", _extends({\n    parentName: \"h2\"\n  }, {\n    \"href\": \"#tracing-options\",\n    \"aria-label\": \"tracing options permalink\",\n    \"className\": \"anchor before\"\n  }), mdx(\"svg\", _extends({\n    parentName: \"a\"\n  }, {\n    \"viewBox\": \"0 0 24 24\",\n    \"xmlns\": \"http://www.w3.org/2000/svg\"\n  }), mdx(\"path\", _extends({\n    parentName: \"svg\"\n  }, {\n    \"d\": \"M10.879 6.05L15 1.93A5.001 5.001 0 0 1 22.071 9l-4.121 4.121a1 1 0 0 1-1.414-1.414l4.12-4.121a3 3 0 1 0-4.242-4.243l-4.121 4.121a1 1 0 1 1-1.414-1.414zm2.242 11.9L9 22.07A5 5 0 1 1 1.929 15l4.121-4.121a1 1 0 0 1 1.414 1.414l-4.12 4.121a3 3 0 1 0 4.242 4.243l4.121-4.121a1 1 0 1 1 1.414 1.414zm-8.364-.122l13.071-13.07a1 1 0 0 1 1.415 1.414L6.172 19.242a1 1 0 1 1-1.415-1.414z\",\n    \"fill\": \"currentColor\"\n  })))), \"Tracing Options\"), mdx(ConfigKey, {\n    name: \"tracesSampleRate\",\n    supported: [\"node\", \"javascript\", \"python\", \"php\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"A number between 0 and 1, controlling the percentage chance a given transaction will be sent to Sentry. (0 represents 0% while 1 represents 100%.) Applies equally to all transactions created in the app. Either this or \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"tracesSampler\"), \" must be defined to enable tracing.\"))), mdx(ConfigKey, {\n    name: \"tracesSampler\",\n    supported: [\"node\", \"javascript\", \"python\", \"php\"],\n    mdxType: \"ConfigKey\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"A function responsible for determining the percentage chance a given transaction will be sent to Sentry. It will automatically be passed information about the transaction and the context in which it's being created, and must return a number between 0 (0% chance of being sent) and 1 (100% chance of being sent). Can also be used for filtering transactions, by returning 0 for those that are unwanted. Either this or \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"tracesSampleRate\"), \" must be defined to enable tracing.\"))));\n}\n;\nMDXContent.isMDXComponent = true;","tableOfContents":{"items":[{"url":"#common-options","title":"Common Options"},{"url":"#integration-configuration","title":"Integration Configuration"},{"url":"#hooks","title":"Hooks"},{"url":"#transport-options","title":"Transport Options"},{"url":"#tracing-options","title":"Tracing Options"}]},"internal":{"type":"Mdx"}}}},"pageContext":{"excerpt":"SDKs are configurable using a variety of options. The options are largely standardized among SDKs, but there are some differences to better accommodate platform peculiarities. Options are set when the SDK is first\ninitialized. Common Options The list of common options across SDKs. These work more or less the same in all SDKs, but some subtle differences will exist to better support the platform. Options that can be read from an environment variable or your  ~/.sentryclirc  file ( SENTRY_DSN ,  SENTRY_ENVIRONMENT ,  SENTRY_RELEASE ) are read automatically. See  Working with Projects  for more information. The  DSN  tells the SDK where to send the events. If this value is not provided, the SDK will try to read it from the  SENTRY_DSN  environment variable. If that variable also does not exist, the SDK will just not send any events. In runtimes without a process environment (such as the browser) that fallback does not apply. Turns debug mode on or off. If debug is enabled SDK will attempt to print out useful debugging information if something goes wrong with sending the event. The default is always  false . It's generally not recommended to turn it on in production, though turning  debug  mode on will not cause any safety concerns. Sets the release. Some SDKs will try to automatically configure a release out of the box but it's a better idea to manually set it to guarantee that the release is in sync with your deploy integrations or source map uploads. Release names are strings, but some formats are detected by Sentry and might be rendered differently. Learn more about how to send release data so Sentry can tell you about regressions between releases and identify the potential source in  the releases documentation . By default the SDK will try to read this value from the  SENTRY_RELEASE  environment variable (in the browser SDK, this will be read off of the  window.SENTRY_RELEASE  if available). Sets the environment. This string is freeform and not set by default. A release can be associated with more than one environment to separate them in the UI (think  staging  vs  prod  or similar). By default the SDK will try to read this value from the  SENTRY_ENVIRONMENT  environment variable (except for the browser SDK where this is not applicable). Sets which errors are reported. It takes the same values as PHP's  error_reporting  configuration parameter. By default all types of errors are be reported (equivalent to  E_ALL ). Configures the sample rate for error events, in the range of  0.0  to  1.0 . The default is  1.0  which means that 100% of error events are sent. If set to  0.1  only 10% of error events will be sent. Events are picked randomly. This variable controls the total amount of breadcrumbs that should be captured. This defaults to  100 . When enabled, stack traces are automatically attached to all messages logged. Stack traces are always attached to exceptions; however, when this option is set, stack traces are also sent with messages. This option, for instance, means that stack traces appear next to all log messages. This option is  off  by default. Grouping in Sentry is different for events with stack traces and without. As a result, you will get new groups as you enable or disable this flag for certain events. If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent. If possible, we recommended turning on this feature to send all such data by default, and manually remove what you don't want to send using our features for managing  Sensitive Data . This option can be used to supply a \"server name.\" When provided, the name of the server is sent along and persisted in the event. For many integrations the server name actually corresponds to the device hostname, even in situations where the machine is not actually a server. Most SDKs\nwill attempt to auto-discover this value. A list of strings or regex patterns that match error URLs that should not be sent to Sentry. By default, all errors will be sent. This is a \"contains\" match to the entire file URL. As a result, if you add  foo.com  to it, it will also match on  https://bar.com/myfile/foo.com . By default, all errors will be sent. A legacy alias for a list of strings or regex patterns that match error URLs which should exclusively be sent to Sentry. By default, all errors\nwill be sent. This is a \"contains\" match to the entire file URL. As a result, if you add  foo.com  to it, it will also match on  [https://bar.com/myfile/foo.com](https://bar.com/myfile/foo.com)  By default, all errors will be sent. A list of string prefixes of module names that belong to the app. This option takes precedence over  in-app-exclude . A list of string prefixes of module names that do not belong to the app, but rather to third-party packages. Modules considered not part of the app will be hidden from stack traces by default. This option can be overridden using  in-app-include . This…","title":"Basic Options","description":"Learn more about how to configure the SDK. These options are set when the SDK is first initialized, passed to the `init()` as an object.","sidebar_order":1,"platform":{"name":"dotnet","title":".NET"},"notoc":true,"id":"1f215086-69e5-5dec-aaf5-cca7c0665afb"}},"staticQueryHashes":["1218203755","1222113826","1222113826","1766336459","2158593473","2404336828","2472290386","2764967025","3818502851","4015007367","4192517163","4264099332","518019976"]}