Skip to content

honeybadger.md

Latest commit

 

History

History
99 lines (69 loc) · 2.29 KB

honeybadger.md

File metadata and controls

99 lines (69 loc) · 2.29 KB
Raw

Honeybadger

Error tracking, uptime monitoring, logging, and performance insights in one platform.

GitHub Education Access

Claim your free access at GitHub Education Pack - look for Honeybadger.

Dashboard

Features

  • Error Tracking: Capture exceptions with full stack traces and context
  • Uptime Monitoring: Monitor website and API availability
  • Check-ins: Track scheduled tasks and cron jobs
  • Logging: Centralized log aggregation with trend analysis
  • Performance: Application performance insights

Quick Setup

JavaScript/Node.js

npm install @honeybadger-io/js
import Honeybadger from '@honeybadger-io/js';

Honeybadger.configure({
  apiKey: process.env.HONEYBADGER_API_KEY,
  environment: process.env.NODE_ENV,
});

// Report errors
Honeybadger.notify(error);

Ruby/Rails

# Gemfile
gem 'honeybadger'
bundle exec honeybadger install [API_KEY]

Python

pip install honeybadger
from honeybadger import honeybadger

honeybadger.configure(api_key='YOUR_API_KEY')
honeybadger.notify(exception)

Configuration

Copy from templates/honeybadger/:

  • honeybadger.js - Node.js configuration
  • honeybadger.yml - Ruby/Rails configuration
  • .env.example - Environment variables

Environment Variables

HONEYBADGER_API_KEY=your_api_key_here
# Get from: https://app.honeybadger.io → Project Settings → API Keys

Best Practices

  1. Set environment: Always configure environment (production, staging, development)
  2. Add context: Include user info and request details
  3. Filter sensitive data: Configure filters to exclude passwords, tokens
  4. Use check-ins: Monitor cron jobs and background tasks
  5. Set up uptime checks: Monitor critical endpoints

Integrations

  • Slack, PagerDuty, Jira
  • GitHub, GitLab, Bitbucket
  • Webhooks for custom integrations

Resources