cloudprovider

Documentation

Overview

Package cloudprovider allows to automatically set consistent logs' fields and traces' attributes for OpenTelemetry based on the cloud provider hosting the running helix service.

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

Index

• type CloudProvider

Types

type CloudProvider

type CloudProvider interface {

	// String returns the string representation of the cloud provider.
	//
	// Examples:
	//
	//   "kubernetes"
	//   "nomad"
	//   "render"
	//   "qovery"
	//   "unknown"
	String() string

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

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

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

CloudProvider defines the requirements each cloud provider must meet to be compatible with the helix.go ecosystem.

var Detected CloudProvider

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