Honeycomb MCP

🚀 蜂巢プロジェクトガイド

Honeycomb は強力なデータ分析プラットフォームで、クエリの実行、データの分析、レポートの生成をサポートしています。以下では、Honeycomb ツールの使用方法を詳しく説明します。

🚀 クイックスタート

Honeycomb ツールを使って、データ分析を行うことができます。まずは、このツールの機能や使い方を理解しましょう。

✨ 主な機能

ツール機能の概要

• クエリの実行：様々な計算操作とフィルターをサポートし、データから重要な情報を抽出するのに役立ちます。
• 応答の最適化：すべてのツールの応答は最適化されており、コンテキストウィンドウの使用を減らしつつ、必要な情報の完全性を維持します。

ツール応答の最適化について

• データセットの一覧表示：名前、識別子、簡単な説明を返します。
• 列情報の取得：フィールド名、タイプ、説明を返します。
• クエリの実行：
  • 実際の結果とメタデータを含みます。
  • 要約統計情報を自動的に計算します。
  • ヒートマップクエリの系列データのみを含みます。
  • 冗長なリンクや実行詳細を省略します。
• 列の分析：
  • トップ値、カウント、重要な統計情報を返します。
  • 適切な場合は、数値指標を自動的に計算します。

クエリ規則の詳細

サポートされる操作

• 計算操作：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", "順序": "降順"}
  ]
}

データベース呼び出しの分布クエリ（過去 1 週間）

{
  "環境": "生産",
  "データセット": "api-requests",
  "計算": [
    {"フィールド": "duration_ms", "操作": "HEATMAP"}
  ],
  "フィルター": [
    {"フィールド": "db.statement", "操作": "exists"}
  ],
  "グループ化": ["db.statement"],
  "時間範囲": "過去 1 週間"
}

エラー率分析クエリ

{
  "環境": "生産",
  "データセット": "api-requests",
  "計算": [
    {"フィールド": "error_rate", "操作": "AVG"}
  ],
  "フィルター": [
    {"フィールド": "status_code", "操作": "in", "値": [400, 500]}
  ]
}

📦 インストール

環境の準備

# 依存関係のインストール
npm install honeycomb-client

コード例

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 ファイルを参照してください。

📚 ドキュメント

付録

エラーコードの説明

• 401：未承認
• 500：サーバー内部エラー
• 400：リクエスト形式が誤っています。

よくある質問

• Q: API Key をどうやって取得できますか？
  • A: Honeycomb の管理者に連絡して API Key を取得してください。
• Q: クエリ結果が空の場合はどうすればいいですか？
  • A: フィルター条件と時間範囲が正しく設定されているか確認してください。