Honeycomb

🚀 Honeycomb Guide

This guide provides a detailed overview of the Honeycomb tool, including query specifications, tool usage, and development requirements.

🚀 Quick Start

Running the Query Tool

pnpm run query

✨ Features

Query Specification

Operators

• COUNT: Count the total number.
• CONCURRENCY: Count the number of concurrent operations.
• COUNT_DISTINCT: Count the number of distinct values.
• HEATMAP: Draw a heatmap.
• SUM: Calculate the sum.
• AVG: Calculate the average.
• MAX: Find the maximum value.
• MIN: Find the minimum value.
• P001, P01, P05, P10, P25, P50, P75, P90, P95, P99, P999: Calculate the specified percentiles.
• RATE_AVG, RATE_SUM, RATE_MAX: Calculate the average, sum, and maximum of the rates.

Filter Conditions

• Supported operators: =, !=, >, >=, <, <=, starts-with, does-not-start-with, exists, does-not-exist, contains, does-not-contain, in, not-in.
• Example:

  {"column": "error", "op": "=", "value": true}
  

Filter Combinations

• Supported logic: AND or OR (default is AND).

Grouping Fields

• Example:

  ["service.name", "http.status_code"]
  

Sorting Rules

• Must reference grouping fields or calculated fields.
• Sorting is not supported for heatmap operations.
• Example:

  {"op": "COUNT", "order": "descending"}
  

Time Range

• Supports relative time (in seconds) and absolute timestamps.
• Examples:

  --time_range=3600 # Represents data from the past hour.
  --start_time=1625937600 --end_time=1625940000 # Represents a specific time period.
  

Having Filter

• Example:

  {"calculate_op": "COUNT", "op": ">", "value": 100}
  

Tool Explanation

Query Tool Output Results

pnpm run query -- --help

📦 Installation

Installing Dependencies

pnpm install

Compiling and Building

pnpm run build

🔧 Technical Details

Environment Requirements

• Node.js Version: 16+
• Honeycomb API Permissions:
  • Query permissions are used for data analysis.
  • Read permissions are used to obtain SLO and trigger information.
  • Environment-level permissions are used for dataset operations.

💻 Usage Examples

Basic Query

pnpm run query -- --table user_activity --where "user_id=123" --fields id, timestamp, action

Advanced Query

pnpm run query -- --file ./queries/weekly_report.sql

📄 License

• MIT License: Please refer to the project's LICENSE file.

For further assistance, please refer to the relevant documentation or contact the technical support team.