Honeycomb
01README
Manage Honeycomb SLOs and SLI derived columns via the v1 Configuration API
02Models
@hivemq/honeycombv0.1.0honeycomb.ts
fn sync(sloId: string)
Fetch current SLO state from Honeycomb by SLO ID
| Argument | Type | Description |
|---|---|---|
| sloId | string | Honeycomb SLO ID |
fn updateSlo(sloId: string, description?: string)
Update SLO metadata (target percentage, time window, description).
| Argument | Type | Description |
|---|---|---|
| sloId | string | Honeycomb SLO ID |
| description? | string | SLO description |
fn createDerivedColumn()
Create a new derived column (SLI calculated field) in the target dataset.
fn createSlo(name: string, description?: string)
Create a new SLO in Honeycomb. Returns the assigned SLO ID.
| Argument | Type | Description |
|---|---|---|
| name | string | SLO display name |
| description? | string | SLO description |
fn createBurnAlert(sloId: string)
Create a burn rate alert for an SLO. Fires when the error budget is being consumed at a rate that would exhaust it within exhaustion_minutes. Also sends a recovery notification when the burn rate drops back to normal.
| Argument | Type | Description |
|---|---|---|
| sloId | string | Honeycomb SLO ID |
fn deleteBurnAlert(sloId: string)
Delete a burn rate alert. Reads the stored alert ID from the burnAlert resource written by createBurnAlert.
| Argument | Type | Description |
|---|---|---|
| sloId | string | Honeycomb SLO ID |
fn updateSliExpression()
Update the SLI derived column expression. This is a separate API call from the SLO itself.
Resources
slo(infinite)— A Honeycomb SLO
derivedColumn(infinite)— A Honeycomb derived column (used as SLI)
burnAlert(infinite)— A Honeycomb SLO burn rate alert
03Previous Versions
2026.04.27.1Apr 27, 2026
Modified 1 models
2026.04.27.33Apr 27, 2026
Modified 1 models
2026.04.24.4Apr 24, 2026
Modified 1 models
2026.04.24.5Apr 24, 2026
Modified 1 models
2026.04.24.2Apr 23, 2026
2026.04.24.3Apr 23, 2026
Modified 1 models
2026.04.24.1Apr 22, 2026
04Stats
B
83 / 100
Downloads
30
Archive size
170.0 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository0/2missing
05Platforms