Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.honeycomb.io/llms.txt

Use this file to discover all available pages before exploring further.

Get instant insights into your system with Board Templates.
This functionality is available only for teams using Honeycomb’s current data model. If you use Honeycomb Classic, we recommend migrating to Honeycomb Environments, so you can take advantage of its expanded data model and future product updates.

​
What is a Board Template?

Board Templates are pre-configured Boards that come with ready-made queries and visualizations, providing valuable insights with minimal set up. Use a template as starting point to create a Board. Templates are designed for specific use cases and built around industry best practices, ensuring effective configurations for tracking key metrics and visualizing data accurately.

​
Board Templates At a Glance

Choose from a variety of templates to quickly gain insights across different areas of your system:
  • General:
    • Service Health: Insight into service health, including request volumes and where slowest requests occur.
    • Airflow: Overview of data workflow performance. Monitoring Airflow operations can highlight problems which may occur in the process of running data pipelines.
    • Kafka: Insight into Kafka brokers, topics, partition, and consumers.
    • Linux Host: Useful queries for monitoring Linux hosts, including CPU, memory, disk, filesystem, and network utilization on the configured hosts.
    • Spring Boot: Insight into application health and performance metrics for your Spring Boot microservices.
    • Django: Insight into application heath and performance metrics for your Django application.
    • Rails: Queries to help investigate the performance and health of your Rails application.
    • RabbitMQ: Visualizations for core RabbitMQ metrics and client signals.
    • My Services: Application Performance Monitoring (APM) metrics for a variety of services and frameworks.
  • Data Stores
    • MySQL Operations: Insight into MySQL database operations, including thread count by type, query rate, resource usage, and row/table locks.
    • Redis: Insight into Redis primary and replica nodes, including command activity, latency/volume and execution time, expired keys, and CPU consumption.
    • Postgres: Insight into Postgres’s operations, including active connections, database size, table count, and transaction throughput.
    • MongoDB: Metrics-driven visualizations for monitoring MongoDB nodes.
    • SQL Server: Useful metrics for monitoring SQL Server database operations.
  • Frontend Investigation
    • Real User Monitoring (RUM): Real user monitoring data for frontend applications, including performance and user experience insights.
    • Android Auto-Instrumentation: Auto-instrumentation data for Android applications provided by the Honeycomb OpenTelemetry Android SDK.
    • iOS Auto-Instrumentation: Auto-instrumentation data for iOS applications provided by the Honeycomb OpenTelemetry Swift SDK.
  • Kubernetes:
    • Kubernetes Pod Metrics: Queries and visualizations that help you investigate pod performance and resource usage within Kubernetes clusters.
    • Kubernetes Node Metrics: Queries and visualizations that help you investigate node performance and resource usage within Kubernetes clusters.
    • Kubernetes Workload Health: Queries and visualizations that help you investigate application problems related to Kubernetes workloads.
  • OpenTelemetry:
    • OpenTelemetry Collector Operations: Metrics emitted by the OpenTelemetry Collector during operation.
    • OpenTelemetry Java Metrics: Insights into Java Virtual Machine (JVM) health and performance via metrics reported by OpenTelemetry Java Agent or Honeycomb OpenTelemetry Distribution for Java.
  • Amazon Web Services (AWS):
    • AWS Lambda Health: Information about AWS Lambda function health, including invocations, errors, throttles, and concurrency.
    • EC2 Health: Information about AWS EC2 instance, status failures, and EBS read/write operations.
    • ALB/ELB Health: Information about AWS Load Balancers, including Load Balancer’s health, status codes, active connections, and requests.
    • SQS: Insight into critical AWS SQS operations.
    • RDS: Insight to monitor and optimize performance for AWS RDS databases.
  • Artificial Intelligence:
    • Anthropic Usage & Cost Monitoring: Comprehensive insights into Anthropic API usage and costs, including token consumption, feature usage, and cost attribution across models, workspaces, and API keys.
  • Honeycomb Features:
    • Refinery Operations: Overview of sampling operations, including trace throughput and sampling statistics. Automatically populated by Refinery metrics sent to Honeycomb.
    • Activity Log Security: Queries showing API Key activity.
    • Activity Log Leaderboard: Queries showing advanced and frequent Honeycomb usage by your team.
    • Activity Log Trigger and SLO Activity: Queries related to trigger and SLO activations and modifications.

