Skip to main content

@hivemq/honeycomb

v2026.04.28.35

Manage Honeycomb SLOs and SLI derived columns via the v1 Configuration API

Repository

https://github.com/hivemq/swamp-extensions

Labels

honeycombobservabilityslo

Contents

Quality score

How well-documented and verifiable this extension is.

83%

Grade B

  • 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

Install

$ swamp extension pull @hivemq/honeycomb

@hivemq/honeycombv2026.04.27.36honeycomb/honeycomb.ts
syncFetch current SLO state from Honeycomb by SLO ID
ArgumentTypeDescription
sloIdstringHoneycomb SLO ID
updateSloUpdate SLO metadata (target, description, period). All fields are optional — only provided fields are changed.
ArgumentTypeDescription
sloIdstringHoneycomb SLO ID
name?stringSLO display name
description?stringSLO description
createDerivedColumnCreate a new derived column (SLI calculated field) in the target dataset.
createSloCreate a new SLO in Honeycomb. Returns the assigned SLO ID.
ArgumentTypeDescription
namestringSLO display name
description?stringSLO description
createBurnAlertCreate 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.
ArgumentTypeDescription
sloIdstringHoneycomb SLO ID
deleteBurnAlertDelete a burn rate alert. Reads the stored alert ID from the burnAlert resource written by createBurnAlert.
ArgumentTypeDescription
sloIdstringHoneycomb SLO ID
updateSliExpressionUpdate 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