Set or Update Dataset Definitions
Set or update one or more definitions for a Dataset.
Note: While the PATCH payload can include the column_type, Honeycomb does not use this field when updating Dataset Definitions.
Authorizations
A Honeycomb Configuration Key is required to use this API. A Configuration Key can be found in the API Keys section of the environment configuration, which can be found under Environment Settings -> API Keys -> Configuration tab. Check out our documentation to find your API Keys.
More information can be found in Manage Environments.
Path Parameters
The dataset slug.
Body
The PATCH payload takes a map of Dataset definition type to Dataset definition. Fields not defined in the request are not modified on the server. Note: In order to CLEAR a column of a Dataset definition set the column’s name field to an empty string.
Dataset Definitions describe the fields with special meaning in the Dataset.
The unique identifier (ID) for each span.
The ID of the trace this span belongs to.
The Parent Span ID - The ID of this span's parent span, the call location the current span was called from.
The name of the function or method where the span was created.
The name of the instrumented service.
Span Duration - How much time the span took, in milliseconds.
Metadata: Kind - The kind of Span. For example, client or server. The use of this field to identify Span Events and Links is deprecated. Use the field Metadata: Annotation Type.
Metadata: Annotation Type - The type of span annotation. For example, span_event or link. This lets Honeycomb visualize this type of event differently in a trace. Do not use this field for other purposes.
Metadata: Link Span ID - Links let you tie traces and spans to one another. The Link Span ID lets you link to a different span (when used with Link Trace ID).
Metadata: Link Trace ID - Links let you tie traces and spans to one another. The Link Trace Id lets you link to a different trace or a different span in the same trace (when used with Link Span ID).
Use a Boolean or String to indicate error.
Indicates the success, failure, or other status of a request.
The HTTP URL or equivalent route processed by the request.
The user making the request in the system.
Severity level of the event (also known as log level). Supported values: trace, debug, info, warn, error, fatal, unspecified.
A value containing the log event message. Can be a human-readable string message (including multi-line) describing the event in a free form.
Response
Dataset Definitions have been updated
Dataset Definitions describe the fields with special meaning in the Dataset.
The unique identifier (ID) for each span.
The ID of the trace this span belongs to.
The Parent Span ID - The ID of this span's parent span, the call location the current span was called from.
The name of the function or method where the span was created.
The name of the instrumented service.
Span Duration - How much time the span took, in milliseconds.
Metadata: Kind - The kind of Span. For example, client or server. The use of this field to identify Span Events and Links is deprecated. Use the field Metadata: Annotation Type.
Metadata: Annotation Type - The type of span annotation. For example, span_event or link. This lets Honeycomb visualize this type of event differently in a trace. Do not use this field for other purposes.
Metadata: Link Span ID - Links let you tie traces and spans to one another. The Link Span ID lets you link to a different span (when used with Link Trace ID).
Metadata: Link Trace ID - Links let you tie traces and spans to one another. The Link Trace Id lets you link to a different trace or a different span in the same trace (when used with Link Span ID).
Use a Boolean or String to indicate error.
Indicates the success, failure, or other status of a request.
The HTTP URL or equivalent route processed by the request.
The user making the request in the system.
Severity level of the event (also known as log level). Supported values: trace, debug, info, warn, error, fatal, unspecified.
A value containing the log event message. Can be a human-readable string message (including multi-line) describing the event in a free form.