model

Documentation

Index

• Variables
• func GenericMapPtrFromMap(inputMap map[string]interface{}) *zkUtilsCommonModel.GenericMap
• type ErrorType
• type ExceptionDetails
• type OTelSpanDetails
  • func (s *OTelSpanDetails) GetResourceIP() string
  • func (s *OTelSpanDetails) SetParentSpanId(parentSpanId string)
• type ProtocolType
• type ResourceInfo
• type ScopeInfo
• type SpanErrorInfo
• type SpanKind
  • func NewFromOTelSpan(otelSpanKind v1.Span_SpanKind) SpanKind
• type TelemetryDetails
  • func CreateTelemetryDetails(resourceAttrMap map[string]interface{}) *TelemetryDetails

Variables

var ServiceNameKey = "service.name"

var ServiceVersionKey = "service.version"

var TelemetryAutoVersionKey = "telemetry.auto.version"

var TelemetrySdkLanguageKey = "telemetry.sdk.language"

var TelemetrySdkNameKey = "telemetry.sdk.name"

var TelemetrySdkVersionKey = "telemetry.sdk.version"

Functions

func GenericMapPtrFromMap

func GenericMapPtrFromMap(inputMap map[string]interface{}) *zkUtilsCommonModel.GenericMap

Types

type ErrorType

type ErrorType string

const (
	ErrorTypeException ErrorType = "exception"
)

type ExceptionDetails

type ExceptionDetails struct {
	Message    string `json:"message"`
	Stacktrace string `json:"stacktrace"`
	Type       string `json:"type"`
}

type OTelSpanDetails

type OTelSpanDetails struct {
	// Span common Properties
	ParentSpanId  string          `json:"parent_span_id"`
	SpanKind      SpanKind        `json:"span_kind"`
	StartNs       uint64          `json:"start_ns"`
	LatencyNs     uint64          `json:"latency_ns"`
	SchemaVersion string          `json:"schema_version"`
	Errors        []SpanErrorInfo `json:"errors,omitempty"`

	// Span Attributes
	SpanAttributes     *zkUtilsCommonModel.GenericMap `json:"attributes,omitempty"`
	ResourceAttributes *zkUtilsCommonModel.GenericMap `json:"resource_attributes,omitempty"`
	ScopeAttributes    *zkUtilsCommonModel.GenericMap `json:"scope_attributes,omitempty"`

	ResourceAttributesHash string `json:"resource_attributes_hash,omitempty"`
	ScopeAttributesHash    string `json:"scope_attributes_hash,omitempty"`

	// Span Identifier Properties
	ServiceName string `json:"service_name"`
	SpanName    string `json:"span_name"`

	Protocol ProtocolType `json:"protocol"`

	// Network span properties
	SourceIp    *string `json:"source_ip,omitempty"`
	Source      *string `json:"source,omitempty"`
	DestIp      *string `json:"destination_ip,omitempty"`
	Destination *string `json:"destination,omitempty"`

	// Protocol properties.
	Method   *string  `json:"method,omitempty"`
	Route    *string  `json:"route,omitempty"`
	Scheme   *string  `json:"scheme,omitempty"`
	Path     *string  `json:"path,omitempty"`
	Query    *string  `json:"query,omitempty"`
	Status   *float64 `json:"status,omitempty"`
	Username *string  `json:"username,omitempty"`

	// ZeroK Properties
	WorkloadIdList []string                      `json:"workload_id_list,omitempty"`
	GroupBy        zkUtilsCommonModel.GroupByMap `json:"group_by,omitempty"`
}

func (*OTelSpanDetails) GetResourceIP

func (s *OTelSpanDetails) GetResourceIP() string

func (*OTelSpanDetails) SetParentSpanId

func (s *OTelSpanDetails) SetParentSpanId(parentSpanId string)

type ProtocolType

type ProtocolType string

const (
	ProtocolTypeHTTP    ProtocolType = "HTTP"
	ProtocolTypeDB      ProtocolType = "DB"
	ProtocolTypeGRPC    ProtocolType = "GRPC"
	ProtocolTypeUnknown ProtocolType = "UNKNOWN"
)

type ResourceInfo

type ResourceInfo struct {
	AttributesMap zkUtilsCommonModel.GenericMap `json:"attributes_map"`
	SchemaUrl     string                        `json:"schema_url"`
}

type ScopeInfo

type ScopeInfo struct {
	Name          string                        `json:"name"`
	Version       string                        `json:"version"`
	AttributesMap zkUtilsCommonModel.GenericMap `json:"attributes_map"`
	SchemaUrl     string                        `json:"schema_url"`
}

type SpanErrorInfo

type SpanErrorInfo struct {
	Message       string    `json:"message"`
	ErrorType     ErrorType `json:"error_type"`
	ExceptionType string    `json:"exception_type"`
	Hash          string    `json:"hash"`
}

type SpanKind

type SpanKind string

SpanKind represents the type of span.

const (
	// SpanKindUnspecified Unspecified. Do NOT use as default.
	// Implementations MAY assume SpanKind to be INTERNAL when receiving UNSPECIFIED.
	SpanKindUnspecified SpanKind = "UNSPECIFIED"

	// SpanKindInternal Default value. Indicates that the span is used internally.
	SpanKindInternal SpanKind = "INTERNAL"

	// SpanKindServer Indicates that the span covers server-side handling of an RPC or other remote request.
	SpanKindServer SpanKind = "SERVER"

	// SpanKindClient Indicates that the span covers the client-side wrapper around an RPC or other remote request.
	SpanKindClient SpanKind = "CLIENT"

	// SpanKindProducer Indicates that the span describes producer sending a message to a broker.
	//Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans.
	SpanKindProducer SpanKind = "PRODUCER"

	// SpanKindConsumer Indicates that the span describes consumer receiving a message from a broker.
	//Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans
	SpanKindConsumer SpanKind = "CONSUMER"
)

Type of Span. Can be used to specify additional relationships between spans in addition to a parent/child relationship.

func NewFromOTelSpan

func NewFromOTelSpan(otelSpanKind v1.Span_SpanKind) SpanKind

type TelemetryDetails

type TelemetryDetails struct {
	TelemetryAutoVersion string `json:"telemetry_auto_version"`
	TelemetrySdkLanguage string `json:"telemetry_sdk_language"`
	TelemetrySdkName     string `json:"telemetry_sdk_name"`
	TelemetrySdkVersion  string `json:"telemetry_sdk_version"`
	ServiceName          string `json:"service_name"`
	ServiceVersion       string `json:"service_version"`
}

func CreateTelemetryDetails

func CreateTelemetryDetails(resourceAttrMap map[string]interface{}) *TelemetryDetails