BugSnag docs

<!DOCTYPE html> <html> <head> <meta charset="utf-8">  <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="description" content="Add error monitoring to your applications, learn more about the product, and extend BugSnag with our APIs."> <title>BugSnag docs</title> <link rel="icon" type="image/png" href="/assets/images/favicon2-96.png" sizes="96x96"> <link href="/assets/stylesheets/all.css" rel="stylesheet" /> <link rel="canonical" href="https://docs.bugsnag.com/">  <script src="//d2wy8f7a9ursnm.cloudfront.net/v7/bugsnag.min.js"></script> <script> Bugsnag.start({ apiKey: '1adb72945c3fe4df9da3638ec54c5e4f', enabledReleaseStages: ['preview', 'production'], releaseStage: 'production' }) </script>  <script type="text/javascript"> var cpm = {}; (function(h,u,b){ var d=h.getElementsByTagName("script")[0],e=h.createElement("script"); e.async=true;e.src='https://cookiehub.net/c2/93363859.js'; e.onload=function(){u.cookiehub.load(b);} d.parentNode.insertBefore(e,d); })(document,window,cpm); </script>  <script type="text/plain" data-consent="analytics"> !function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+"cdn.segment.com/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="3.1.0"; // Track page views in Segment unless PetalBot is the source of the request. // PetalBot requests translate to a lot of MTUs (unique monthly users) in Segment which are billable. if (!/PetalBot/i.test(window.navigator.userAgent)) { analytics.load("68nit8nqeCaJTiD3u6961Prq8ZrNFMSF"); analytics.page() }}}(); </script>  <script type="text/plain" data-consent="marketing" async src="https://www.googletagmanager.com/gtag/js?id=AW-987941250"></script> <script type="text/plain" data-consent="marketing"> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'AW-987941250'); </script>  <script type="text/plain" data-consent="marketing"> function gtag_report_conversion(url) { var callback = function () { if (typeof(url) != 'undefined') { window.location = url; } }; gtag('event', 'conversion', { 'send_to': 'AW-987941250/AllYCPWI684BEIKTi9cD', 'event_callback': callback }); return false; } </script>  <script type="text/plain" data-consent="marketing"> window._6si = window._6si || []; window._6si.push(['enableEventTracking', true]); window._6si.push(['setToken', '8e0ea75c2ca92b31dec5baa7e7cf66be']); window._6si.push(['setEndpoint', 'b.6sc.co']); (function() { var gd = document.createElement('script'); gd.type = 'text/javascript'; gd.async = true; gd.src = '//j.6sc.co/6si.min.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(gd, s); })(); </script> </head> <body class="index"> <div class="Main"> <nav class="Sidebar"> <button class="Sidebar-toggle" onclick="document.body.classList.toggle('show-sidebar')"> <img class="Sidebar-icon Sidebar-icon-menu no-open" src="/assets/images/icons/menu.svg" /> <img class="Sidebar-icon Sidebar-icon-close no-open" src="/assets/images/icons/close.svg" /> </button> <div class="Sidebar-content"> <a class="Sidebar-logo" href="/"></a> <div class="Sidebar-search"> <input class="Sidebar-searchInput js-searchInput" type="search" placeholder="Search docs..."/> </div> <div class="Sidebar-sectionsScrollbarHider "> <div class="Sidebar-sections"> <div class="Sidebar-section"> <div class="Sidebar-sectionHeader">BugSnag documentation</div> <a href="/platforms/" class="Sidebar-navLink"> Platform guides </a><a href="/product/" class="Sidebar-navLink"> Product guides </a><a href="/performance/" class="Sidebar-navLink"> Performance monitoring </a><a href="/performance/distributed-tracing/" class="Sidebar-navLink"> Distributed tracing </a><a href="/build-integrations/" class="Sidebar-navLink"> Build & deploy integrations </a><a href="/api/" class="Sidebar-navLink"> API documentation </a><a href="/on-premise/" class="Sidebar-navLink"> BugSnag On-premise </a><a href="/security/" class="Sidebar-navLink"> Security </a> </div> <div class="Sidebar-section"> <div class="Sidebar-sectionHeader">Support</div> <a href="/support/" class="Sidebar-navLink"> BugSnag Support </a> </div> </div> </div> </div> </nav> <div class="Content"> <div class="TopBar"> <div class="TopBar-content Grid"> <div class="TopBar-breadcrumbs"> <a href="/" class="TopBar-breadcrumb"> Docs </a> </div> <div class="TopBar-buttons"> <a class="TopBar-button" href="https://www.bugsnag.com">bugsnag.com</a> <a class="TopBar-button is-primary" href="https://app.bugsnag.com/user/new/" onclick="gtag_report_conversion();">Start Free Trial</a> </div> </div> </div> <div class="Typography Grid"> <h1>BugSnag documentation</h1> <p>Add error monitoring to your applications, learn more about the product, and extend BugSnag with our APIs.</p> <div class="Blocks"> <a class="Blocks-block" href="platforms/" data-sidebar-label="Platform guides"> <div class="Blocks-content"> <div class="Blocks-header">Platform guides</div> <div class="Blocks-description">Step-by-step instructions for installing and configuring BugSnag in your applications.</div> </div> </a> <a class="Blocks-block" href="product/" data-sidebar-label="Product guides"> <div class="Blocks-content"> <div class="Blocks-header">Product guides</div> <div class="Blocks-description">Learn about the core features of our error reporting libraries, dashboard, and configuration settings.</div> </div> </a> <a class="Blocks-block" href="performance/" data-sidebar-label="Performance monitoring"> <div class="Blocks-content"> <div class="Blocks-header">Performance monitoring</div> <div class="Blocks-description">Monitor start-up, screen and page loads, network requests and other operations of your app and see the results in your BugSnag dashboard.</div> </div> </a> <a class="Blocks-block" href="/performance/distributed-tracing/" data-sidebar-label="Distributed tracing"> <div class="Blocks-content"> <div class="Blocks-header">Distributed tracing</div> <div class="Blocks-description">BugSnag’s end-to-end performance monitoring solution.</div> </div> </a> <a class="Blocks-block" href="build-integrations/" data-sidebar-label="Build & deploy integrations"> <div class="Blocks-content"> <div class="Blocks-header">Build & deploy integrations</div> <div class="Blocks-description">Report application builds, source maps, symbol files, and deploys to BugSnag.</div> </div> </a> <a class="Blocks-block" href="api/" data-sidebar-label="API documentation"> <div class="Blocks-content"> <div class="Blocks-header">API documentation</div> <div class="Blocks-description">Access your data, build custom integrations, report releases, and upload symbol mappings.</div> </div> </a> <a class="Blocks-block" href="on-premise/" data-sidebar-label="BugSnag On-premise"> <div class="Blocks-content"> <div class="Blocks-header">BugSnag On-premise</div> <div class="Blocks-description">Install, maintain, and manage your On-premise version of BugSnag.</div> </div> </a> <a class="Blocks-block" href="security/" data-sidebar-label="Security"> <div class="Blocks-content"> <div class="Blocks-header">Security</div> <div class="Blocks-description">Security overview, responsible disclosure, and IP addresses.</div> </div> </a> <a class="Blocks-block" href="support/" data-sidebar-label="BugSnag Support"> <div class="Blocks-content"> <div class="Blocks-header">BugSnag Support</div> <div class="Blocks-description">Get help using the BugSnag product or integrating BugSnag on your platform.</div> </div> </a> </div> <h3 id="support">Support</h3> <p>If you can’t find what you’re looking for in the documentation, please email us at <a class="Index-link" href="mailto:support@bugsnag.com">support@bugsnag.com</a>.</p> </div> </div> </div> <div class="Background"> <div class="Background-left"></div> <div class="Background-right"></div> </div>  <script src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script><script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script><script src="/assets/javascripts/all.js"></script> <script type="text/javascript"> docsearch({ apiKey: '95e256f960a70c3f7fa9c722dbe28130', appId: 'F9ABIKS431', indexName: 'bugsnag', inputSelector: '.js-searchInput', debug: true, algoliaOptions: { hitsPerPage: 20 } }); </script>  <script> // Standard Zendesk snippet window.zEmbed||function(e,t){var n,o,d,i,s,a=[],r=document.createElement("iframe");window.zEmbed=function(){a.push(arguments)},window.zE=window.zE||window.zEmbed,r.src="javascript:false",r.title="",r.role="presentation",(r.frameElement||r).style.cssText="display: none",d=document.getElementsByTagName("script"),d=d[d.length-1],d.parentNode.insertBefore(r,d),i=r.contentWindow,s=i.document;try{o=s}catch(e){n=document.domain,r.src='javascript:var d=document.open();d.domain="'+n+'";void(0);',o=s}o.open()._l=function(){var o=this.createElement("script");n&&(this.domain=n),o.id="js-iframe-async",o.src=e,this.t=+new Date,this.zendeskHost=t,this.zEQueue=a,this.body.appendChild(o)},o.write('<body onload="document._l();">'),o.close()}("https://assets.zendesk.com/embeddable_framework/main.js","bugsnag.zendesk.com"); // Don't allow the widget to set cookies: https://developer.zendesk.com/embeddables/docs/widget/settings#cookies window.zESettings = { cookies: false }; // Force the widget locale to be en-US to encourage customers to send in support queries in English zE('webWidget', 'setLocale', 'en-US'); // Some custom code to turn support@bugsnag.com links into Zendesk triggers $('[href="mailto:support@bugsnag.com"], [href="mailto:enterprise@bugsnag.com"], [href="mailto:notifiers@bugsnag.com"]').on('click', function(e) { // Only do this if Zendesk has loaded. Otherwise, fall back to mailto behavior if (window.zEmbed.activate) { window.zEmbed.activate(); e.preventDefault(); } }); </script> </body> </html>

CINXE.COM

BugSnag docs