{"componentChunkName":"component---src-templates-platform-tsx","path":"/platforms/javascript/guides/react/configuration/releases/","result":{"data":{"file":{"id":"a3190eee-a1e7-5986-b747-830758594eea","relativePath":"common/configuration/releases.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\": \"Releases & Health\",\n  \"sidebar_order\": 2,\n  \"description\": \"Learn how to configure your SDK to tell Sentry about your releases.\",\n  \"notSupported\": [\"perl\"]\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 PlatformSection = makeShortcode(\"PlatformSection\");\nvar Note = makeShortcode(\"Note\");\nvar PlatformContent = makeShortcode(\"PlatformContent\");\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, \"A release is a version of your code that is deployed to an environment. When you give Sentry information about your releases, you can:\"), mdx(\"ul\", null, mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"Determine issues and regressions introduced in a new release\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"Predict which commit caused an issue and who is likely responsible\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"Resolve issues by including the issue number in your commit message\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"Receive email notifications when your code gets deployed\")), mdx(PlatformSection, {\n    supported: [\"javascript\", \"node\", \"java\"],\n    mdxType: \"PlatformSection\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"Additionally, releases are used for applying \", mdx(\"a\", _extends({\n    parentName: \"p\"\n  }, {\n    \"href\": \"/platforms/javascript/sourcemaps/\"\n  }), \"source maps\"), \" to minified JavaScript to view original, untransformed source code.\"))), mdx(\"h3\", {\n    \"id\": \"bind-the-version\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", _extends({\n    parentName: \"h3\"\n  }, {\n    \"href\": \"#bind-the-version\",\n    \"aria-label\": \"bind the version 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  })))), \"Bind the Version\"), mdx(\"p\", null, \"Include a release ID (often called a \\\"version\\\") when you configure your client SDK. This ID is commonly a git SHA or a custom version number.\"), mdx(\"p\", null, \"The release name cannot:\"), mdx(\"ul\", null, mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"contain newlines or spaces\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"use a forward slash (\\\"/\\\"), back slash (\\\"\", \"\\\\\", \"\\\"), period (\\\".\\\"), or double period (\\\"..\\\")\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"exceed 200 characters\")), mdx(Note, {\n    mdxType: \"Note\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"Releases are global per organization; prefix them with something project-specific for easy differentiation.\"))), mdx(PlatformContent, {\n    includePath: \"set-release\",\n    notateUnsupported: true,\n    mdxType: \"PlatformContent\"\n  }), mdx(\"p\", null, \"How you make the version available to your code is up to you. For example, you could use an environment variable that is set during the build process.\"), mdx(\"p\", null, \"This tags each event with the release value. We recommend that you tell Sentry about a new release before deploying it, as this will unlock a few more features as discussed in our documentation about . But if you don\\u2019t, Sentry will automatically create a release entity in the system the first time it sees an event with that release ID.\"), mdx(\"p\", null, \"After configuring your SDK, you can install a repository integration or manually supply Sentry with your own commit metadata. Read our documentation about \", mdx(\"a\", _extends({\n    parentName: \"p\"\n  }, {\n    \"href\": \"/product/releases/\"\n  }), \"Releases\"), \" for further information about integrations, associating commits, and telling Sentry when deploying releases.\"), mdx(PlatformSection, {\n    supported: [\"apple\"],\n    mdxType: \"PlatformSection\"\n  }, mdx(\"markdown\", null, mdx(\"h2\", {\n    \"id\": \"release-health\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", _extends({\n    parentName: \"h2\"\n  }, {\n    \"href\": \"#release-health\",\n    \"aria-label\": \"release health 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  })))), \"Release Health\"), mdx(\"p\", null, \"Monitor the \", mdx(\"a\", _extends({\n    parentName: \"p\"\n  }, {\n    \"href\": \"/product/releases/health/\"\n  }), \"health of releases\"), \" by observing user adoption, usage of the application, percentage of \", mdx(\"a\", _extends({\n    parentName: \"p\"\n  }, {\n    \"href\": \"/product/releases/health/#crash\"\n  }), \"crashes\"), \", and \", mdx(\"a\", _extends({\n    parentName: \"p\"\n  }, {\n    \"href\": \"/product/releases/health/#session\"\n  }), \"session data\"), \". Release health will provide insight into the impact of crashes and bugs as it relates to user experience, and reveal trends with each new issue through the release details, graphs, and filters.\"), mdx(\"p\", null, \"To benefit from the health data you must use at least version 5.0.0 of the Cocoa SDK. Since version 6.0.0, this feature is enabled by default.\"), mdx(\"p\", null, \"The SDK will automatically manage the start and end of the sessions when the application is started, goes to background, returns to the foreground, etc.\"), mdx(\"p\", null, \"By default, the session is terminated once the application is in the background for more than 30 seconds. You can change the time out with the option named \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"sessionTrackingIntervalMillis\"), \". It takes the amount in milliseconds. For example, to configure it to be 60 seconds:\"), mdx(PlatformContent, {\n    includePath: \"configuration/session-tracking-interval\",\n    mdxType: \"PlatformContent\"\n  }), mdx(\"p\", null, \"If you'd like to opt-out of this feature, you can do it via options.\"), mdx(PlatformContent, {\n    includePath: \"configuration/auto-session-tracking\",\n    mdxType: \"PlatformContent\"\n  }))));\n}\n;\nMDXContent.isMDXComponent = true;","tableOfContents":{"items":[{"items":[{"url":"#bind-the-version","title":"Bind the Version"}]},{"url":"#release-health","title":"Release Health"}]},"internal":{"type":"Mdx"}}}},"pageContext":{"excerpt":"A release is a version of your code that is deployed to an environment. When you give Sentry information about your releases, you can: Determine issues and regressions introduced in a new release Predict which commit caused an issue and who is likely responsible Resolve issues by including the issue number in your commit message Receive email notifications when your code gets deployed Additionally, releases are used for applying  source maps  to minified JavaScript to view original, untransformed source code. Bind the Version Include a release ID (often called a \"version\") when you configure your client SDK. This ID is commonly a git SHA or a custom version number. The release name cannot: contain newlines or spaces use a forward slash (\"/\"), back slash (\" \\ \"), period (\".\"), or double period (\"..\") exceed 200 characters Releases are global per organization; prefix them with something project-specific for easy differentiation. How you make the version available to your code is up to you. For example, you could use an environment variable that is set during the build process. This tags each event with the release value. We recommend that you tell Sentry about a new release before deploying it, as this will unlock a few more features as discussed in our documentation about . But if you don’t, Sentry will automatically create a release entity in the system the first time it sees an event with that release ID. After configuring your SDK, you can install a repository integration or manually supply Sentry with your own commit metadata. Read our documentation about  Releases  for further information about integrations, associating commits, and telling Sentry when deploying releases. Release Health Monitor the  health of releases  by observing user adoption, usage of the application, percentage of  crashes , and  session data . Release health will provide insight into the impact of crashes and bugs as it relates to user experience, and reveal trends with each new issue through the release details, graphs, and filters. To benefit from the health data you must use at least version 5.0.0 of the Cocoa SDK. Since version 6.0.0, this feature is enabled by default. The SDK will automatically manage the start and end of the sessions when the application is started, goes to background, returns to the foreground, etc. By default, the session is terminated once the application is in the background for more than 30 seconds. You can change the time out with the option named  sessionTrackingIntervalMillis . It takes the amount in milliseconds. For example, to configure it to be 60 seconds: If you'd like to opt-out of this feature, you can do it via options.","title":"Releases & Health","description":"Learn how to configure your SDK to tell Sentry about your releases.","sidebar_order":2,"notSupported":["perl"],"platform":{"name":"javascript","title":"JavaScript"},"guide":{"name":"react","title":"React"},"noindex":true,"notoc":true,"redirect_from":[],"id":"a3190eee-a1e7-5986-b747-830758594eea"}},"staticQueryHashes":["1218203755","1222113826","1222113826","1766336459","2158593473","2404336828","2472290386","2764967025","3818502851","4015007367","4192517163","4264099332","518019976"]}