1. Docs
  2. Enhance
  3. Honeycomb Dataset Fields

Honeycomb Dataset Fields

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.

Trace Datasets 

Honeycomb will identify a dataset as a trace dataset, if you either:

  • send a source field named trace.trace_id to 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:

Tip

To allow Honeycomb to detect and map dataset fields automatically, name the data field you send to Honeycomb the value listed in the Source Field Name column.

To learn how to map dataset fields manually, visit Map Data.

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, derived column error Yes
HTTP Status Code Code that indicates the success, failure, or other status of a request. string, integer, derived column response.status_code Yes
Metadata: Annotation Type Type of the span annotation, which controls how Honeycomb visualizes this even 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 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. 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. trace.link.trace_id No
Name Name of the function or method in which the span was created. string, integer, derived column name Yes
Parent span ID ID of the span’s parent span, which is the location from which the span was called. parent_id No
Route HTTP URL or equivalent route processed by the request. string, derived column Not automatically mapped Yes
Service name Name of the instrumented service. service.name No
Span duration Length of time the span took in milliseconds (ms). Used to calculate the “95th Percentile Latency” visualizations. float, integer duration_ms or durationMs No
Span ID Unique ID of the span. span_id No
Trace ID Unique ID of the trace to which the span belongs. trace.trace_id No
User User making the request in the system. string, integer, derived column Not automatically mapped Yes

Log Datasets 

For Honeycomb to identify a dataset as a logs dataset, either:

  • send a source field named body to 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:

Tip

To allow Honeycomb to detect and map dataset fields automatically, name the data field you send to Honeycomb the value listed in the Source Field Name column.

To learn how to map dataset fields manually, visit Map Data.

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, derived column 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, derived column severity
On this page: