Honeybadger

https://docs.honeybadger.io/
Admin
Honeybadger is an error tracking, uptime monitoring, logging, and application performance monitoring...
Tokens:992,405
Snippets:7,978
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Quick setup: install Vector and configure Honeybadger

Source: https://docs.honeybadger.io/guides/insights/integrations/systemd.md

Quick setup command for Debian/Ubuntu systems using apt. Downloads and runs a script that installs Vector, sets up the configuration, and starts Vector as a service. Replace PROJECT_API_KEY with your actual API key.

```shell
curl -sL https://gist.github.com/stympy/9ccb5a809a6731f53b3335fb4e020c2c/raw/bc5741a4e277ea3a7d6d0f5e70a67e0767aec221/install_vector.sh > install_vector.sh && \
chmod a+x install_vector.sh && \
HONEYBADGER_API_KEY="PROJECT_API_KEY" ./install_vector.sh
```

--------------------------------

### Install honeybadger-go with go get

Source: https://docs.honeybadger.io/lib/go/integrations/http.md

Run this command to install the honeybadger-go package from GitHub.

```sh
go get github.com/honeybadger-io/honeybadger-go
```

--------------------------------

### Install and import honeybadger-go

Source: https://docs.honeybadger.io/lib/go/integrations/other.md

Install the honeybadger-go package with go get, then add the import to your application code.

```sh
go get github.com/honeybadger-io/honeybadger-go
```

```go
import "github.com/honeybadger-io/honeybadger-go"
```

--------------------------------

### Install and configure Honeybadger Vue

Source: https://docs.honeybadger.io/lib/javascript/integration/vue3.md

Install the Honeybadger Vue packages and configure the Vue plugin in main.js. The JavaScript example shows the pattern from examples/vue3/src/main.js, using the apiKey option.

```bash
npm add @honeybadger-io/js @honeybadger-io/vue
```

```javascript
import { createApp } from "vue";
import App from "./App";
import router from "./router";
import HoneyBadgerVue from "@honeybadger-io/vue";


const app = createApp(App);
app.use(HoneyBadgerVue, { apiKey: "your_api_key" });
app.use(router).mount("#app");
```

--------------------------------

### Get interval boundaries with toStartOf and toEndOf

Source: https://docs.honeybadger.io/guides/insights/badgerql.md

Use toStartOf and toEndOf to get the start or end of an interval boundary instead of grouping with bin(). The first example returns the start of the current week; the second returns the end of the current day.

```badgerql
fields toStartOf(1w) as week_start
```

```badgerql
fields toEndOf(1d) as end_of_day
```

--------------------------------

### Run the sample React application

Source: https://docs.honeybadger.io/lib/javascript/integration/react.md

Commands to run the minimal example app from the `@honeybadger-io/react` repository. Set `REACT_APP_HONEYBADGER_API_KEY` to your API key. The app typically runs at `http://localhost:3000/`.

```bash
cd example
yarn install
REACT_APP_HONEYBADGER_API_KEY=yourkey yarn start
```

--------------------------------

### zerolog Quick Start with Honeybadger

Source: https://docs.honeybadger.io/lib/go/insights/capturing-logs.md

Initializes the Honeybadger zerolog adapter and sends a log event.

```go
import (
    "github.com/rs/zerolog"
    "github.com/honeybadger-io/honeybadger-go"
    hbzerolog "github.com/honeybadger-io/honeybadger-go/zerolog"
)


func main() {
    client := honeybadger.New(honeybadger.Configuration{
        APIKey: "PROJECT_API_KEY",
    })
    writer := hbzerolog.New(client)
    logger := zerolog.New(writer).With().Timestamp().Logger()
    logger.Info().Msg("hello")
}
```

--------------------------------

### toStartOf: Get start of week

Source: https://docs.honeybadger.io/llms-small.txt

Returns the start of the week for the event timestamp. Use when you need the start of an interval boundary rather than grouping with bin().

```badgerql
fields toStartOf(1w) as week_start
```

--------------------------------

### fill command syntax and examples

Source: https://docs.honeybadger.io/resources/llms/instructions/badgerql.txt

The first block is the syntax for the fill command. The second block shows five example usages: filling a bin field, filling with a step, filling to a limit, filling with a default value, and forward-filling with a carry-forward value.

```badgerql
fill field_expression [as alias] [asc|desc|up|down] [from ...] [to ...] [step ...] [across field [bounded | including [...]]]* [with field[ = expression][, ...]*]
```

```badgerql
fill bin
fill bin step 1h
fill number to 100
fill number from 0 to 5 with controller = "unknown"
fill number up from 1 to 5 with controller
```

--------------------------------

### Basic SSR setup with @honeybadger-io/js

Source: https://docs.honeybadger.io/lib/javascript/guides/server-side-rendering.md

