Honeycomb automatically maps source data fields for you if you follow Honeycomb field naming conventions. Otherwise, you must map your dataset fields manually. Honeycomb automatically maps source data fields if you follow Honeycomb field naming conventions. If your field names differ from the standard names, or if you have already sent data and can’t change field names in your source, you can map fields manually using Dataset Definitions.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 dataset fields
Honeycomb identifies a dataset as a trace dataset if you send all of these fields to Honeycomb:trace.trace_idtrace.span_idduration_ms
| 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 | trace.parent_id | No |
| Route | HTTP URL or equivalent route processed by the request. | string, calculated field | http.route | 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 | trace.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 | user.id | Yes |
Log dataset fields
Honeycomb identifies a dataset as a logs dataset if you send a field namedbody to Honeycomb.
If your field name differs, map it manually in Dataset Definitions.
| Dataset Field | Description | Allowed Type(s) | Source Field Name |
|---|---|---|---|
| Log Message | Value containing the log event message. May be a human-readable string (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: trace, debug, info, warn, error, fatal, and unspecified. | string, calculated field | severity |
Mapping visualization components
Honeycomb visualizations rely on fields in your source data being mapped to Honeycomb standard fields. If you ever see an unpopulated visualization in Honeycomb, check your dataset definitions first! Unmapped data is the main cause of visualizations missing data.Trace dropdowns
Each trace chart visualization’s accompanying dropdown is populated with source fields mapped to Honeycomb dataset fields. You can map your source fields to the selected dataset’s fields using Dataset Definitions. Dataset fields you can map include:- Error: Value that indicates an error occurred.
- HTTP Status Code: Code that indicates the success, failure, or other status of a request.
- Name: Name of the function or method in which the span was created.
- Route: HTTP URL or equivalent route processed by the request.
- User: User making the request in the system.
k8s.pod.name,source.k8s.pod.name, ordestination.k8s.pod.name: Name of the Kubernetes pod.k8s.container.name,source.k8s.container.name, ordestination.k8s.container.name: Name of the Kubernetes container.k8s.node.name,source.k8s.node.name, ordestination.k8s.node.name: Name of the Kubernetes node.k8s.namespace.name,source.k8s.namespace.name, ordestination.k8s.namespace.name: Name of the Kubernetes namespace.source.k8s.service.nameordestination.k8s.service.name: Name of the Kubernetes service.
Exception fields
Exception visualizations are populated by OpenTelemetry Exception source fields. If your exception visualizations are empty, verify that your instrumentation includes theexception.type and exception.message fields.
Mapping fields manually
If you have already sent data into a Honeycomb dataset or you are unable to change field names in your source data, use Dataset Definitions to manually map the standard fields in your Honeycomb dataset to the source fields in your data:- Select Manage Data () from the navigation menu, and choose Datasets.
- Select the name of your target dataset to access its settings.
- Select the Definitions view.
- Locate the appropriate Honeycomb Dataset Field, then select the source field in your data from the corresponding Field name dropdown.
- Select Update.