CINXE.COM
Honeybadger Documentation
<!DOCTYPE html> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no"> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> <title>Honeybadger Documentation</title> <meta name="description" content="Honeybadger provides exception and uptime monitoring to keep your web apps error-free."> <meta itemprop="name" content="Honeybadger Documentation"> <meta itemprop="description" content="Honeybadger provides exception and uptime monitoring to keep your web apps error-free."> <meta itemprop="image" content="https://docs.honeybadger.io/images/pull_image.jpg"> <meta name="twitter:card" content="summary_large_image"> <meta name="twitter:site" content="Honeybadger Documentation"> <meta name="twitter:url" content="https://docs.honeybadger.io/"> <meta name="twitter:title" content="Honeybadger Documentation"> <meta name="twitter:description" content="Honeybadger provides exception and uptime monitoring to keep your web apps error-free."> <meta name="twitter:image" content="https://docs.honeybadger.io/images/pull_image.jpg"> <meta property="og:url" content="https://docs.honeybadger.io/"> <meta property="og:type" content="website"> <meta property="og:title" content="Honeybadger Documentation"> <meta property="og:image" content="https://docs.honeybadger.io/images/pull_image.jpg"> <meta property="og:description" content="Honeybadger provides exception and uptime monitoring to keep your web apps error-free."> <meta property="og:site_name" content="Honeybadger Documentation"> <meta property="og:locale" content="en_US"> <link rel="separator" href="-"> <link rel="preconnect" href="https://fonts.gstatic.com"> <link href="https://fonts.googleapis.com/css2?family=Lato:wght@400;700;900" rel="stylesheet"> <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"> <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32-3e5c50a5.png"> <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16-99592a0d.png"> <link rel="icon" type="image/svg+xml" href="/favicon-52e569f1.svg"> <link color="#EA5937" type="image/png" href="/favicon-52e569f1.svg" rel="mask-icon"> <link rel="manifest" href="/site.webmanifest"> <link href="/style-9ee99eb1.css" rel="stylesheet"> <script src="/site.min-0d126f70.js"></script> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@algolia/algoliasearch-netlify-frontend@1.0.7/dist/algoliasearchNetlify.css"> <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@algolia/algoliasearch-netlify-frontend@1.0.7/dist/algoliasearchNetlify.js"></script> <script src="https://cdn.usefathom.com/script.js" data-site="HVGCVOJS" defer></script> </head> <body data-controller="algolia" class="index"> <div class="root"> <nav> <a class="navbar-brand" href="/"> <img src="/images/navbar_logo-a208e0e8.svg" height="35"> </a> <div class="navbar-links"> <div class="nav-item"> <a href="https://www.honeybadger.io/">Product tour</a> </div> <div class="nav-item"> <a href="https://www.honeybadger.io/plans/">Pricing</a> </div> <div class="nav-item"> <a href="https://www.honeybadger.io/blog/">Blog</a> </div> <div class="nav-item active"> <a href="/">Docs</a> </div> <div class="nav-item"> <a href="https://status.honeybadger.io">Status</a> </div> <div class="nav-item "> <a href="https://www.honeybadger.io/contact/">Contact</a> </div> <div class="nav-item"> <a href="https://www.honeybadger.io/about/">Meet the 'Badgers</a> </div> </div> <div class="navbar-next-steps"> <div class="nav-item"> <a class="cta-nav" href="https://app.honeybadger.io/users/sign_up?plan_id=30252" oncdivck="window.fathom.trackGoal('YDVASYAU', 3900);">Start free trial</a> </div> <div class="nav-item"> <a href="https://app.honeybadger.io/users/sign_in">Log In</a> </div> </div> </nav> <article data-controller="swappable-content toggle" data-toggle-class-value="expanded" data-toggle-target="content"> <aside class="sidebar" data-swappable-content-target="sidebar"> <div class="sidebar-wrap"> <div class="mobile-header"> <div class="small-logo"> <svg width="26" height="32" viewbox="0 0 26 32" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M7.3527 22.2991L2.82515 17.651C2.24833 17.0557 2.24833 16.0845 2.82515 15.4905L11.9491 6.11732C12.5288 5.52323 13.4744 5.52323 14.0526 6.11732L14.6604 6.74143L15.9932 5.27814L14.6835 3.93157C13.7576 2.9822 12.2441 2.9822 11.3188 3.93157L0.69544 14.8419C-0.231813 15.7922 -0.231813 17.3478 0.69544 18.3001L6.70065 24.4662L7.3527 22.2991Z" fill="#EA5937"></path> <path d="M25.307 14.8417L19.1313 8.50225L18.4031 10.5877L23.1738 15.4889C23.7553 16.0844 23.7553 17.0556 23.1738 17.6509L14.0527 27.0226C13.4744 27.6167 12.5288 27.6167 11.9491 27.0226L10.933 25.9792L9.59893 27.4406L11.3188 29.2069C12.2441 30.1591 13.7577 30.1591 14.6835 29.2069L25.307 18.2999C26.231 17.3477 26.231 15.7921 25.307 14.8417Z" fill="#EA5937"></path> <path d="M21.3914 0.25L16.166 15.1639C16.0983 15.3603 16.1292 15.579 16.2547 15.7437C16.3679 15.8948 16.5426 15.9827 16.7273 15.9827C16.7431 15.9827 16.7596 15.9827 16.7766 15.9794L19.4847 15.7437L5.29626 31.25L9.29439 17.8839C9.3524 17.689 9.31113 17.4802 9.18874 17.3216C9.07248 17.1753 8.9041 17.0937 8.72488 17.0937C8.70648 17.0937 8.68997 17.0937 8.67606 17.0949L5.81153 17.34L21.3914 0.25Z" fill="#EA5937"></path> </svg> </div> <div class="page-heading"> <p> Honeybadger Documentation </p> </div> <div class="search-load-area" data-action="click->algolia#toggle"> <svg class="search-icon" width="26" viewbox="0 0 13 12" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M12.2096 11.0968L8.34493 7.23214C8.94464 6.45683 9.26905 5.50889 9.26905 4.51185C9.26905 3.31838 8.80327 2.19932 7.961 1.35555C7.11872 0.511786 5.99668 0.047493 4.80469 0.047493C3.61271 0.047493 2.49067 0.513275 1.64839 1.35555C0.804625 2.19783 0.340332 3.31838 0.340332 4.51185C0.340332 5.70384 0.806114 6.82588 1.64839 7.66816C2.49067 8.51192 3.61122 8.97622 4.80469 8.97622C5.80173 8.97622 6.74818 8.6518 7.52349 8.05358L11.3881 11.9167C11.3995 11.9281 11.4129 11.9371 11.4277 11.9432C11.4425 11.9493 11.4584 11.9525 11.4744 11.9525C11.4905 11.9525 11.5064 11.9493 11.5212 11.9432C11.536 11.9371 11.5494 11.9281 11.5608 11.9167L12.2096 11.2694C12.2209 11.2581 12.2299 11.2446 12.2361 11.2298C12.2422 11.215 12.2453 11.1991 12.2453 11.1831C12.2453 11.1671 12.2422 11.1512 12.2361 11.1364C12.2299 11.1216 12.2209 11.1081 12.2096 11.0968ZM7.16188 6.86904C6.53091 7.49851 5.69459 7.84524 4.80469 7.84524C3.9148 7.84524 3.07847 7.49851 2.44751 6.86904C1.81804 6.23807 1.4713 5.40175 1.4713 4.51185C1.4713 3.62196 1.81804 2.78415 2.44751 2.15467C3.07847 1.5252 3.9148 1.17846 4.80469 1.17846C5.69459 1.17846 6.5324 1.52371 7.16188 2.15467C7.79135 2.78563 8.13808 3.62196 8.13808 4.51185C8.13808 5.40175 7.79135 6.23956 7.16188 6.86904Z" fill="black"></path> </svg> </div> <div class="expand-area" data-action="click->toggle#toggle"> <svg xmlns="http://www.w3.org/2000/svg" fill="none" class="chevron-down" width="36" height="36" viewbox="0 0 24 24" stroke="currentColor" stroke-width="1.5"> <path d="M6 9l6 6 6-6" stroke-linecap="round"></path> </svg> </div> </div> <div class="sidebar-content"> <div class="mobile-nav"> <nav> <a class="navbar-brand" href="/"> <img src="/images/navbar_logo-a208e0e8.svg" height="35"> </a> <div class="navbar-links"> <div class="nav-item"> <a href="https://www.honeybadger.io/">Product tour</a> </div> <div class="nav-item"> <a href="https://www.honeybadger.io/plans/">Pricing</a> </div> <div class="nav-item"> <a href="https://www.honeybadger.io/blog/">Blog</a> </div> <div class="nav-item active"> <a href="/">Docs</a> </div> <div class="nav-item"> <a href="https://status.honeybadger.io">Status</a> </div> <div class="nav-item "> <a href="https://www.honeybadger.io/contact/">Contact</a> </div> <div class="nav-item"> <a href="https://www.honeybadger.io/about/">Meet the 'Badgers</a> </div> </div> <div class="navbar-next-steps"> <div class="nav-item"> <a class="cta-nav" href="https://app.honeybadger.io/users/sign_up?plan_id=30252" oncdivck="window.fathom.trackGoal('YDVASYAU', 3900);">Start free trial</a> </div> <div class="nav-item"> <a href="https://app.honeybadger.io/users/sign_in">Log In</a> </div> </div> </nav> </div> <script type="text/javascript"> algoliasearchNetlify({ appId: '45WOLCZTZ8', apiKey: 'cb553df02fd5e20d863e861d60f0a091', siteId: '4c33fb5a-cda6-4933-b26c-6421adc204e3', branch: "master", detached: { mediaQuery: '(max-width: 666px)' }, selector: 'div.search', theme: { mark: '#cb6047', background: 'white', selected: '#ececec', text: 'black', colorSourceIcon: 'gray' } }); </script> <div class="search"></div> <div class="sidebar-groups"> <div class="sidebar-items hidden"> <div class="sidebar-item selected toggled"> <div class="root-link"> <a href="/" class=""> Home </a> </div> </div> </div> <h2> PRODUCT GUIDES </h2> <div class="sidebar-items "> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/guides/errors/" class="toggleable-link"> Error Monitoring </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/guides/errors/#installation" class="toggleable-link">Installation</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/errors/#error-grouping" class="toggleable-link">Error Grouping</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/errors/#anatomy-of-an-error" class="toggleable-link">Anatomy of an Error</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#navigating-occurrences" class="toggleable-link">Navigating Occurrences</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#resolve-unresolve" class="toggleable-link">Resolve / Unresolve</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/errors/#error-actions" class="toggleable-link">Error Actions</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#assign-an-error" class="toggleable-link">Assign an Error</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#pause-or-ignore-an-error" class="toggleable-link">Pause or Ignore an Error</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#resolve-on-deploy" class="toggleable-link">Resolve on Deploy</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#unsubscribe" class="toggleable-link">Unsubscribe</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#export-an-error" class="toggleable-link">Export an Error</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#merge-errors" class="toggleable-link">Merge Errors</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#share-url" class="toggleable-link">Share URL</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#delete" class="toggleable-link">Delete</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#action-integrations" class="toggleable-link">Action Integrations</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/errors/#anatomy-of-an-error-continued" class="toggleable-link">Anatomy of an Error, Continued</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#notices" class="toggleable-link">Notices</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#comments" class="toggleable-link">Comments</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#backtrace" class="toggleable-link">Backtrace</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#request-params-cookies-env-etc-" class="toggleable-link">Request Params, Cookies, ENV, etc.</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#context-data" class="toggleable-link">Context Data</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/errors/#browsing-errors" class="toggleable-link">Browsing errors</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#search" class="toggleable-link">Search</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/errors/#batch-actions" class="toggleable-link">Batch actions</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/errors/#local-edits" class="toggleable-link">Local Edits</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/errors/#content-security-policy-reports" class="toggleable-link">Content Security Policy Reports</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/guides/search/" class="toggleable-link"> Error Search </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/guides/search/#how-to-search" class="toggleable-link">How to search</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/search/#keyboard-navigation" class="toggleable-link">Keyboard navigation</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/search/#keyboard-shortcuts" class="toggleable-link">Keyboard shortcuts</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/search/#how-tokens-are-combined" class="toggleable-link">How tokens are combined</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/search/#examples" class="toggleable-link">Examples</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/search/#search-by-state" class="toggleable-link">Search by state</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/search/#search-by-assignee" class="toggleable-link">Search by assignee</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/search/#search-by-environment" class="toggleable-link">Search by environment</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/search/#search-by-date" class="toggleable-link">Search by date</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/search/#search-by-first-seen" class="toggleable-link">Search by first seen</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/search/#search-by-error-details" class="toggleable-link">Search by error details</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/search/#search-by-location" class="toggleable-link">Search by location</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/search/#search-by-request" class="toggleable-link">Search by request</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/search/#searching-for-arrays" class="toggleable-link">Searching for arrays</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/search/#sorting-results" class="toggleable-link">Sorting results</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/search/#sort-by-date" class="toggleable-link">Sort by date</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/search/#sort-by-count" class="toggleable-link">Sort by count</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/search/#saved-searches-and-default-search" class="toggleable-link">Saved searches and default search</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/search/#batch-actions" class="toggleable-link">Batch actions</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/search/#free-form-text-search" class="toggleable-link">Free-form text search</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/guides/uptime/" class="toggleable-link"> Uptime Monitoring </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/guides/uptime/#setup" class="toggleable-link">Setup</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/uptime/#outage-notifications" class="toggleable-link">Outage Notifications</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/uptime/#outage-details" class="toggleable-link">Outage Details</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/uptime/#ssl-certificate-warnings" class="toggleable-link">SSL Certificate Warnings</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/uptime/#status-page-integration" class="toggleable-link">Status page integration</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/guides/check-ins/" class="toggleable-link"> Check-Ins </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/guides/check-ins/#setup" class="toggleable-link">Setup</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/check-ins/#slugs" class="toggleable-link">Slugs</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/check-ins/#notifications" class="toggleable-link">Notifications</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/check-ins/#status-page-integration" class="toggleable-link">Status Page integration</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/guides/status-pages/" class="toggleable-link"> Status Pages </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/guides/status-pages/#customizing-your-status-page" class="toggleable-link">Customizing your status page</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/status-pages/#adding-a-custom-domain" class="toggleable-link">Adding a custom domain</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/status-pages/#uptime-checks" class="toggleable-link">Uptime checks</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/status-pages/#connecting-checks" class="toggleable-link">Connecting checks</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/status-pages/#incidents" class="toggleable-link">Incidents</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/status-pages/#creating-incidents" class="toggleable-link">Creating Incidents</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/status-pages/#posting-an-update" class="toggleable-link">Posting an update</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/status-pages/#severity-and-status" class="toggleable-link">Severity and status</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/status-pages/#open-and-closed-incidents" class="toggleable-link">Open and closed incidents</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/status-pages/#announcing-updates" class="toggleable-link">Announcing updates</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/status-pages/#password-protection" class="toggleable-link">Password Protection</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/status-pages/#embedding-status-updates" class="toggleable-link">Embedding Status Updates</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/status-pages/#setup-and-usage" class="toggleable-link">Setup and usage</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/status-pages/#customization" class="toggleable-link">Customization</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/status-pages/#displaying-scheduled-maintenance" class="toggleable-link">Displaying scheduled maintenance</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/status-pages/#displaying-non-incident-messages" class="toggleable-link">Displaying non-incident messages</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/status-pages/#password-protected-status-pages" class="toggleable-link">Password protected status pages</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/status-pages/#seo-and-analytics" class="toggleable-link">SEO and analytics</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/status-pages/#search-engine-indexing" class="toggleable-link">Search engine indexing</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/status-pages/#google-analytics" class="toggleable-link">Google Analytics</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <a href="/guides/insights/" class=""> Insights </a> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/guides/deployments/" class="toggleable-link"> Deployments </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/guides/deployments/#how-deployments-work-in-honeybadger" class="toggleable-link">How Deployments Work in Honeybadger</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/deployments/#connecting-with-github-and-gitlab" class="toggleable-link">Connecting with GitHub and GitLab</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/deployments/#searching-with-deployments" class="toggleable-link">Searching with Deployments</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/deployments/#reporting-deployments" class="toggleable-link">Reporting Deployments</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <a href="/guides/reports/" class="toggleable-link"> Reports </a> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/guides/accounts/" class="toggleable-link"> Accounts </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/guides/accounts/#account-wide-information" class="toggleable-link">Account-wide Information</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/accounts/#account-settings" class="toggleable-link">Account Settings</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/accounts/#billing" class="toggleable-link">Billing</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/accounts/#changing-the-subscription-plan" class="toggleable-link">Changing the Subscription Plan</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/accounts/#account-options" class="toggleable-link">Account Options</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/accounts/#account-parking" class="toggleable-link">Account Parking</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/accounts/#deleting-your-account" class="toggleable-link">Deleting Your Account</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/guides/projects/" class="toggleable-link"> Projects </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/guides/projects/#general-project-settings" class="toggleable-link">General Project Settings</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/projects/#insights" class="toggleable-link">Insights</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/projects/#users" class="toggleable-link">Users</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/projects/#alerts-and-integrations" class="toggleable-link">Alerts and Integrations</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/projects/#api-keys" class="toggleable-link">API Keys</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/projects/#project-actions" class="toggleable-link">Project Actions</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/projects/#source-maps" class="toggleable-link">Source Maps</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/projects/#advanced-settings" class="toggleable-link">Advanced Settings</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/projects/#public-error-pages" class="toggleable-link">Public error pages</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/projects/#one-language-per-project" class="toggleable-link">One language per project</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <a href="/guides/integrations/" class=""> Integrations </a> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/guides/user-management/" class="toggleable-link"> User Management </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/guides/user-management/#what-can-users-do-" class="toggleable-link">What can users do?</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/user-management/#inviting-users" class="toggleable-link">Inviting Users</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/user-management/#how-to-invite-a-project-user" class="toggleable-link">How to invite a project user</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/user-management/#how-to-invite-a-team-user" class="toggleable-link">How to invite a team user</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/user-management/#how-to-invite-an-account-user" class="toggleable-link">How to invite an account user</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/user-management/#saml-sso" class="toggleable-link">SAML SSO</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/user-management/#restricted-authentication" class="toggleable-link">Restricted Authentication</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/guides/user-settings/" class="toggleable-link"> User Settings </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/guides/user-settings/#overview" class="toggleable-link">Overview</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/user-settings/#configuring-personal-alerts" class="toggleable-link">Configuring Personal Alerts</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/user-settings/#mobile-device-connections" class="toggleable-link">Mobile device connections</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/user-settings/#sms-phone-numbers" class="toggleable-link">SMS Phone Numbers</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/user-settings/#configuring-alerts-across-multiple-projects" class="toggleable-link">Configuring alerts across multiple projects</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/user-settings/#connected-apps" class="toggleable-link">Connected Apps</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/user-settings/#github-sign-in" class="toggleable-link">GitHub Sign In</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/user-settings/#cancel-user" class="toggleable-link">Cancel User</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/guides/heroku/" class="toggleable-link"> Heroku </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/guides/heroku/#overview" class="toggleable-link">Overview</a> </div> <div class="sidebar-sub-item level-2"> <a href="/guides/heroku/#converting-heroku-accounts" class="toggleable-link">Converting Heroku Accounts</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/heroku/#heroku-deployment-tracking" class="toggleable-link">Heroku Deployment Tracking</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/heroku/#heroku-platform-errors" class="toggleable-link">Heroku Platform Errors</a> </div> <div class="sidebar-sub-item level-1"> <a href="/guides/heroku/#heroku-platform-logs" class="toggleable-link">Heroku Platform Logs</a> </div> </div> </div> </div> <h2> RESOURCES </h2> <div class="sidebar-items "> <div class="sidebar-item"> <a href="/api/"> API Docs </a> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/resources/quotas/" class="toggleable-link"> Quotas </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/resources/quotas/#error-reporting" class="toggleable-link">Error Reporting</a> </div> <div class="sidebar-sub-item level-2"> <a href="/resources/quotas/#understanding-quotas" class="toggleable-link">Understanding quotas</a> </div> <div class="sidebar-sub-item level-2"> <a href="/resources/quotas/#exceeding-your-quota" class="toggleable-link">Exceeding your quota</a> </div> <div class="sidebar-sub-item level-2"> <a href="/resources/quotas/#quota-forgiveness" class="toggleable-link">Quota forgiveness</a> </div> <div class="sidebar-sub-item level-2"> <a href="/resources/quotas/#limiting-your-quota-usage" class="toggleable-link">Limiting your quota usage</a> </div> <div class="sidebar-sub-item level-1"> <a href="/resources/quotas/#insights" class="toggleable-link">Insights</a> </div> <div class="sidebar-sub-item level-2"> <a href="/resources/quotas/#daily-data-limit" class="toggleable-link">Daily data limit</a> </div> <div class="sidebar-sub-item level-1"> <a href="/resources/quotas/#viewing-your-quota-usage" class="toggleable-link">Viewing your quota usage</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/resources/security/" class="toggleable-link"> Security </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/resources/security/#authenticating-requests-from-honeybadger" class="toggleable-link">Authenticating requests from Honeybadger</a> </div> <div class="sidebar-sub-item level-1"> <a href="/resources/security/#firewalls" class="toggleable-link">Firewalls</a> </div> <div class="sidebar-sub-item level-2"> <a href="/resources/security/#for-exception-monitoring" class="toggleable-link">For exception monitoring</a> </div> <div class="sidebar-sub-item level-2"> <a href="/resources/security/#for-webhooks-sourcemaps-and-uptime-monitoring" class="toggleable-link">For webhooks, sourcemaps, and uptime monitoring</a> </div> <div class="sidebar-sub-item level-1"> <a href="/resources/security/#reporting-issues" class="toggleable-link">Reporting Issues</a> </div> <div class="sidebar-sub-item level-1"> <a href="/resources/security/#hall-of-fame" class="toggleable-link">Hall of Fame</a> </div> </div> </div> <div class="sidebar-item "> <div class="root-link"> <div data-action="click->swappable-content#toggle" class="toggler"> <svg aria-hidden="true" viewbox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> <path d="M1.291 6.689l6.01 6.021a.986.986 0 0 0 1.397 0l6.01-6.021C15.332 6.066 14.89 5 14.01 5H1.99C1.11 5 .67 6.066 1.29 6.689z" fill-rule="evenodd"> </path> </svg> </div> <a href="/resources/data-residency/" class="toggleable-link"> Data residency </a> </div> <div class="sidebar-sub-items"> <div class="sidebar-sub-item level-1"> <a href="/resources/data-residency/#united-states" class="toggleable-link">United States</a> </div> <div class="sidebar-sub-item level-1"> <a href="/resources/data-residency/#european-union" class="toggleable-link">European Union</a> </div> </div> </div> </div> <h2> <a href="/lib/">LIBRARIES</a> </h2> <div class="sidebar-items "> <div class="sidebar-item "> <div class="root-link"> <a href="/lib/ruby/" class=""> <img src="/images/icons/ruby-logo-98418f0f.svg"> Ruby </a> </div> </div> <div class="sidebar-item "> <div class="root-link"> <a href="/lib/javascript/" class=""> <img src="/images/icons/js-logo-6ec94ffe.svg"> JavaScript </a> </div> </div> <div class="sidebar-item "> <div class="root-link"> <a href="/lib/elixir/" class=""> <img src="/images/icons/elixir-logo-a4e90713.svg"> Elixir </a> </div> </div> <div class="sidebar-item "> <div class="root-link"> <a href="/lib/php/" class=""> <img src="/images/icons/php-logo-983c4dde.svg"> PHP </a> </div> </div> <div class="sidebar-item "> <div class="root-link"> <a href="/lib/python/" class=""> <img src="/images/icons/python-logo-4e2e6361.svg"> Python </a> </div> </div> <div class="sidebar-item "> <div class="root-link"> <a href="/lib/crystal/" class=""> <img src="/images/icons/crystal-logo-676ca856.svg"> Crystal </a> </div> </div> <div class="sidebar-item "> <div class="root-link"> <a href="/lib/go/" class=""> <img src="/images/icons/go-logo-0800383d.svg"> Golang </a> </div> </div> <div class="sidebar-item "> <div class="root-link"> <a href="/lib/java/" class=""> <img src="/images/icons/java-logo-ee6f6d55.svg"> Java </a> </div> </div> <div class="sidebar-item "> <div class="root-link"> <a href="/lib/clojure/" class=""> <img src="/images/icons/clojure-logo-87872ca8.svg"> Clojure </a> </div> </div> <div class="sidebar-item "> <div class="root-link"> <a href="/lib/cocoa/" class=""> <img src="/images/icons/apple-logo-c81f663f.svg"> Cocoa </a> </div> </div> <div class="sidebar-item "> <div class="root-link"> <a href="/lib/other/" class=""> <img src="/images/icons/generic-logo-c8c586ca.svg"> Other </a> </div> </div> </div> </div> </div> </div> </aside> <div class="loader"> <svg width="159" height="185" viewbox="0 0 159 185" fill="none" xmlns="http://www.w3.org/2000/svg"> <g> <g id="edges"> <path d="M140.566 89.0256L109.923 58.3292L106.31 68.4273L129.981 92.159C132.867 95.0427 132.867 99.7451 129.981 102.628L84.7232 148.006C81.8541 150.883 77.1619 150.883 74.2857 148.006L69.2437 142.954L62.6243 150.03L71.158 158.583C75.7495 163.194 83.2594 163.194 87.8532 158.583L140.566 105.77C145.15 101.159 145.15 93.6272 140.566 89.0256Z" fill="#EA5937"></path> <path d="M51.4788 125.134L29.0137 102.628C26.1516 99.7458 26.1516 95.0433 29.0137 92.1667L74.2856 46.7812C77.1618 43.9046 81.8539 43.9046 84.7231 46.7812L87.7385 49.8032L94.352 42.7178L87.8531 36.1977C83.2593 31.6007 75.7494 31.6007 71.1579 36.1977L18.4464 89.0262C13.8455 93.6278 13.8455 101.16 18.4464 105.771L48.2435 135.628L51.4788 125.134Z" fill="#EA5937"></path> </g> <path id="bolt" d="M120.442 19.5L95.223 89.7397C94.8964 90.6647 95.0455 91.6947 95.6509 92.4703C96.1972 93.1821 97.0406 93.5961 97.9317 93.5961C98.008 93.5961 98.0877 93.5961 98.1696 93.5802L111.24 92.4703L42.7635 165.5L62.0592 102.55C62.3392 101.632 62.14 100.649 61.5493 99.9015C60.9882 99.2126 60.1756 98.8282 59.3106 98.8282C59.2219 98.8282 59.1422 98.8282 59.075 98.8339L45.2503 99.9882L120.442 19.5Z" fill="#EA5937"></path> </g> </svg> </div> <div class="content-wrap index-page" data-swappable-content-target="content"> <div class="content " data-page-id="index"> <div class="header-group"> <h1> Honeybadger Documentation </h1> <small> Explore all that Honeybadger has to offer </small> </div> <div class="content-body"> <div class="content-left"> <div data-controller="config"> <h2 id="product-guides">Product Guides</h2> <div class="cards"> <a href="/guides/errors/" class="card"> <div class="heading"> Error Monitoring </div> <div class="description"> Collect, manage, and resolve your app errors </div> </a><a href="/guides/search/" class="card"> <div class="heading"> Error Search </div> <div class="description"> All the ways you can find your errors </div> </a><a href="/guides/uptime/" class="card"> <div class="heading"> Uptime Monitoring </div> <div class="description"> Get notified when your API is unresponsive </div> </a><a href="/guides/check-ins/" class="card"> <div class="heading"> Check-Ins </div> <div class="description"> Tracking pings </div> </a><a href="/guides/status-pages/" class="card"> <div class="heading"> Status Pages </div> <div class="description"> Give users insight into your system status </div> </a><a href="/guides/insights/" class="card"> <div class="heading"> Insights </div> <div class="description"> Dive into your Honeybadger and application events </div> </a><a href="/guides/deployments/" class="card"> <div class="heading"> Deployments </div> <div class="description"> Viewing and tracking deployments </div> </a><a href="/guides/reports/" class="card"> <div class="heading"> Reports </div> <div class="description"> Viewing and understanding reports </div> </a><a href="/guides/accounts/" class="card"> <div class="heading"> Accounts </div> <div class="description"> Manage billing and users </div> </a><a href="/guides/projects/" class="card"> <div class="heading"> Projects </div> <div class="description"> Projects contain your errors, check-ins & uptime </div> </a><a href="/guides/integrations/" class="card"> <div class="heading"> Integrations </div> <div class="description"> Configuration around sending data to other services </div> </a><a href="/guides/user-management/" class="card"> <div class="heading"> User Management </div> <div class="description"> User membership for project, teams, and accounts </div> </a><a href="/guides/user-settings/" class="card"> <div class="heading"> User Settings </div> <div class="description"> Your personal preferences </div> </a><a href="/guides/heroku/" class="card"> <div class="heading"> Heroku </div> <div class="description"> Honeybadger + Heroku <3 </div> </a> </div> <h2 id="client-libraries">Client Libraries</h2> <div class="cards"> <a href="/lib/ruby/" class="card column"> <div class="icon" style="background-image: url('/images/icons/ruby-logo-98418f0f.svg');"> </div> <div class="heading"> Ruby </div> </a><a href="/lib/javascript/" class="card column"> <div class="icon" style="background-image: url('/images/icons/js-logo-6ec94ffe.svg');"> </div> <div class="heading"> JavaScript </div> </a><a href="/lib/elixir/" class="card column"> <div class="icon" style="background-image: url('/images/icons/elixir-logo-a4e90713.svg');"> </div> <div class="heading"> Elixir </div> </a><a href="/lib/php/" class="card column"> <div class="icon" style="background-image: url('/images/icons/php-logo-983c4dde.svg');"> </div> <div class="heading"> PHP </div> </a><a href="/lib/python/" class="card column"> <div class="icon" style="background-image: url('/images/icons/python-logo-4e2e6361.svg');"> </div> <div class="heading"> Python </div> </a><a href="/lib/crystal/" class="card column"> <div class="icon" style="background-image: url('/images/icons/crystal-logo-676ca856.svg');"> </div> <div class="heading"> Crystal </div> </a><a href="/lib/go/" class="card column"> <div class="icon" style="background-image: url('/images/icons/go-logo-0800383d.svg');"> </div> <div class="heading"> Golang </div> </a><a href="/lib/java/" class="card column"> <div class="icon" style="background-image: url('/images/icons/java-logo-ee6f6d55.svg');"> </div> <div class="heading"> Java </div> </a><a href="/lib/clojure/" class="card column"> <div class="icon" style="background-image: url('/images/icons/clojure-logo-87872ca8.svg');"> </div> <div class="heading"> Clojure </div> </a><a href="/lib/cocoa/" class="card column"> <div class="icon" style="background-image: url('/images/icons/apple-logo-c81f663f.svg');"> </div> <div class="heading"> Cocoa </div> </a><a href="/lib/other/" class="card column"> <div class="icon" style="background-image: url('/images/icons/generic-logo-c8c586ca.svg');"> </div> <div class="heading"> Other </div> </a> </div> </div> <footer> Copyright <b>2012-2025</b> <a href="https://www.honeybadger.io">Honeybadger.io</a> </footer> </div> </div> </div> </div> </article> </div> </body> </html>