observability

package
v0.16.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 6, 2024 License: Apache-2.0 Imports: 7 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	DefaultOtelOtlpPort         = 8888
	DefaultOtelMetricsPort      = 9090
	DefaultImage                = "otel/opentelemetry-collector-contrib:%s"
	DefaultOtelCollectorVersion = "0.83.0"
)

Variables

View Source 
var (
	ErrCreatingOtelAgentInstance   = errors.New("CreatingOtelAgentInstance", "error creating otel agent instance")
	ErrSettingOtelAgentImage       = errors.New("SettingOtelAgentImage", "error setting image for otel agent instance")
	ErrAddingOtelAgentPort         = errors.New("AddingOtelAgentPort", "error adding Otel Agent port")
	ErrCommittingOtelAgentInstance = errors.New("CommittingOtelAgentInstance", "error committing otel agent instance")
	ErrSettingOtelAgentEnv         = errors.New("SettingOtelAgentEnv", "error setting environment variable for otel agent instance")
	ErrSettingOtelAgentCPU         = errors.New("SettingOtelAgentCPU", "error setting CPU for otel agent instance")
	ErrSettingOtelAgentMemory      = errors.New("SettingOtelAgentMemory", "error setting memory for otel agent instance")
	ErrMarshalingYAML              = errors.New("MarshalingYAML", "error marshaling yaml")
	ErrAddingOtelAgentConfigFile   = errors.New("AddingOtelAgentConfigFile", "error adding otel agent config file")
	ErrSettingOtelAgentCommand     = errors.New("SettingOtelAgentCommand", "error setting otel agent command")
	ErrObsyInstanceNotInitialized  = errors.New("ObsyInstanceNotInitialized", "obsy instance not initialized")
	ErrSettingNotAllowed           = errors.New("SettingNotAllowed", "setting %s is only allowed in state 'None'. Current state is '%s'")
	ErrAddingVolume                = errors.New("AddingVolume", "error adding volume")
)

Functions

This section is empty.

Types

type Action 

type Action struct {
	Key    string `yaml:"key,omitempty"`
	Value  string `yaml:"value,omitempty"`
	Action string `yaml:"action,omitempty"`
}

type Attributes 

type Attributes struct {
	Actions []Action `yaml:"actions,omitempty"`
}

type BasicAuthOTLP 

type BasicAuthOTLP struct {
	ClientAuth ClientAuth `yaml:"client_auth,omitempty"`
}

type Batch 

type Batch struct{}

type ClientAuth 

type ClientAuth struct {
	Username string `yaml:"username,omitempty"`
	Password string `yaml:"password,omitempty"`
}

type Error 

type Error = errors.Error

type Exporters 

type Exporters struct {
	OTLPHTTP              OTLPHTTPExporter              `yaml:"otlphttp,omitempty"`
	Jaeger                JaegerExporter                `yaml:"jaeger,omitempty"`
	Prometheus            PrometheusExporter            `yaml:"prometheus,omitempty"`
	PrometheusRemoteWrite PrometheusRemoteWriteExporter `yaml:"prometheusremotewrite,omitempty"`
	Logging               LoggingExporter               `yaml:"logging,omitempty"`
}

type Extensions 

type Extensions struct {
	BasicAuthOTLP BasicAuthOTLP `yaml:"basicauth/otlp,omitempty"`
}

type Jaeger 

type Jaeger struct {
	Protocols JaegerProtocols `yaml:"protocols,omitempty"`
}

type JaegerExporter 

type JaegerExporter struct {
	Endpoint string `yaml:"endpoint,omitempty"`
	TLS      TLS    `yaml:"tls,omitempty"`
}

type JaegerGRPC 

type JaegerGRPC struct {
	Endpoint string `yaml:"endpoint,omitempty"`
}

type JaegerProtocols 

type JaegerProtocols struct {
	GRPC          JaegerGRPC          `yaml:"grpc,omitempty"`
	ThriftCompact JaegerThriftCompact `yaml:"thrift_compact,omitempty"`
	ThriftHTTP    JaegerThriftHTTP    `yaml:"thrift_http,omitempty"`
}

type JaegerThriftCompact 

type JaegerThriftCompact struct {
	Endpoint string `yaml:"endpoint,omitempty"`
}

type JaegerThriftHTTP 

type JaegerThriftHTTP struct {
	Endpoint string `yaml:"endpoint,omitempty"`
}

type LoggingExporter added in v0.16.2 

type LoggingExporter struct {
	LogLevel string `yaml:"loglevel,omitempty"`
}

type MemoryLimiter 

type MemoryLimiter struct {
	LimitMiB      int    `yaml:"limit_mib,omitempty"`
	SpikeLimitMiB int    `yaml:"spike_limit_mib,omitempty"`
	CheckInterval string `yaml:"check_interval,omitempty"`
}

type Metrics 

type Metrics struct {
	Receivers  []string `yaml:"receivers,omitempty"`
	Exporters  []string `yaml:"exporters,omitempty"`
	Processors []string `yaml:"processors,omitempty"`
}

type MetricsTelemetry 

type MetricsTelemetry struct {
	Address string `yaml:"address,omitempty"`
	Level   string `yaml:"level,omitempty"` // Options are basic, normal, detailed
}

type OTLP 

type OTLP struct {
	Protocols OTLPProtocols `yaml:"protocols,omitempty"`
}

type OTLPAuth 

type OTLPAuth struct {
	Authenticator string `yaml:"authenticator,omitempty"`
}

type OTLPHTTP 

type OTLPHTTP struct {
	Endpoint string `yaml:"endpoint,omitempty"`
}

type OTLPHTTPExporter 

