Honeycomb MCP

🚀 蜂巢項目指南

Honeycomb 是一個強大的數據分析平臺，它能支持用戶運行查詢、分析數據並生成報告。下面將詳細介紹該工具的使用方法。

🚀 快速開始

若想使用 Honeycomb 工具，需先進行環境準備：

# 安裝依賴項
npm install honeycomb-client

✨ 主要特性

工具功能概述

• 運行查詢：支持多種計算操作和過濾器，可助力用戶從數據中提取關鍵信息。
• 優化響應：所有工具的響應都經過優化，能減少上下文窗口的使用，同時保證必要的信息完整性。

工具響應優化說明

• 列出數據集：返回名稱、標識符和簡要描述。
• 獲取列信息：返回字段名稱、類型和描述。
• 運行查詢：
  • 包含實際結果和元數據。
  • 自動計算摘要統計信息。
  • 只包含熱圖查詢的系列數據。
  • 省略冗餘的鏈接和執行細節。
• 分析列：
  • 返回頂部值、計數和關鍵統計信息。
  • 在適當情況下自動計算數字指標。

查詢規範詳情

支持的操作

• 計算操作：涵蓋 COUNT、CONCURRENCY、COUNT_DISTINCT、HEATMAP、SUM、AVG、MAX、MIN 等。
• 過濾器條件：支持 =、!=、>、>=、<、<=、starts - with、does - not - start - with、exists、does - not - exist、contains、does - not - contain、in、not - in 等操作符。

💻 使用示例

基礎用法

示例查詢

慢調用 API 查詢

{
  "環境": "生產",
  "數據集": "api-requests",
  "計算": [
    {"字段": "duration_ms", "操作": "HEATMAP"},
    {"字段": "duration_ms", "操作": "MAX"}
  ],
  "過濾器": [
    {"字段": "trace.parent_id", "操作": "does-not-exist"}
  ],
  "分組": ["http.target", "name"],
  "排序": [
    {"字段": "duration_ms", "操作": "MAX", "順序": "降序"}
  ]
}

數據庫調用分佈查詢（過去一週）

{
  "環境": "生產",
  "數據集": "api-requests",
  "計算": [
    {"字段": "duration_ms", "操作": "HEATMAP"}
  ],
  "過濾器": [
    {"字段": "db.statement", "操作": "exists"}
  ],
  "分組": ["db.statement"],
  "時間範圍": "過去一週"
}

錯誤率分析查詢

{
  "環境": "生產",
  "數據集": "api-requests",
  "計算": [
    {"字段": "error_rate", "操作": "AVG"}
  ],
  "過濾器": [
    {"字段": "status_code", "操作": "in", "值": [400, 500]}
  ]
}

高級用法

示例代碼

const Honeycomb = require('honeycomb-client');

// 初始化客戶端
const client = new Honeycomb({
  apikey: 'your_api_key',
  dataset: 'api-requests'
});

// 執行查詢
async function runQuery() {
  try {
    const result = await client.runQuery({
      "計算": [
        { "字段": "duration_ms", "操作": "HEATMAP" }
      ],
      "過濾器": [
        { "字段": "trace.parent_id", "操作": "does-not-exist" }
      ]
    });
    console.log(result);
  } catch (error) {
    console.error('查詢失敗:', error);
  }
}

runQuery();

📄 許可證

本項目遵循 Apache 2.0 許可證，更多詳細信息請查看 LICENSE 文件。

📚 詳細文檔

附錄

錯誤代碼說明

常見問題解答

• Q：如何獲取 API Key？
  • A：請聯繫 Honeycomb 管理員獲取 API Key。
• Q：查詢結果為空怎麼辦？
  • A：檢查過濾器條件和時間範圍是否設置正確。