Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
b818228
feat: Add Honeycomb integration with trigger and action
gaga1307 Feb 17, 2026
36f88eb
Merge branch 'main' into feat/honeycomb-integration
gaga1307 Feb 17, 2026
a559d69
fix: Improve webhook token validation in Honeycomb integration
gaga1307 Feb 17, 2026
c0958ce
fix: Enhance error handling for webhook integration
gaga1307 Feb 17, 2026
55a3330
fix: correct webhook token comparison and variable redeclaration
gaga1307 Feb 17, 2026
b330bc2
fix: Update test assertions for Honeycomb event creation
gaga1307 Feb 17, 2026
91e7a2a
fix: Update Honeycomb event timestamp handling and tests
gaga1307 Feb 17, 2026
39139ce
chore: run prettier
gaga1307 Feb 17, 2026
4c2bef1
fix: Refine webhook token handling in Honeycomb integration
gaga1307 Feb 17, 2026
12a2e4e
refactor: Remove unused EU base URL from Honeycomb client
gaga1307 Feb 17, 2026
2a3e227
feat: Add Honeycomb integration components and mappers
gaga1307 Feb 22, 2026
39e739b
chore: Fix formatting in Honeycomb mappers
gaga1307 Feb 22, 2026
e600c1a
chore: Fix Honeycomb component docs formatting
gaga1307 Feb 22, 2026
77f1448
fix: Improve error handling in Honeycomb client configuration key
gaga1307 Feb 22, 2026
279ce3d
fix: Enhance field handling in Honeycomb event mapper
gaga1307 Feb 22, 2026
8d293da
fix: Improve error handling for configuration key in Honeycomb integr…
gaga1307 Feb 22, 2026
980e48a
chore: Fix Honeycomb docs missing newline at end of file
gaga1307 Feb 22, 2026
0aee77f
chore: Fix Honeycomb docs
gaga1307 Feb 22, 2026
0981c2c
Merge branch 'main' into feat/honeycomb-integration
gaga1307 Feb 22, 2026
12e2a5d
feat: Add API key validation and ingest key handling in Honeycomb client
gaga1307 Feb 22, 2026
2c6cb9e
refactor: Replace ingest header retrieval method in Honeycomb client
gaga1307 Feb 22, 2026
ed095d8
chore: Sync generated Honeycomb component docs
gaga1307 Feb 22, 2026
4025907
refactor: Simplify trigger field handling in Honeycomb client
gaga1307 Feb 22, 2026
d93e515
feat: Add metadata setting in OnAlertFired setup
gaga1307 Feb 22, 2026
78c85ab
feat: Add v1 ping check after ingest key creation in Honeycomb client
gaga1307 Feb 22, 2026
f726814
chore: remove comment from test
gaga1307 Feb 22, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 121 additions & 0 deletions docs/components/Honeycomb.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
---
title: "Honeycomb"
---

Monitor observability alerts and send events to Honeycomb datasets

import { CardGrid, LinkCard } from "@astrojs/starlight/components";

## Triggers

<CardGrid>
<LinkCard title="On Alert Fired" href="#on-alert-fired" description="Triggers when a Honeycomb Trigger fires" />
</CardGrid>

## Actions

<CardGrid>
<LinkCard title="Create Event" href="#create-event" description="Send an event to Honeycomb dataset" />
</CardGrid>

## Instructions

Connect Honeycomb to SuperPlane using a Management Key.

**Required configuration:**
- **Site**: US (api.honeycomb.io) or EU (api.eu1.honeycomb.io) based on your account region.
- **Management Key**: Found in Honeycomb under Team Settings > API Keys. Must be in format &lt;keyID&gt;:&lt;secret&gt;.
- **Team Slug**: Your team identifier, visible in the Honeycomb URL: honeycomb.io/&lt;team-slug&gt;.
- **Environment Slug**: The environment containing your datasets (e.g. "production"). Found under Team Settings > Environments.

SuperPlane will automatically validate your credentials and manage all necessary Honeycomb resources — webhook recipients for triggers and ingest keys for actions — so no manual setup is required.

<a id="on-alert-fired"></a>

## On Alert Fired

Starts a workflow execution when a Honeycomb Trigger fires.

**Configuration:**
- **Dataset Slug**: The slug of the dataset that contains your Honeycomb trigger. Found in the dataset URL: honeycomb.io/&lt;team&gt;/datasets/&lt;dataset-slug&gt;.
- **Alert Name**: The exact name of the Honeycomb trigger to listen to (case-insensitive). Found in your dataset under Triggers.

**How it works:**
SuperPlane automatically creates a webhook recipient in Honeycomb and attaches it to the selected trigger. No manual webhook setup is required.

When the trigger fires, SuperPlane receives the webhook and starts a workflow execution with the full alert payload.

### Example Data

```json
{
"dataset": {
"name": "Production API",
"slug": "api-production"
},
"description": "API error rate has exceeded the acceptable threshold",
"id": "01HQXYZ123ABC",
"name": "High Error Rate - Production API",
"query": {
"query_url": "https://ui.honeycomb.io/myteam/datasets/api-production/query/xyz789",
"time_range": 900
},
"result_groups": [
{
"group": {
"endpoint": "/api/users"
},
"result_value": 12.3
},
{
"group": {
"endpoint": "/api/orders"
},
"result_value": 6.8
}
],
"result_value": 8.5,
"severity": "critical",
"status": "firing",
"summary": "Error rate is 8.5% (threshold: 5%)",
"threshold": {
"op": "above",
"value": 5
},
"trigger_url": "https://ui.honeycomb.io/myteam/triggers/abc123",
"triggered_at": "2026-02-15T10:30:00Z",
"version": "v1"
}
```

<a id="create-event"></a>

## Create Event

Sends a JSON event to a Honeycomb dataset.

Each key in the JSON object becomes a Honeycomb field.

Notes:
• Dataset must exist
• Fields must be valid JSON object
• Timestamp is auto-added if missing

### Example Output

```json
{
"dataset": "deployments",
"fields": {
"deployed_by": "github-actions",
"duration_seconds": 42,
"environment": "production",
"event_type": "deployment",
"service": "billing-api",
"success": true,
"version": "2.4.1"
},
"status": "sent"
}
```

Loading