Basic setup for server-side rendering. Requires the universal @honeybadger-io/js package and assumes the bundler exposes process.env values correctly.

```javascript
const Honeybadger = require("@honeybadger-io/js");


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

--------------------------------

### Installation

Source: https://docs.honeybadger.io/llms-full.txt

Installation instructions for the Honeybadger React SDK.

```APIDOC
## [INSTALL] @honeybadger-io/react

### Description
Install the Honeybadger React SDK and its core dependency via npm or yarn.

### Method
INSTALL

### Endpoint
npm add @honeybadger-io/js @honeybadger-io/react --save

### Parameters
None

### Request Example
```plaintext
# npm
npm add @honeybadger-io/js @honeybadger-io/react --save

# yarn
yarn add @honeybadger-io/js @honeybadger-io/react
```

### Response
#### Success Response (200)
No response body.

#### Response Example
No response body.
```

--------------------------------

### Get all accounts response JSON

Source: https://docs.honeybadger.io/api/accounts.md

Example JSON response for the get all accounts endpoint. Shows a list of account objects with id, email, name, active, and parked fields.

```json
{
  "results": [
    {
      "id": "Me3upk",
      "email": "homerjsimpson@gmail.com",
      "name": "homer",
      "active": true,
      "parked": false
    },
    {
      "id": "9bYfrm",
      "email": "homer.j@simpsons.io",
      "name": "Work",
      "active": true,
      "parked": false
    }
  ],
  "links": {
    "self": "http://localhost:3000/v2/accounts"
  }
}
```

--------------------------------

### Streams API response example

Source: https://docs.honeybadger.io/api/streams.md

Example JSON response from the Get all streams endpoint. It shows the structure with a results array containing stream objects and a links object with a self link.

```json
{
  "results": [
    {
      "id": "a1b2c3d4e5f6",
      "name": "Default",
      "slug": "default",
      "internal": false,
      "project_id": 1,
      "created_at": "2026-07-15T13:56:29.513358Z"
    },
    {
      "id": "f6e5d4c3b2a1",
      "name": "Internal",
      "slug": "internal",
      "internal": true,
      "project_id": 1,
      "created_at": "2026-07-15T13:56:29.513358Z"
    }
  ],
  "links": {
    "self": "https://app.honeybadger.io/v2/projects/1/streams"
  }
}
```

--------------------------------

### Example query: Host metrics

Source: https://docs.honeybadger.io/resources/cli/insights.md

Example query to retrieve host metrics, filtering by @type = 'metric' and selecting cpu.usage and memory.used fields.

```shell
hb insights query --project-id 12345 \
  --query "filter @type = 'metric' | fields @ts, cpu.usage, memory.used | sort @ts desc"
```

--------------------------------

### Get a count of faults with curl

Source: https://docs.honeybadger.io/api/faults.md

Use the summary endpoint to get a total count of faults for a project. The second example filters by the q parameter to count open faults in production.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/faults/summary
```

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/faults/summary?q=environment%3Aproduction%20-is%3Aresolved%20-is%3Aignored
```

--------------------------------

### fill command examples

Source: https://docs.honeybadger.io/llms-full.txt

Concrete fill command examples: inferring grid from bin, explicit step, extending to a maximum, filling with a default value, and forward-filling with carry-forward.

```badgerql
fill bin
fill bin step 1h
fill number to 100
fill number from 0 to 5 with controller = "unknown"
fill number up from 1 to 5 with controller
```

--------------------------------

### Get all status pages JSON response

Source: https://docs.honeybadger.io/llms-small.txt

Example JSON response returned by the get all status pages endpoint. It includes status page details such as id, name, domain, sites, and check-ins.

```json
{
  "results": [
    {
      "id": "rMGSZB",
      "name": "My Awesome Status Page",
      "account_id": "Me3upk",
      "domain": "your.custom.domain",
      "url": "your.custom.domain",
      "created_at": "2022-01-29T11:26:19.120153Z",
      "domain_verified_at": "2022-01-29T14:02:32.570227Z",
      "sites": [],
      "check_ins": [
        {
          "check_in_id": "XXXXXX",
          "display_name": "Nightly billing",
          "state": "reporting",
          "reported_at": "2022-01-29T00:00:02.523254Z"
        }
      ]
    },
    {
      "id": "vWbSWr",
      "name": "Really Awesome Status Page",
      "account_id": "Me3upk",
      "domain": null,
      "url": "vWbSWr.status.hbuptime.com",
      "created_at": "2022-01-29T11:09:32.570227Z",
      "domain_verified_at": null,
      "sites": [
        {
          "site_id": "7d25f58b-d1a9-49f1-b10a-ac7ee44a6537",
          "display_name": "Main site",
          "state": "up",
          "last_checked_at": "2022-01-29T11:09:30.982801Z"
        },
        {
          "site_id": "7d25f58b-d1a9-49f1-b10a-ac7ee44a6557",
          "display_name": "API",
          "state": "up",
          "last_checked_at": "2022-01-29T11:04:28.675309Z"
        }
      ],
      "check_ins": []
    }
  ],
  "links": {
    "self": "http://localhost:3000/v2/accounts/4bYurk/status_pages"
  }
}
```

--------------------------------

### Test installation with a panic

Source: https://docs.honeybadger.io/lib/go/integrations/other.md

Add a test panic to verify your installation. Run your application and check the Honeybadger dashboard for the error.

```go
func main() {
    defer honeybadger.Monitor()
    panic("Testing Honeybadger!")
}
```

--------------------------------

### Get open production fault count with curl

Source: https://docs.honeybadger.io/llms-small.txt

Example of filtering the fault count summary to get open faults in production using the q parameter with the search string environment:production -is:resolved -is:ignored.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/faults/summary?q=environment%3Aproduction%20-is%3Aresolved%20-is%3Aignored
```

