logo

Dataset Definitions

Dataset definitions describe the fields with special meaning in the Dataset.

Refer to the Dataset Definitions documentation for more information.

Honeycomb automatically creates these Dataset definition fields when the Dataset is created. Manual creation of Dataset definitions is not needed.

Authorization

The API key must have the Create Datasets permission. Learn more about API keys here.

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.

Securityapi_key
Request
path Parameters
datasetSlug
required
string

The dataset slug.

Request Body schema: application/json
required

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.

null or object (DatasetDefinition)

The unique identifier (ID) for each span.

null or object (DatasetDefinition)

The ID of the trace this span belongs to.

null or object (DatasetDefinition)

The Parent Span ID - The ID of this span's parent span, the call location the current span was called from.

null or object (DatasetDefinition)

The name of the function or method where the span was created.

null or object (DatasetDefinition)

The name of the instrumented service.

null or object (DatasetDefinition)

Span Duration - How much time the span took, in milliseconds.

null or object (DatasetDefinition)

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.

null or object (DatasetDefinition)

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.

null or object (DatasetDefinition)

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).

null or object (DatasetDefinition)

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).

null or object (DatasetDefinition)

Use a Boolean or String to indicate error.

null or object (DatasetDefinition)

Indicates the success, failure, or other status of a request.

null or object (DatasetDefinition)

The HTTP URL or equivalent route processed by the request.

null or object (DatasetDefinition)

The user making the request in the system.

Responses
200

Dataset Definitions have been updated

400

Bad Request

401

Unauthorized

404

Not Found

422

422 Unprocessable Entity

patch/1/dataset_definitions/{datasetSlug}
Request samples
application/json

Set the duration_ms definition.

{
  • "duration_ms": {
    }
}
Response samples
application/json
{
  • "duration_ms": {
    },
  • "error": null,
  • "name": null,
  • "parent_id": null,
  • "route": null,
  • "service_name": null,
  • "span_id": {
    },
  • "span_kind": null,
  • "annotation_type": null,
  • "link_trace_id": null,
  • "link_span_id": null,
  • "status": null,
  • "trace_id": null,
  • "user": null
}

Get all Dataset Definitions

Get all definitions for a Dataset.

The response returns an object with a Dataset Definition for each set Dataset Definition type.

Securityapi_key
Request
path Parameters
datasetSlug
required
string

The dataset slug.

Responses
200

Success

401

Unauthorized

404

Not Found

get/1/dataset_definitions/{datasetSlug}
Request samples 
Response samples 
application/json
{
  • "duration_ms": {
    },
  • "error": null,
  • "name": null,
  • "parent_id": null,
  • "route": null,
  • "service_name": null,
  • "span_id": {
    },
  • "span_kind": null,
  • "annotation_type": null,
  • "link_trace_id": null,
  • "link_span_id": null,
  • "status": null,
  • "trace_id": null,
  • "user": null
}
➔ Next to Derived Columns