settings

Documentation

Index

• Constants
• type Settings
  • func New(args []string) (Settings, error)

Constants

const (
	DefaultUndeclaredFlag = -1

	APIURLEnvVar              = "SPLUNK_API_URL"
	BallastEnvVar             = "SPLUNK_BALLAST_SIZE_MIB"
	ConfigEnvVar              = "SPLUNK_CONFIG"
	ConfigDirEnvVar           = "SPLUNK_CONFIG_DIR"
	ConfigServerEnabledEnvVar = "SPLUNK_DEBUG_CONFIG_SERVER"
	ConfigYamlEnvVar          = "SPLUNK_CONFIG_YAML"
	HecLogIngestURLEnvVar     = "SPLUNK_HEC_URL"
	// nolint:gosec
	HecTokenEnvVar    = "SPLUNK_HEC_TOKEN" // this isn't a hardcoded token
	IngestURLEnvVar   = "SPLUNK_INGEST_URL"
	MemLimitMiBEnvVar = "SPLUNK_MEMORY_LIMIT_MIB"
	MemTotalEnvVar    = "SPLUNK_MEMORY_TOTAL_MIB"
	RealmEnvVar       = "SPLUNK_REALM"
	// nolint:gosec
	TokenEnvVar          = "SPLUNK_ACCESS_TOKEN" // this isn't a hardcoded token
	TraceIngestURLEnvVar = "SPLUNK_TRACE_URL"

	DefaultGatewayConfig           = "/etc/otel/collector/gateway_config.yaml"
	DefaultOTLPLinuxConfig         = "/etc/otel/collector/otlp_config_linux.yaml"
	DefaultConfigDir               = "/etc/otel/collector/config.d"
	DefaultMemoryBallastPercentage = 33
	DefaultMemoryLimitPercentage   = 90
	DefaultMemoryTotalMiB          = 512

	DiscoveryModeScheme = "splunk.discovery"
	ConfigDScheme       = "splunk.configd"
)

Types

type Settings

type Settings interface {
	// ResolverURIs returns the collector config provider resolver uris for the collector service
	ResolverURIs() []string
	// ConfMapConverters returns the collector config provider resolver confmap.Converters for the collector service
	ConfMapConverters() []confmap.Converter
	// ServiceArgs are the sanitized, adjusted args to be used in updating os.Args[1:] for the collector service
	ServiceArgs() []string
	// IsDryRun returns whether --dry-run mode was requested
	IsDryRun() bool
}

func New

func New(args []string) (Settings, error)