​
General

​
Service Health

The Service Health Board Template offers an overview of your services’ health. It provides insights into request volumes, identifies where the slowest requests are occurring, and more.
This template relies on your source data fields being mapped to Honeycomb standard fields. To learn how to map your fields, visit Dataset Definitions.

​
Airflow

The Airflow Board Template gives an overview of data workflow performance. Monitoring Airflow operations can highlight problems which may occur in the process of running data pipelines.
We derive the required fields in this template from Airflow’s support for OpenTelemetry logs, metrics, and traces. To learn more, visit our documentation about about instrumenting your Python data pipelines and applications.

​
Kafka

The Kafka Board Template provides insight into Kafka brokers, topics, partition, and consumers.
This template relies on the Kafka Metrics receiver provided by the OpenTelemetry Collector Contrib distribution. To learn how to set up this receiver, visit Kafka metrics receiver documentation in the OpenTelemetry Collector Contrib repo. To receive relevant Java Virtual Machine (JVM) metrics, include the OpenTelemetry Java Agent in Kafka nodes as well.

​
Linux Host

The Linux Host Board Template provides useful queries for monitoring Linux hosts. It provides insights into CPU, memory, disk, filesystem, and network utilization on the configured hosts.
This template uses the Host Metrics receiver provided by the OpenTelemetry Collector Contrib distribution. To learn how to set up this receiver, visit the Host Metrics receiver documentation in the OpenTelemetry Collector Contrib repo.When configuring the hostmetrics receiver for this Board Template, include these scrapers:
  • CPU
  • Disk
  • Load
  • Filesystem
  • Memory
  • Network
  • Paging
  • Processes
  • Process

​
Spring Boot

The Spring Boot Board Template provides insight into application health and performance metrics for Spring Boot microservices.
Source data for this Board Template is configured using automatic instrumentation provided by the OpenTelemetry Java Agent SDK. To learn more, visit our Java automatic instrumentation instructions.

​
Django

The Django Board Template provides insight into application heath and performance metrics for a Django application.
This template uses the OpenTelemetry Python API for automatic instrumentation via the OpenTelemetry Python SDK. To learn more, visit the OpenTelemetry Python API documentation and its Django instrumentation instructions.

​
Rails

The Rails Board Template gives you visibility into Rails behavior, performance, and health. The queries and visualizations help identify slow database queries, inefficient code paths, and other performance bottlenecks.
We derive the required fields in this template from Ruby and Ruby on Rails support for OpenTelemetry logs, metrics, and traces. To learn more, visit our documentation on instrumenting your Ruby and Ruby on Rails applications.

​
RabbitMQ

The RabbitMQ Board contains visualizations for core RabbitMQ metrics and client signals.
This Board uses the RabbitMQ receiver provided by the opentelemetry-collector-contrib distribution. To learn how to set up this receiver, visit the RabbitMQ documentation in OpenTelemetry’s Collector Contrib repo. When configuring RabbitMQ, enable the management plugin to use the receiver.By default, the RabbitMQ receiver disables several key metrics for resource and connectivity utilization. To learn more, visit the RabbitMQ metrics documentation in OpenTelemetry’s Collector Contrib repo.

​
My Services

The My Services template provides Application Performance Monitoring (APM) metrics for a variety of services and frameworks.
This template relies solely on semantic conventions and traces to provide a general overview of APM for HTTP-driven services. It should work with a variety of frameworks, languages, and runtimes.To learn how to generate telemetry data for this Board, visit Honeycomb OpenTelemetry documentation.

​
Data Stores

​
MySQL Operations

