orchestrator

Documentation

Overview

Package orchestrator allows each orchestrator to set consistent logs' fields and traces' attributes for OpenTelemetry.

This package must not import any other package of this ecosystem.

Index

• type Orchestrator

Types

type Orchestrator

type Orchestrator interface {

	// String returns the string representation of the orchestrator.
	//
	// Examples:
	//
	//   "kubernetes"
	//   "nomad"
	//   "unknown"
	String() string

	// Service returns the service name detected by the orchestrator.
	Service() string

	// LoggerFields returns the fields populated by the orchestrator in OpenTelemetry
	// logs.
	LoggerFields() []zap.Field

	// TracerAttributes returns the attributes populated by the orchestrator in
	// OpenTelemetry traces.
	TracerAttributes() []attribute.KeyValue
}

Orchestrator defines the requirements each orchestrator must meet to be compatible with the helix.go ecosystem.

var Detected Orchestrator

Detected is the orchestrator detected by the service package on init. If no known orchestrator has been detected, this fallbacks to the "unknown" implementation.