otlpenv

Documentation

Overview

Package otlpenv exports getters to read OpenTelemetry protocol configuration options based on the official spec: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options

Index

• func GetEndpoint() string
• func IsInsecure(endpoint string) bool
• type Protocol
  • func GetProtocol() Protocol

Functions

func GetEndpoint

func GetEndpoint() string

GetEndpoint returns the root collector endpoint, NOT per-signal endpoints. We do not yet support per-signal endpoints.

See: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options

func IsInsecure

func IsInsecure(endpoint string) bool

Types

type Protocol

type Protocol string

const (
	// ProtocolGRPC is protobuf-encoded data using gRPC wire format over HTTP/2 connection
	ProtocolGRPC Protocol = "grpc"
	// ProtocolHTTPProto is protobuf-encoded data over HTTP connection
	ProtocolHTTPProto Protocol = "http/proto"
	// ProtocolHTTPJSON is JSON-encoded data over HTTP connection
	ProtocolHTTPJSON Protocol = "http/json"
)

func GetProtocol

func GetProtocol() Protocol

GetProtocol returns the configured protocol for the root collector endpoint, NOT per-signal endpoints. We do not yet support per-signal endpoints.

See: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#specify-protocol