Skip to content

SigNoz is an open-source, OpenTelemetry-native observability platform for your team and their AI agents. Get logs, metrics, and traces in one tool with features like APM, distributed tracing, log management, infra monitoring, etc. Combined with SigNoz MCP and a native AI teammate (in SigNoz Cloud) it helps you build more resilient apps.

20.6 KB
Raw Blame
package tracestelemetryschema

import (
	"github.com/SigNoz/signoz/pkg/types/telemetrytypes"
)

const (

	// Internal Columns.
	SpanTimestampBucketStartColumn = "ts_bucket_start"
	SpanResourceFingerPrintColumn  = "resource_fingerprint"

	// Intrinsic Columns.
	SpanTimestampColumn        = "timestamp"
	SpanTraceIDColumn          = "trace_id"
	SpanSpanIDColumn           = "span_id"
	SpanTraceStateColumn       = "trace_state"
	SpanParentSpanIDColumn     = "parent_span_id"
	SpanFlagsColumn            = "flags"
	SpanNameColumn             = "name"
	SpanKindColumn             = "kind"
	SpanKindStringColumn       = "kind_string"
	SpanDurationNanoColumn     = "duration_nano"
	SpanStatusCodeColumn       = "status_code"
	SpanStatusMessageColumn    = "status_message"
	SpanStatusCodeStringColumn = "status_code_string"
	SpanEventsColumn           = "events"
	SpanLinksColumn            = "links"

	// Calculated Columns.
	SpanResponseStatusCodeColumn = "response_status_code"
	SpanExternalHTTPURLColumn    = "external_http_url"
	SpanHTTPURLColumn            = "http_url"
	SpanExternalHTTPMethodColumn = "external_http_method"
	SpanHTTPMethodColumn         = "http_method"
	SpanHTTPHostColumn           = "http_host"
	SpanDBNameColumn             = "db_name"
	SpanDBOperationColumn        = "db_operation"
	SpanHasErrorColumn           = "has_error"
	SpanIsRemoteColumn           = "is_remote"

	// Contextual Columns.
	SpanAttributesStringColumn   = "attributes_string"
	SpanAttributesNumberColumn   = "attributes_number"
	SpanAttributesBoolColumn     = "attributes_bool"
	SpanAttributesColumn         = "attributes"
	SpanAttributesPromotedColumn = "attributes_promoted"
	SpanResourcesStringColumn    = "resources_string"
	SpanScopeColumn              = "scope"
)

