4b6817381b
CI (OpenClaw E2E) / openclaw test (push) Has been cancelled
CI / coverage-report (push) Has been cancelled
CI / test-kubernetes (push) Has been cancelled
CI / should-run-thorough (push) Has been cancelled
CI / test-thorough (cloudwatch-demo) (push) Has been cancelled
CI / test-thorough (flink-ecs) (push) Has been cancelled
CI / test-thorough (upstream-lambda) (push) Has been cancelled
CI / test-thorough (prefect-ecs-fargate) (push) Has been cancelled
Release / build-binaries (zip, opensre.exe, onefile, windows-latest, windows-x64) (push) Has been cancelled
Benchmark image — build + push to ECR (any adapter) / build + push (push) Has been cancelled
CI / quality (ubuntu-latest) (push) Has been cancelled
CI / test (tools-runtime) (push) Has been cancelled
CI / test (e2e-general) (push) Has been cancelled
CI / test (cli-runtime) (push) Has been cancelled
CI / test (e2e-provider-and-openclaw) (push) Has been cancelled
CI / test (integrations-and-misc) (push) Has been cancelled
Release / verify (push) Has been cancelled
Release / build-python-dist (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, macos-15-intel, darwin-x64) (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, macos-latest, darwin-arm64) (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, ubuntu-22.04, linux-x64) (push) Has been cancelled
Release / publish-release (push) Has been cancelled
Release / publish-main-release (push) Has been cancelled
Interactive Shell Live (PR + post-merge) / turn-checks (no-LLM) (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
Interactive Shell Live (PR + post-merge) / turn-live shard ${{ matrix.shard_index }} (push) Has been cancelled
Release / prepare (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, ubuntu-22.04-arm, linux-arm64) (push) Has been cancelled
Synthetic Deterministic Tests / Synthetic offline (deterministic) (push) Has been cancelled
96 lines
2.4 KiB
Plaintext
96 lines
2.4 KiB
Plaintext
---
|
|
title: "Honeycomb"
|
|
description: "Connect Honeycomb so OpenSRE can query traces during investigations"
|
|
---
|
|
|
|
OpenSRE queries Honeycomb to surface distributed traces during alert investigations — identifying slow spans, high-error services, and query patterns correlated with incidents.
|
|
|
|
## Prerequisites
|
|
|
|
- Honeycomb account (classic or environments-based)
|
|
- API key with query access
|
|
|
|
## Setup
|
|
|
|
### Option 1: Interactive CLI
|
|
|
|
```bash
|
|
opensre integrations setup
|
|
```
|
|
|
|
Select **Honeycomb** when prompted and provide your API key and dataset.
|
|
|
|
### Option 2: Environment variables
|
|
|
|
Add to your `.env`:
|
|
|
|
```bash
|
|
HONEYCOMB_API_KEY=your-api-key
|
|
HONEYCOMB_DATASET=your-dataset # optional, defaults to __all__
|
|
HONEYCOMB_API_URL=https://api.honeycomb.io # optional
|
|
```
|
|
|
|
| Variable | Default | Description |
|
|
| --- | --- | --- |
|
|
| `HONEYCOMB_API_KEY` | — | **Required.** Honeycomb API key |
|
|
| `HONEYCOMB_DATASET` | `__all__` | Dataset to query (classic) or `__all__` for environments |
|
|
| `HONEYCOMB_API_URL` | `https://api.honeycomb.io` | Override for EU region or proxies |
|
|
|
|
### Option 3: Persistent store
|
|
|
|
```json
|
|
{
|
|
"version": 1,
|
|
"integrations": [
|
|
{
|
|
"id": "honeycomb-prod",
|
|
"service": "honeycomb",
|
|
"status": "active",
|
|
"credentials": {
|
|
"api_key": "your-api-key",
|
|
"dataset": "__all__",
|
|
"base_url": "https://api.honeycomb.io"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## Creating an API key
|
|
|
|
1. In Honeycomb, go to **Account** → **API Keys**
|
|
2. Click **Create API Key**
|
|
3. Set the environment and enable **Query Data** permission
|
|
4. Copy the key
|
|
|
|
<Tip>
|
|
Use `__all__` as the dataset to query across all datasets in an environment. For EU accounts, set `HONEYCOMB_API_URL=https://api.eu1.honeycomb.io`.
|
|
</Tip>
|
|
|
|
## Verify
|
|
|
|
```bash
|
|
opensre integrations verify honeycomb
|
|
```
|
|
|
|
Expected output:
|
|
|
|
```
|
|
Service: honeycomb
|
|
Status: passed
|
|
Detail: Connected to https://api.honeycomb.io (environment production) and queried dataset __all__
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
| Symptom | Fix |
|
|
| --- | --- |
|
|
| **401 Unauthorized** | Confirm the API key is correct and has Query Data permission |
|
|
| **Dataset not found** | Use `__all__` or check the exact dataset name in Honeycomb |
|
|
| **EU account unreachable** | Set `HONEYCOMB_API_URL=https://api.eu1.honeycomb.io` |
|
|
|
|
## Security best practices
|
|
|
|
- Use a dedicated **read-only** API key scoped to query access.
|
|
- Store the API key in `.env`, not in source code.
|