package env

import "go.opentelemetry.io/otel/sdk/internal/env"

Index

Constants

const (
	// BatchSpanProcessorScheduleDelayKey is the delay interval between two
	// consecutive exports (i.e. 5000).
	BatchSpanProcessorScheduleDelayKey = "OTEL_BSP_SCHEDULE_DELAY"
	// BatchSpanProcessorExportTimeoutKey is the maximum allowed time to
	// export data (i.e. 3000).
	BatchSpanProcessorExportTimeoutKey = "OTEL_BSP_EXPORT_TIMEOUT"
	// BatchSpanProcessorMaxQueueSizeKey is the maximum queue size (i.e. 2048).
	BatchSpanProcessorMaxQueueSizeKey = "OTEL_BSP_MAX_QUEUE_SIZE"
	// BatchSpanProcessorMaxExportBatchSizeKey is the maximum batch size (i.e.
	// 512). Note: it must be less than or equal to
	// BatchSpanProcessorMaxQueueSize.
	BatchSpanProcessorMaxExportBatchSizeKey = "OTEL_BSP_MAX_EXPORT_BATCH_SIZE"

	// AttributeValueLengthKey is the maximum allowed attribute value size.
	AttributeValueLengthKey = "OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT"

	// AttributeCountKey is the maximum allowed span attribute count.
	AttributeCountKey = "OTEL_ATTRIBUTE_COUNT_LIMIT"

	// SpanAttributeValueLengthKey is the maximum allowed attribute value size
	// for a span.
	SpanAttributeValueLengthKey = "OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT"

	// SpanAttributeCountKey is the maximum allowed span attribute count for a
	// span.
	SpanAttributeCountKey = "OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT"

	// SpanEventCountKey is the maximum allowed span event count.
	SpanEventCountKey = "OTEL_SPAN_EVENT_COUNT_LIMIT"

	// SpanEventAttributeCountKey is the maximum allowed attribute per span
	// event count.
	SpanEventAttributeCountKey = "OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT"

	// SpanLinkCountKey is the maximum allowed span link count.
	SpanLinkCountKey = "OTEL_SPAN_LINK_COUNT_LIMIT"

	// SpanLinkAttributeCountKey is the maximum allowed attribute per span
	// link count.
	SpanLinkAttributeCountKey = "OTEL_LINK_ATTRIBUTE_COUNT_LIMIT"
)

Environment variable names.

Functions

func BatchSpanProcessorExportTimeout

func BatchSpanProcessorExportTimeout(defaultValue int) int

BatchSpanProcessorExportTimeout returns the environment variable value for the OTEL_BSP_EXPORT_TIMEOUT key if it exists, otherwise defaultValue is returned.

func BatchSpanProcessorMaxExportBatchSize

func BatchSpanProcessorMaxExportBatchSize(defaultValue int) int

BatchSpanProcessorMaxExportBatchSize returns the environment variable value for the OTEL_BSP_MAX_EXPORT_BATCH_SIZE key if it exists, otherwise defaultValue is returned.

func BatchSpanProcessorMaxQueueSize

func BatchSpanProcessorMaxQueueSize(defaultValue int) int

BatchSpanProcessorMaxQueueSize returns the environment variable value for the OTEL_BSP_MAX_QUEUE_SIZE key if it exists, otherwise defaultValue is returned.

func BatchSpanProcessorScheduleDelay

func BatchSpanProcessorScheduleDelay(defaultValue int) int

BatchSpanProcessorScheduleDelay returns the environment variable value for the OTEL_BSP_SCHEDULE_DELAY key if it exists, otherwise defaultValue is returned.

func IntEnvOr

func IntEnvOr(key string, defaultValue int) int

IntEnvOr returns the int value of the environment variable with name key if it exists, it is not empty, and the value is an int. Otherwise, defaultValue is returned.

func SpanAttributeCount

func SpanAttributeCount(defaultValue int) int

SpanAttributeCount returns the environment variable value for the OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT key if it exists. Otherwise, the environment variable value for OTEL_ATTRIBUTE_COUNT_LIMIT is returned or defaultValue if that is not set.

func SpanAttributeValueLength

func SpanAttributeValueLength(defaultValue int) int

SpanAttributeValueLength returns the environment variable value for the OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT key if it exists. Otherwise, the environment variable value for OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT is returned or defaultValue if that is not set.

func SpanEventAttributeCount

func SpanEventAttributeCount(defaultValue int) int

SpanEventAttributeCount returns the environment variable value for the OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT key if it exists, otherwise defaultValue is returned.

func SpanEventCount

func SpanEventCount(defaultValue int) int

SpanEventCount returns the environment variable value for the OTEL_SPAN_EVENT_COUNT_LIMIT key if it exists, otherwise defaultValue is returned.

func SpanLinkAttributeCount

func SpanLinkAttributeCount(defaultValue int) int

SpanLinkAttributeCount returns the environment variable value for the OTEL_LINK_ATTRIBUTE_COUNT_LIMIT key if it exists, otherwise defaultValue is returned.

func SpanLinkCount

func SpanLinkCount(defaultValue int) int

SpanLinkCount returns the environment variable value for the OTEL_SPAN_LINK_COUNT_LIMIT key if it exists, otherwise defaultValue is returned.

Source Files

env.go

Version
v1.34.0 (latest)
Published
Jan 17, 2025
Platform
linux/amd64
Imports
3 packages
Last checked
2 days ago

Tools for package owners.