DOCSEARCHbyAlgolia
Submit Docs

Honeybadger Documentation

website·Indexed 42 days ago

https://docs.honeybadger.io

Official documentation for Honeybadger, providing error tracking, uptime monitoring, logging, and application performance monitoring. Includes comprehensive guides for client libraries (SDKs), REST Data APIs for managing accounts, projects, and faults, and specialized dashboards for frameworks like Django, Flask, Celery, and Active Job.

Tokens
240.4K
Snippets
1.2K
Records
1.8K
Agent score
68%

What's inside Honeybadger

  1. Overview of Honeybadger breadcrumbs

    Breadcrumbs are records of events (such as API calls, job dispatches, or database queries) that occur within an application. When an error is captured, Honeybadger displays these breadcrumbs in the dashboard to provide debugging context. While request-global data should be handled via custom metadata context, breadcrumbs are intended for specific sequential events within a request.

  3. Overview of Honeybadger Check-ins

    Honeybadger Check-ins allow processes running on your servers (such as cron jobs or scheduled tasks) to report that they are alive. If a check-in is missing based on the configured schedule, Honeybadger sends an alert to notify you that the process has stopped reporting, preventing silent failures.

  4. Overview of Honeybadger Archive Destinations

    Archive destinations allow you to replicate events from Honeybadger Insights streams to an S3-compatible bucket that you own. This is primarily used for long-term data retention beyond the standard Insights window or for importing events into a data warehouse or data lake.

    What is archived:

    • Custom events sent via the Events API or client libraries.
    • Internal Honeybadger events (error notifications, deployments, uptime checks, check-in reports).

    What is NOT archived:

    • Detailed error payloads, including backtraces, breadcrumbs, and environment variables. Only distilled stream events are replicated.

  5. Overview of Honeybadger Breadcrumbs

    Breadcrumbs allow you to record contextual events leading up to an error. When a Project reports an Error (Notice), Honeybadger sends the breadcrumbs recorded during that execution (request, job, task, etc.). Breadcrumbs are preferred over global Context when you need to record metadata with duplicate keys, group related data, or track the chronological order of events relative to an error.

  6. Overview of Honeybadger Deployment Tracking

    Deployment tracking allows you to record when an application is deployed to correlate code changes with errors. Key features include a Deployments page showing history (timestamp, environment, user, and revision), integration with GitHub/GitLab for diff views, and the ability to notify teams via configured integrations (Slack, PagerDuty, email, etc.) when a deploy occurs.

  7. Overview of Honeybadger Insights for Ruby

    Honeybadger Insights allows you to observe Ruby application behavior in production by recording requests, database queries, background jobs, cache calls, and runtime metrics. It features a schema-less event stream where any sent field is immediately queryable using BadgerQL.

  8. Overview of Honeybadger Insights Alarms

    Honeybadger Insights alarms allow you to monitor data (such as errors, deployments, and uptime checks) in real time. An alarm combines a BadgerQL query, a threshold, and a notification trigger. When the number of results returned by the BadgerQL query exceeds the defined threshold, the alarm enters an 'alert' state and triggers notifications.

  9. Overview of Honeybadger MCP server capabilities

    The Honeybadger MCP server allows AI assistants to interact with Honeybadger projects and monitoring data via the Model Context Protocol. Capabilities include:

    • Project management: List, create, update, and delete projects; generate project reports.
    • Error investigation: Search/filter errors, view stack traces and occurrences, analyze patterns, and identify affected users.
    • Insights: Execute BadgerQL queries against event data.
    • Dashboards: Manage (list, create, update, delete) Insights dashboards.
    • Alarms: Manage (list, create, update, delete) Insights alarms and review history.

  12. Overview of Honeybadger platform capabilities

    Honeybadger is a unified monitoring platform that provides the following core services to help developers identify and resolve issues:

    • Error Monitoring: Notifications and tracking when application errors occur.
    • Insights & Logging: Analysis of logs, error trends, and patterns.
    • Dashboards & APM: Application Performance Monitoring and customizable dashboards for trend spotting.
    • Uptime Monitoring: Notifications when APIs or websites become unresponsive.
    • Check-ins: Tracking pings for scheduled tasks and cron jobs.
    • Deployments: Tracking and viewing application deployments.
    • Status Pages: Public-facing pages to communicate system status to users.