Get insights into your system instantly with Board templates. The out-of-the-box boards provide you with custom queries and visualizations on your data with minimal clicking.
To access Board Templates, select Boards in the left navigation bar. Then, in the Boards display, select the Templates tab at the top of the page.
To create a board from a template:
For teams using Refinery to sample their data, the Refinery board template gives an overview of sampling operations.
The Refinery board template includes the following queries:
| Query Name | Query Description | Fields Required |
|---|---|---|
| Stress Relief Status | Current stress level of the Refinery cluster. | stress_level stress_relief_activated hostname or host.name |
| Dropped From Stress | Total traces dropped due to stress on the Refinery cluster. | dropped_from_stress hostname or host.name |
| Stress Relief Log | Reasons why Refinery is going into stress relief. | StressRelief reason msg hostname or host.name |
| Cache Health | Metrics for cache health. | collect_cache_buffer_overrun memory_inuse collect_cache_entries_max or collect_cache_entries.max collect_cache_capacity num_goroutines process_uptime_seconds hostname or host.name |
| Cache Ejections | Number of traces ejected from cache. | trace_send_ejected_full trace_send_ejected_memsize hostname or host.name |
| Intercommunications | Total events from outside Refinery and events redirected from a peer. | incoming_router_span peer_router_batch hostname or host.name |
| Receive Buffers | Receive buffers operations. | incoming_router_dropped peer_router_dropped hostname or host.name |
| Peer Send Buffers | Metrics for the queue used to buffer spans to send to peer nodes. | libhoney_peer_queue_overflow libhoney_peer_send_errors hostname or host.name |
| Upstream Send Buffers | Metrics for the queue used to buffer spans to send to Honeycomb. | libhoney_upstream_queue_length libhoney_upstream_enqueue_errors libhoney_upstream_response_errors libhoney_upstream_send_errors libhoney_upstream_send_retries hostname or host.name |
| EMADynamicSampler Performance | EMADynamicSampler sampling effectiveness. | emadynamic_sample_rate_avg emadynamic_keyspace_size emadynamic_num_kept emadynamic_num_dropped |
| EMAThroughputSampler Performance | EMAThroughputSampler sampling effectiveness. | emathroughput_sample_rate_avg emathroughput_keyspace_size emathroughput_num_kept emathroughput_num_dropped |
| WindowedThroughput Performance | WindowedThroughput sampling effectiveness. | windowedthroughput_sample_rate_avg windowedthroughput_keyspace_size windowedthroughput_num_kept windowedthroughput_num_dropped |
| TotalThroughputSampler Performance | TotalThroughputSampler sampling effectiveness. | totalthroughput_sample_rate_avg etotalthroughput_keyspace_size totalthroughput_num_kept totalthroughput_num_dropped |
| Dynamic Performance | Dynamic sampling effectiveness. | dynamic_sample_rate_avg dynamic_keyspace_size dynamic_num_kept dynamic_num_dropped |
| RulesBasedSampler Performance | RulesBasedSampler sampling effectiveness. | rulesbased_sample_rate_avg rulesbased_num_kept rulesbased_num_dropped |
| Trace Indicators | Total traces sent before completion and span received for a trace already sent. | trace_sent_cache_hit trace_send_no_root |
| Sampling Decisions | Total traces accepted and sent or dropped. | trace_accepted trace_send_dropped trace_send_kept |
| Refinery Send Event Error Logs | Errors when sending events to its peers or upstream to api.honeycomb.io. | msg dataset api_host error |
| Refinery Handler Event Error Logs | Errors when receiving or parsing events being sent to a node. | msg dataset api_host error.err error.msg |
| Refinery Events Exceeding Max Size | Errors when events are too large to be sent to Honeycomb. | msg dataset api_host error |
The Service Health board template gives an overview of the health of your services. It provides insights into request volumes, where the slowest requests are occurring, and more.
The Service Health board template includes the following queries:
| Query Name | Query Description | Fields Required |
|---|---|---|
| Trace Counts by Service | View total trace volume by service. | Parent Span Id, Service Name |
| Trace Counts by HTTP Status Code | View total trace volume by status code. | Parent Span Id, HTTP Status Code |
| Trace Duration Heatmap | Heatmap of the duration for all traces in the environment. | Duration, Parent Span Id |
| Duration Heatmap | View the heatmap for duration across all services. | Duration |
| Duration by Service | View key duration percentiles by service. | Duration, Service Name |
| Duration by Route | View duration by route or endpoint. | Duration, Route |
| Duration by Name | View duration by function name. | Duration, Name |
| Errors by Service | View errors by service. | Error, Service Name |
| Errors by Route | View errors by route or endpoint. | Error, Route |
The RUM board template gives an overview of real user monitoring information in your frontend applications.
The RUM board template includes the following queries:
| Query Name | Query Description | Fields Required |
|---|---|---|
| Total Pageviews | Total number of pageviews | Name |
| Most Visited Pages | Pages with most views | Name, Route |
| Pages with most interactions | Pages with the most clicks | Name, Route |
| Average and p95 Duration of Page Loads | Average and 95th percentile duration for page loads | Duration, Name |
| Largest Page Resources | View and investigate heatmaps for the largest page resources | Name, Duration, Route |
Visualizations in board templates depend on specific fields being available in your data. Add additional insights and eliminate missing queries by configuring or sending the required fields. Sending the necessary data populates the templates with more queries. For more information, refer to our available templates and their required fields.
