Honeycomb MCP

🚀 Honeycomb Project Guide

Honeycomb is a powerful data analysis platform that supports running queries, analyzing data, and generating reports. The following content will provide a detailed introduction on how to use the Honeycomb tool.

✨ Features

Overview of Tool Functions

• Run Queries: Supports various computational operations and filters to help users extract key information from data.
• Optimize Responses: All tool responses are optimized to reduce the use of the context window while maintaining the necessary information integrity.

Explanation of Tool Response Optimization

• List Datasets: Returns names, identifiers, and brief descriptions.
• Get Column Information: Returns field names, types, and descriptions.
• Run Queries:
  • Includes actual results and metadata.
  • Automatically calculates summary statistics.
  • Only includes series data for heatmap queries.
  • Omits redundant links and execution details.
• Analyze Columns:
  • Returns top values, counts, and key statistics.
  • Automatically calculates numerical metrics when appropriate.

Details of Query Specifications

Supported Operations

• Computational Operations: Include COUNT, CONCURRENCY, COUNT_DISTINCT, HEATMAP, SUM, AVG, MAX, MIN, etc.
• Filter Conditions: Support operators such as =, !=, >, >=, <, <=, starts - with, does - not - start - with, exists, does - not - exist, contains, does - not - contain, in, not - in, etc.

Example Queries

Slow API Call Query

{
  "Environment": "Production",
  "Dataset": "api - requests",
  "Calculations": [
    {"Field": "duration_ms", "Operation": "HEATMAP"},
    {"Field": "duration_ms", "Operation": "MAX"}
  ],
  "Filters": [
    {"Field": "trace.parent_id", "Operation": "does - not - exist"}
  ],
  "Grouping": ["http.target", "name"],
  "Sorting": [
    {"Field": "duration_ms", "Operation": "MAX", "Order": "Descending"}
  ]
}

Database Call Distribution Query (Last Week)

{
  "Environment": "Production",
  "Dataset": "api - requests",
  "Calculations": [
    {"Field": "duration_ms", "Operation": "HEATMAP"}
  ],
  "Filters": [
    {"Field": "db.statement", "Operation": "exists"}
  ],
  "Grouping": ["db.statement"],
  "Time Range": "Last Week"
}

Error Rate Analysis Query

{
  "Environment": "Production",
  "Dataset": "api - requests",
  "Calculations": [
    {"Field": "error_rate", "Operation": "AVG"}
  ],
  "Filters": [
    {"Field": "status_code", "Operation": "in", "Value": [400, 500]}
  ]
}

📦 Installation

Environment Setup

# Install dependencies
npm install honeycomb - client

💻 Usage Examples

Basic Usage

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

// Initialize the client
const client = new Honeycomb({
  apikey: 'your_api_key',
  dataset: 'api - requests'
});

// Execute a query
async function runQuery() {
  try {
    const result = await client.runQuery({
      "Calculations": [
        { "Field": "duration_ms", "Operation": "HEATMAP" }
      ],
      "Filters": [
        { "Field": "trace.parent_id", "Operation": "does - not - exist" }
      ]
    });
    console.log(result);
  } catch (error) {
    console.error('Query failed:', error);
  }
}

runQuery();

📄 License

This project is licensed under the Apache 2.0 license. For more detailed information, please refer to the LICENSE file.

📚 Documentation

Appendix

Explanation of Error Codes

• 401: Unauthorized
• 500: Internal Server Error
• 400: Bad Request

Frequently Asked Questions

• Q: How to get an API Key?
  • A: Please contact the Honeycomb administrator to obtain an API Key.
• Q: What if the query result is empty?
  • A: Check if the filter conditions and time range are set correctly.