To get the most out of Honeycomb visualizations, you will need to map some of the source fields in your sent data to Honeycomb-specific standard dataset fields. Different dataset fields are available depending on the type of dataset you are sending to Honeycomb.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.
Trace Datasets
Honeycomb will identify a dataset as a trace dataset, if you either:- send a source field named
trace.trace_idto Honeycomb, or - manually map a source field to the Trace ID dataset field in the dataset’s Dataset Definitions.
Available Fields
You can map the following dataset fields for a trace dataset:| Dataset Field | Description | Allowed Type(s) | Source Field Name | Can Group By? |
|---|---|---|---|---|
| Error | Value that indicates an error occurred. Used to identify errors when calculating the “Total Spans with Errors” visualizations. | boolean, string, calculated field | error | Yes |
| HTTP Status Code | Code that indicates the success, failure, or other status of a request. | string, integer, float, calculated field | response.status_code | Yes |
| Metadata: Annotation Type | Type of the span annotation, which controls how Honeycomb visualizes this event in a trace. Possible values include span_event (indicates the span is a span event) and link (indicates the span is a span link). | string, calculated field | meta.annotation_type | No |
| Metadata: Link Span ID | Unique ID of the span you want to link to the current span. Indicates the span is a span event. Use with Metadata: Link Trace ID. | string, calculated field | trace.link.span_id | No |
| Metadata: Link Trace ID | Unique ID of the trace you want to link to the current span. Use with Metadata: Link Span ID. | string, calculated field | trace.link.trace_id | No |
| Name | Name of the function or method in which the span was created. | string, calculated field | name | Yes |
| Parent span ID | ID of the span’s parent span, which is the location from which the span was called. | string, calculated field | parent_id | No |
| Route | HTTP URL or equivalent route processed by the request. | string, calculated field | Not automatically mapped | Yes |
| Service name | Name of the instrumented service. | string, calculated field | service.name | No |
| Span duration | Length of time the span took in milliseconds (ms). Used to calculate the “95th Percentile Latency” visualizations. | float, integer, calculated field | duration_ms or durationMs | No |
| Span ID | Unique ID of the span. | string, calculated field | span_id | No |
| Trace ID | Unique ID of the trace to which the span belongs. | string, calculated field | trace.trace_id | No |
| User | User making the request in the system. | float, string, integer, calculated field | Not automatically mapped | Yes |
Log Datasets
For Honeycomb to identify a dataset as a logs dataset, either:- send a source field named
bodyto Honeycomb, or - manually map a source field to the Log Message dataset field in the dataset’s Dataset Definitions.
Available Fields
You can map the following dataset fields for a log dataset:| Dataset Field | Description | Allowed Type(s) | Source Field Name |
|---|---|---|---|
| Log Message | Value containing the log event message. May be a human-readable string message (including multiline) describing the event in free form. | string, calculated field | body |
| Log Severity | Severity level of the event (also known as log level). Supported values include: trace, debug, info, warn, error, fatal, and unspecified. | string, calculated field | severity |