settings

Documentation

Index

• Constants
• Variables
• type Settings
  • func New(args []string) (*Settings, error)
  • func (s *Settings) ColCoreArgs() []string
  • func (s *Settings) ConfMapConverterFactories() []confmap.ConverterFactory
  • func (s *Settings) ConfMapProviderFactories() []confmap.ProviderFactory
  • func (s *Settings) IsDryRun() bool
  • func (s *Settings) ResolverURIs() []string

Constants

const (
	APIURLEnvVar              = "SPLUNK_API_URL"
	ConfigEnvVar              = "SPLUNK_CONFIG"
	ConfigDirEnvVar           = "SPLUNK_CONFIG_DIR"
	ConfigServerEnabledEnvVar = "SPLUNK_DEBUG_CONFIG_SERVER"
	ConfigYamlEnvVar          = "SPLUNK_CONFIG_YAML"
	HecLogIngestURLEnvVar     = "SPLUNK_HEC_URL"
	ListenInterfaceEnvVar     = "SPLUNK_LISTEN_INTERFACE"
	GoMemLimitEnvVar          = "GOMEMLIMIT"
	GoGCEnvVar                = "GOGC"
	// 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

	// Deprecated: SPLUNK_TRACE_URL env var is deprecated, SPLUNK_REALM or SPLUNK_INGEST_URL should be used instead.
	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"

	DefaultMemoryLimitPercentage = 90
	DefaultMemoryTotalMiB        = 512
	DefaultGoGC                  = 400
	DefaultListenInterface       = "0.0.0.0"
	DefaultAgentConfigLinux      = "/etc/otel/collector/agent_config.yaml"
)

Variables

var DefaultAgentConfigWindows = func() string {
	path := filepath.Join("Splunk", "OpenTelemetry Collector", "agent_config.yaml")
	if runtime.GOOS == "windows" {
		if pd, ok := os.LookupEnv("ProgramData"); ok {
			path = filepath.Join(pd, path)
		}
	}
	return filepath.Clean(path)
}()

Types

type Settings

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

func New

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

func (*Settings) ColCoreArgs

func (s *Settings) ColCoreArgs() []string

ColCoreArgs returns list of arguments to be passed to the collector core service.

func (*Settings) ConfMapConverterFactories

func (s *Settings) ConfMapConverterFactories() []confmap.ConverterFactory

ConfMapConverterFactories returns confmap.Converters for the collector core service.

func (*Settings) ConfMapProviderFactories

func (s *Settings) ConfMapProviderFactories() []confmap.ProviderFactory

ConfMapProviderFactories returns list of confmap.ProviderFactory for the collector core service.

func (*Settings) IsDryRun

func (s *Settings) IsDryRun() bool

IsDryRun returns whether --dry-run mode was requested

func (*Settings) ResolverURIs

func (s *Settings) ResolverURIs() []string

ResolverURIs returns config provider resolver URIs for the core collector service.