otelfields

Documentation

Index

• Constants
• Variables
• type Resource
• type TraceContext

Constants

const (
	// ResourceFieldKey is the key used to identify Resource in stores.
	ResourceFieldKey = "Resource"
)

Variables

var AttributesNamespace = zap.Namespace("Attributes")

attributesNamespace is the namespace under which all arbitrary fields are logged, as per the OpenTelemetry spec.

Only for internal use.

Types

type Resource

type Resource struct {
	// Name is the logical name of the service. Must be the same for all instances of
	// horizontally scaled services. Optional, and falls back to 'unknown_service' as per
	// the OpenTelemetry spec.
	Name string
	// Namespace helps to distinguish a group of services, for example the team name that
	// owns a group of services. Optional.
	Namespace string
	// Version is the version string of the service API or implementation. For Navegos
	// services, this should be from 'internal/version.Version()'
	Version string
	// InstanceID is the string ID of the service instance. For Navegos services, this
	// should be from 'internal/hostname.Get()'
	//
	// If unset, InstanceID is set to a generated UUID, as per the OpenTelemetry log spec:
	// https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/#service
	InstanceID string
}

Resource represents a service instance.

https://opentelemetry.io/docs/reference/specification/Resource/semantic_conventions/#service

type TraceContext

type TraceContext struct {
	TraceID string
	SpanID  string
}

TraceContext represents a trace to associate with log entries.

https://opentelemetry.io/docs/reference/specification/logs/data-model/#trace-context-fields