The MySQL Board Template provides insights into MySQL database operations, including thread count by type, query rate, resource usage, and row/table locks.
This template relies on the MySQL metrics receiver provided by the OpenTelemetry Collector Contrib distribution. To learn how to set up this receiver, visit MySQL Receiver documentation in the OpenTelemetry Collector Contrib repo.

​
Redis

The Redis Board Template provides insights into Redis primary and replica nodes, including command activity, latency/volume and execution time, expired keys, and CPU consumption.
This template uses the Redis receiver provided by the OpenTelemetry Collector Contrib distribution. To learn how to set up this receiver, visit the Redis receiver documentation in the OpenTelemetry Collector Contrib repo.The Redis receiver does not automatically publish some key server attributes, like address or port. The visualizations on this Board Template use server address to ensure that visualizing across multiple Redis instances is possible.

​
Postgres

The Postgres Board Template provides insight into Postgres’s operations, including active connections, database size, table count, and transaction throughput.

​
MongoDB

The MongoDB template contains metrics-driven visualizations for monitoring MongoDB nodes.
This Board leverages metrics collected via the MongoDB receiver provided by the OpenTelemetry Collector Contrib distribution. The MongoDB receiver enables observability into key performance, resource utilization, and replication metrics for MongoDB clusters and nodes. To configure this receiver, visit MongoDB receiver documentation in the OpenTelemetry Collector Contrib repo.

​
SQL Server

The SQL Server Board template contains useful metrics for monitoring SQL Server database operations.
This template leverages metrics gathered primarily by the SQL Server Receiver provided by the opentelemetry-collector-contrib distribution. The SQL Server receiver provides insights into query execution, connection states, memory usage, and throughput across SQL Server instances and databases. To learn how to set up this receiver, visit the SQL Server Receiver documentation in the OpenTelemetry Collector Contrib repo.

​
Frontend Investigation

​
Real User Monitoring (RUM)

The RUM Board Template provides an overview of real user monitoring data from your frontend applications.
This template relies on your source data fields being mapped to Honeycomb standard fields. To learn how to map your fields, visit Dataset Definitions. To learn more about instrumenting your frontend application, visit Send Browser Data with Honeycomb Web Instrumentation.

​
Android Auto-Instrumentation

The Android Auto-Instrumentation Board Template provides an overview of the Honeycomb OpenTelemetry Android SDK auto-instrumentation.
This template relies on your source data fields being mapped to Honeycomb standard fields. To learn how to map your fields, visit Dataset Definitions. To learn more about instrumenting your frontend application, visit Send Android Data to Honeycomb.

​
i0S Auto-Instrumentation

The iOS Auto-Instrumentation Board Template provides an overview of the Honeycomb OpenTelemetry Swift SDK auto-instrumentation.
This template relies on your source data fields being mapped to Honeycomb standard fields. To learn how to map your fields, visit Dataset Definitions. To learn more about instrumenting your frontend application, visit Send iOS Data to Honeycomb with Swift.

​
Kubernetes

Use the Kubernetes Quick Start to instrument the required fields for Kubernetes Board Templates.

​
Kubernetes Pod Metrics

The Kubernetes Pod Metrics Board Template includes queries that help you investigate pod performance and resource usage within Kubernetes clusters:

​
Kubernetes Node Metrics

The Kubernetes Node Metrics Board Template includes queries that help you investigate node performance and resource usage within Kubernetes clusters:

​
Kubernetes Workload Health

The Kubernetes Workload Health Board Template includes queries that help you diagnose Kubernetes-related application issues:

​
OpenTelemetry

​
OpenTelemetry Collector Operations

The OpenTelemetry Collector Operations Board Template includes queries with key metrics emitted by the OpenTelemetry Collector during its operation:

​
OpenTelemetry Java Metrics

The OpenTelemetry Java Metrics Board Template includes queries that help you investigate application issues related to the Java Virtual Machine (JVM).
Metrics for Java applications are sourced from the JVM and reported by the OpenTelemetry Java Agent or Honeycomb OpenTelemetry Distribution for Java.

​
AWS

​
AWS Lambda Health