var (
	IntrinsicFields = map[string]telemetrytypes.TelemetryFieldKey{
		"trace_id": {
			Name:          "trace_id",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"span_id": {
			Name:          "span_id",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"trace_state": {
			Name:          "trace_state",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"parent_span_id": {
			Name:          "parent_span_id",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"flags": {
			Name:          "flags",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeNumber,
		},
		"name": {
			Name:          "name",
			Description:   "Name of the span",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"kind_string": {
			Name:          "kind_string",
			Description:   "Span kind enum (string). Known values are ['Client', 'Server', 'Internal', 'Producer', 'Consumer']. Learn more [here](https://opentelemetry.io/docs/concepts/signals/traces/#span-kind)",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"duration_nano": {
			Name:          "duration_nano",
			Description:   "Span duration",
			Unit:          "ns",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeNumber,
		},
		"status_code": {
			Name:          "status_code",
			Description:   "Span status code enum (number). Use `status_code_string` instead. Learn more [here](https://opentelemetry.io/docs/concepts/signals/traces/#span-status)",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeNumber,
		},
		"status_message": {
			Name:          "status_message",
			Description:   "Span status message. Learn more [here](https://opentelemetry.io/docs/concepts/signals/traces/#span-status)",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"status_code_string": {
			Name:          "status_code_string",
			Description:   "Span status code enum (string).  Learn more [here](https://opentelemetry.io/docs/concepts/signals/traces/#span-status)",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"scope.name": {
			Name:          "scope.name",
			Description:   "Instrumentation scope name",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextScope,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"scope.version": {
			Name:          "scope.version",
			Description:   "Instrumentation scope version",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextScope,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
	}
	IntrinsicFieldsDeprecated = map[string]telemetrytypes.TelemetryFieldKey{
		"traceID": {
			Name:          "traceID",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"spanID": {
			Name:          "spanID",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"parentSpanID": {
			Name:          "parentSpanID",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"spanKind": {
			Name:          "spanKind",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"durationNano": {
			Name:          "durationNano",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeNumber,
		},
		"statusCode": {
			Name:          "statusCode",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeNumber,
		},
		"statusMessage": {
			Name:          "statusMessage",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"statusCodeString": {
			Name:          "statusCodeString",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"kind": {
			Name:          "kind",
			Description:   "Span kind enum (number). Use `kind_string` instead. Learn more [here](https://opentelemetry.io/docs/concepts/signals/traces/#span-kind)",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeNumber,
		},
		"timestamp": {
			Name:          "timestamp",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeNumber,
		},
	}

	CalculatedFields = map[string]telemetrytypes.TelemetryFieldKey{
		"response_status_code": {
			Name:          "response_status_code",
			Description:   "Derived response status code from the HTTP/RPC status code attributes. Learn more [here](https://signoz.io/docs/traces-management/guides/derived-fields-spans/#response_status_code)",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"external_http_url": {
			Name:          "external_http_url",
			Description:   "The hostname of the external HTTP URL. Learn more [here](https://signoz.io/docs/traces-management/guides/derived-fields-spans/#external_http_url)",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"http_url": {
			Name:          "http_url",
			Description:   "HTTP URL of the request. Learn more [here](https://signoz.io/docs/traces-management/guides/derived-fields-spans/#http_url)",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"external_http_method": {
			Name:          "external_http_method",
			Description:   "HTTP request method of client spans. Learn more [here](https://signoz.io/docs/traces-management/guides/derived-fields-spans/#external_http_method)",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"http_method": {
			Name:          "http_method",
			Description:   "The HTTP request method. Learn more [here](https://signoz.io/docs/traces-management/guides/derived-fields-spans/#http_method)",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"http_host": {
			Name:          "http_host",
			Description:   "The HTTP host or server address. Learn more [here](https://signoz.io/docs/traces-management/guides/derived-fields-spans/#http_host)",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"db_name": {
			Name:          "db_name",
			Description:   "The database name or namespace. Learn more [here](https://signoz.io/docs/traces-management/guides/derived-fields-spans/#db_name)",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"db_operation": {
			Name:          "db_operation",
			Description:   "The database operation being performed. Learn more [here](https://signoz.io/docs/traces-management/guides/derived-fields-spans/#db_operation)",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"has_error": {
			Name:          "has_error",
			Description:   "Whether the span has an error. Learn more [here](https://signoz.io/docs/traces-management/guides/derived-fields-spans/#has_error)",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeBool,
		},
		"is_remote": {
			Name:          "is_remote",
			Description:   "Whether the span is remote. Learn more [here](https://signoz.io/docs/traces-management/guides/derived-fields-spans/#is_remote)",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
	}

	CalculatedFieldsDeprecated = map[string]telemetrytypes.TelemetryFieldKey{
		"responseStatusCode": {
			Name:          "responseStatusCode",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"externalHttpUrl": {
			Name:          "externalHttpUrl",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"httpUrl": {
			Name:          "httpUrl",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"externalHttpMethod": {
			Name:          "externalHttpMethod",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"httpMethod": {
			Name:          "httpMethod",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"httpHost": {
			Name:          "httpHost",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"dbName": {
			Name:          "dbName",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"dbOperation": {
			Name:          "dbOperation",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"hasError": {
			Name:          "hasError",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeBool,
		},
		"isRemote": {
			Name:          "isRemote",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"serviceName": {
			Name:          "serviceName",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"httpRoute": {
			Name:          "httpRoute",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"msgSystem": {
			Name:          "msgSystem",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"msgOperation": {
			Name:          "msgOperation",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"dbSystem": {
			Name:          "dbSystem",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"rpcSystem": {
			Name:          "rpcSystem",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"rpcService": {
			Name:          "rpcService",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"rpcMethod": {
			Name:          "rpcMethod",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"peerService": {
			Name:          "peerService",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
	}
	SpanSearchScopeRoot       = "isroot"
	SpanSearchScopeEntryPoint = "isentrypoint"

	// SpanSearchScopeFields are the search-scope selectors (isRoot, isEntryPoint),
	// not columns and unrelated to the instrumentation scope: they only filter
	// with the value true.
	SpanSearchScopeFields = map[string]telemetrytypes.TelemetryFieldKey{
		"isRoot": {
			Name:          "isRoot",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeBool,
		},
		"isEntryPoint": {
			Name:          "isEntryPoint",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeBool,
		},
	}

	// IntrinsicSpanFields lists the intrinsic span columns, in the order they
	// should appear when a raw query expands its SelectFields.
	IntrinsicSpanFields = []telemetrytypes.TelemetryFieldKey{
		{Name: SpanTimestampColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanTraceIDColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanSpanIDColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanTraceStateColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanParentSpanIDColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanFlagsColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanNameColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanKindColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanKindStringColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanDurationNanoColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanStatusCodeColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanStatusMessageColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanStatusCodeStringColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanEventsColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanLinksColumn, FieldContext: telemetrytypes.FieldContextSpan},
	}

	// CalculatedSpanFields lists the calculated/derived span columns, in the
	// order they should appear when a raw query expands its SelectFields.
	CalculatedSpanFields = []telemetrytypes.TelemetryFieldKey{
		{Name: SpanResponseStatusCodeColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanExternalHTTPURLColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanHTTPURLColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanExternalHTTPMethodColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanHTTPMethodColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanHTTPHostColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanDBNameColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanDBOperationColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanHasErrorColumn, FieldContext: telemetrytypes.FieldContextSpan},
		{Name: SpanIsRemoteColumn, FieldContext: telemetrytypes.FieldContextSpan},
	}

	// ContextualSpanColumns lists the bag columns selected raw so consume.go can merge
	// them into unified "attributes" and "resource" maps, legacy maps winning on collision.
	ContextualSpanColumns = []string{
		SpanAttributesStringColumn,
		SpanAttributesNumberColumn,
		SpanAttributesBoolColumn,
		SpanResourcesStringColumn,
		SpanAttributesColumn,
		SpanScopeColumn,
	}

	DefaultFields = map[string]telemetrytypes.TelemetryFieldKey{
		"timestamp": {
			Name:          "timestamp",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeNumber,
		},
		"span_id": {
			Name:          "span_id",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"trace_id": {
			Name:          "trace_id",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"name": {
			Name:          "name",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
		"service.name": {
			Name:          "service.name",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextResource,
			FieldDataType: telemetrytypes.FieldDataTypeString,
			Materialized:  true,
		},
		"duration_nano": {
			Name:          "duration_nano",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeNumber,
		},
		"response_status_code": {
			Name:          "response_status_code",
			Signal:        telemetrytypes.SignalTraces,
			FieldContext:  telemetrytypes.FieldContextSpan,
			FieldDataType: telemetrytypes.FieldDataTypeString,
		},
	}
)

const (
	DBName                        = "signoz_traces"
	SpanIndexV3TableName          = "distributed_signoz_index_v3"
	SpanIndexV3LocalTableName     = "signoz_index_v3"
	TagAttributesV2TableName      = "distributed_tag_attributes_v2"
	TagAttributesV2LocalTableName = "tag_attributes_v2"
	TopLevelOperationsTableName   = "distributed_top_level_operations"
	TraceSummaryTableName         = "distributed_trace_summary"
	SpanAttributesKeysTblName     = "distributed_span_attributes_keys"
	TracesResourceV3TableName     = "distributed_traces_v3_resource"
)