type OTLPHTTPExporter struct {
	Auth     OTLPAuth `yaml:"auth,omitempty"`
	Endpoint string   `yaml:"endpoint,omitempty"`
}

type OTLPProtocols 

type OTLPProtocols struct {
	HTTP OTLPHTTP `yaml:"http,omitempty"`
}

type OTelConfig 

type OTelConfig struct {
	Extensions Extensions `yaml:"extensions,omitempty"`
	Receivers  Receivers  `yaml:"receivers,omitempty"`
	Exporters  Exporters  `yaml:"exporters,omitempty"`
	Service    Service    `yaml:"service,omitempty"`
	Processors Processors `yaml:"processors,omitempty"`
}

type Obsy 

type Obsy struct {
	// contains filtered or unexported fields
}

func New 

func New() *Obsy

func (*Obsy) Clone added in v0.16.1 

func (o *Obsy) Clone(namePrefix string) (instance.SidecarManager, error)

func (*Obsy) Initialize 

func (o *Obsy) Initialize(ctx context.Context, namePrefix string, sysDeps *system.SystemDependencies) error

func (*Obsy) Instance 

func (o *Obsy) Instance() *instance.Instance

func (*Obsy) PreStart 

func (o *Obsy) PreStart(ctx context.Context) error

func (*Obsy) SetImage 

func (o *Obsy) SetImage(image string)

func (*Obsy) SetJaegerEndpoint 

func (o *Obsy) SetJaegerEndpoint(grpcPort, thriftCompactPort, thriftHttpPort int) error

SetJaegerEndpoint sets the Jaeger endpoint for the instance

func (*Obsy) SetJaegerExporter 

func (o *Obsy) SetJaegerExporter(endpoint string) error

SetJaegerExporter sets the Jaeger exporter for the instance

func (*Obsy) SetLoggingExporter added in v0.16.2 

func (o *Obsy) SetLoggingExporter(logLevel string) error

SetLoggingExporter sets the logging exporter for the instance

func (*Obsy) SetOtelCollectorVersion 

func (o *Obsy) SetOtelCollectorVersion(version string) error

SetOtelCollectorVersion sets the OpenTelemetry collector version for the instance

func (*Obsy) SetOtelEndpoint 

func (o *Obsy) SetOtelEndpoint(port int) error

SetOtelEndpoint sets the OpenTelemetry endpoint for the instance

func (*Obsy) SetOtlpExporter 

func (o *Obsy) SetOtlpExporter(endpoint, username, password string) error

SetOtlpExporter sets the OTLP exporter for the instance

func (*Obsy) SetPrometheusEndpoint 

func (o *Obsy) SetPrometheusEndpoint(port int, jobName, scapeInterval string) error

SetPrometheusEndpoint sets the Prometheus endpoint for the instance

func (*Obsy) SetPrometheusExporter 

func (o *Obsy) SetPrometheusExporter(endpoint string) error

SetPrometheusExporter sets the Prometheus exporter for the instance

func (*Obsy) SetPrometheusRemoteWriteExporter 

func (o *Obsy) SetPrometheusRemoteWriteExporter(endpoint string) error

SetPrometheusRemoteWriteExporter sets the Prometheus remote write exporter for the instance

type ObsyConfig 

type ObsyConfig struct {
	// contains filtered or unexported fields
}

ObsyConfig represents the configuration for the obsy sidecar

type Pipelines 

type Pipelines struct {
	Metrics Metrics `yaml:"metrics,omitempty"`
	Traces  Traces  `yaml:"traces,omitempty"`
}

type Processors 

type Processors struct {
	Batch         Batch         `yaml:"batch,omitempty"`
	MemoryLimiter MemoryLimiter `yaml:"memory_limiter,omitempty"`
	Attributes    Attributes    `yaml:"attributes,omitempty"`
}

type Prometheus 

type Prometheus struct {
	Config PrometheusConfig `yaml:"config,omitempty"`
}

type PrometheusConfig 

type PrometheusConfig struct {
	ScrapeConfigs []ScrapeConfig `yaml:"scrape_configs,omitempty"`
}

type PrometheusExporter 

type PrometheusExporter struct {
	Endpoint string `yaml:"endpoint,omitempty"`
}

type PrometheusRemoteWriteExporter 

type PrometheusRemoteWriteExporter struct {
	Endpoint string `yaml:"endpoint,omitempty"`
	TLS      TLS    `yaml:"tls,omitempty"`
}

type Receivers 

type Receivers struct {
	OTLP       OTLP       `yaml:"otlp,omitempty"`
	Prometheus Prometheus `yaml:"prometheus,omitempty"`
	Jaeger     Jaeger     `yaml:"jaeger,omitempty"`
}

type ScrapeConfig 

type ScrapeConfig struct {
	JobName        string         `yaml:"job_name,omitempty"`
	ScrapeInterval string         `yaml:"scrape_interval,omitempty"`
	StaticConfigs  []StaticConfig `yaml:"static_configs,omitempty"`
}

type Service 

type Service struct {
	Extensions []string  `yaml:"extensions,omitempty"`
	Pipelines  Pipelines `yaml:"pipelines,omitempty"`
	Telemetry  Telemetry `yaml:"telemetry,omitempty"` // Added Telemetry field
}

type StaticConfig 

type StaticConfig struct {
	Targets []string `yaml:"targets,omitempty"`
}

type TLS 

type TLS struct {
	Insecure bool `yaml:"insecure,omitempty"`
}

type Telemetry 

type Telemetry struct {
	Metrics MetricsTelemetry `yaml:"metrics,omitempty"`
}

type Traces 

type Traces struct {
	Receivers  []string `yaml:"receivers,omitempty"`
	Exporters  []string `yaml:"exporters,omitempty"`
	Processors []string `yaml:"processors,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.