--------------------------------

### only command example

Source: https://docs.honeybadger.io/llms-full.txt

Example of the only command that selects specific output columns.

```badgerql
only @ts, controller, status_code, duration
```

--------------------------------

### Get info for one account response JSON

Source: https://docs.honeybadger.io/api/accounts.md

Example JSON response for the get one account endpoint. Includes quota_consumed as a percentage (0.75 means 75%) and api_stats with stored, limited, and ignored arrays of date-count pairs.

```json
{
  "id": "Me3upk",
  "email": "homerjsimpson@gmail.com",
  "name": "homer",
  "active": true,
  "parked": false,
  "quota_consumed": 0.75,
  "api_stats": {
    "stored": [
      [ 1648767600, 116 ],
      [ 1648771200, 65 ],
      ...
    ],
    "limited": [],
    "ignored": []
  }
}
```

--------------------------------

### Get a list of notices with curl

Source: https://docs.honeybadger.io/llms-small.txt

Retrieves a list of notices for a given fault. The response format is shown in the following JSON example.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/faults/ID/notices
```

--------------------------------

### Example honeybadger.yml configuration

Source: https://docs.honeybadger.io/lib/ruby/getting-started/introduction.md

Example honeybadger.yml configuration file showing the required api_key option.

```yaml
---
api_key: "PROJECT_API_KEY"
```

--------------------------------

### expand command syntax and examples

Source: https://docs.honeybadger.io/resources/llms/instructions/badgerql.txt

The first block is the syntax for the expand command. The second block shows three example usages: expanding a tags array, expanding and filtering a numeric array, and expanding an array of URLs.

```badgerql
expand array_field [as alias][, ...]
```

```badgerql
expand tags[*]::str as tag
expand nums[*]::int as num | filter num > 50
expand events[*].url::str as url
```

--------------------------------

### stats count by bin(1h)

Source: https://docs.honeybadger.io/guides/insights/badgerql.md

A stats call that bins the count of events per hour. This is the starting point for the fill example.

```badgerql
stats count() as ct by bin(1h) as bin
```

--------------------------------

### limit command examples

Source: https://docs.honeybadger.io/llms-full.txt

Concrete limit command examples: capping total results and capping per group.

```badgerql
limit 25
limit 5 by controller::str
```

--------------------------------

### Get notices per day report

Source: https://docs.honeybadger.io/api/projects.md

Returns a count of error notifications processed, grouped by day, with days starting at midnight UTC.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/reports/notices_per_day
```

```json
[
  ["2023-01-24T00:00:00.000000+00:00", 3161],
  ["2023-01-25T00:00:00.000000+00:00", 2620],
  ["2023-01-26T00:00:00.000000+00:00", 2852],
  ["2023-01-27T00:00:00.000000+00:00", 2502],
  ["2023-01-28T00:00:00.000000+00:00", 1759],
  ["2023-01-29T00:00:00.000000+00:00", 1420],
  ["2023-01-30T00:00:00.000000+00:00", 3027],
  ["2023-01-31T00:00:00.000000+00:00", 1624]
]
```

--------------------------------

### bucket function width form example

Source: https://docs.honeybadger.io/llms-small.txt

Assigns numeric values to buckets of width 250 anchored at zero, returning the bucket start value.

```sql
stats count() as ct by bucket(duration::int, 250) as ms
```

--------------------------------

### Get comment list or details

Source: https://docs.honeybadger.io/api/comments.md

Retrieve a list of comments for a fault or a single comment by ID. The response format is shown in the following JSON example.

```bash
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/faults/ID/comments
curl -u AUTH_TOKEN: https://app.honeybadger.io/v2/projects/ID/faults/ID/comments/ID
```
Tokens:
Raw