The AWS Lambda Health Board Template includes queries that monitor the health of AWS Lambda functions, including metrics for invocations, errors, throttles, and concurrency:

​
EC2 Health

The AWS EC2 Board Template includes queries that monitor the health of AWS EC2 instances, including status failures, disk Read and Write operations, and EBS operations:

​
AWS ALB/ELB Health

The AWS ALB/ELB Board Template includes queries that monitor the Load Balancer’s health, status codes, active connections, and requests.
This template relies on AWS Metrics streams provided by AWS Cloudwatch. Data is streamed from an AWS Kinesis Data Firehose to an endpoint compatible with CloudWatch Metric Streams. To use this template, you must provision a metrics stream for EC2 instances that you wish to monitor.

​
SQS

The SQS Board Template provides insight into critical AWS SQS operations.
This template relies on AWS Metrics streams provided by AWS Cloudwatch. Data is streamed from an AWS Kinesis Data Firehose to an endpoint compatible with CloudWatch Metric Streams. To use this template, you must provision a metrics stream for EC2 instances that you wish to monitor.

​
RDS

The RDS Board Template provides insight to monitor and optimize performance for AWS RDS databases.
This template relies on AWS Metrics streams provided by AWS Cloudwatch. Data is streamed from an AWS Kinesis Data Firehose to an endpoint compatible with CloudWatch Metric Streams. To use this template, you must provision a metrics stream for EC2 instances that you wish to monitor.

​
Honeycomb Features

​
Refinery Operations

For teams using Refinery to sample their data, the Refinery Board Template provides an overview of sampling operations.
Refinery emits metrics that provide insights into its health, trace throughput, and sampling statistics. Required fields in the Refinery Board Template map to these metrics and populate automatically when sent to Honeycomb. To learn more about these fields, visit Refinery Configuration.

​
Activity Log Security

The Activity Log Security Board Template includes queries that track API Key activity.
Honeycomb automatically creates the required fields for the Activity Log Board Templates when it generates Activity Log events.

​
Activity Log Leaderboard

The Activity Log Leaderboard Board Template includes queries that highlight advanced and frequent usage of Honeycomb by your team.
Honeycomb automatically creates the required fields for the Activity Log Board Templates when it generates Activity Log events.

​
Activity Log Trigger and SLO Activity

The Activity Log Trigger and SLO Activity Board Template includes queries related to trigger and SLO activations and modifications.
Honeycomb automatically creates the required fields for the Activity Log Board Templates when it generates Activity Log events.

​
Artificial Intelligence

​
Anthropic Usage & Cost Monitoring

The Anthropic Usage & Cost Monitoring Board Template provides comprehensive insights into your Anthropic API usage and costs, including token consumption, feature usage, and cost attribution across models, workspaces, and API keys.
This Board Template requires data from the Anthropic Usage & Cost Monitoring integration. The integration uses a custom OpenTelemetry collector to collect usage metrics and cost data from the Anthropic Admin API.
Key visualizations include: Usage Analytics:
  • Token Usage Over Time: Track input, output, and cache token consumption trends
  • Usage by Model: Compare token usage across different Claude models
  • Workspace Usage Distribution: Monitor usage patterns across different workspaces
  • API Key Activity: Track usage by individual API keys for access control insights
Cost Monitoring:
  • Daily Cost Trends: Monitor spending patterns over time
  • Cost by Model: Understand which models drive the highest costs
  • Workspace Cost Attribution: Allocate costs across different teams or projects
  • Cost per Token Analysis: Calculate cost efficiency metrics
Performance Insights:
  • Cache Hit Rate: Monitor cache utilization to optimize costs
  • Feature Usage: Track web search and other feature utilization
  • Service Tier Distribution: Analyze usage across different API service tiers
The Board Template automatically populates when the Anthropic Usage Receiver sends metrics and logs to Honeycomb. Required fields include model, workspace_id, service_tier, and cost-related attributes like amount_minor_units and description.

​
Troubleshooting

To explore common issues when working with Board Templates, visit Common Issues with Visualization: Board Templates.