splunk

Documentation

Overview

Package splunk provides functionalities for integrating the splunk logging driver with shim-loggers-for-containerd.

Index

• Constants
• type Args
• type LoggerArgs
  • func InitLogger(globalArgs *logger.GlobalArgs, dockerConfigs *logger.DockerConfigs, ...) *LoggerArgs
  • func (la *LoggerArgs) RunLogDriver(ctx context.Context, config *logging.Config, ready func() error) error

Constants

const (
	TokenKey = "splunk-token"
	URLKey   = "splunk-url"

	SourceKey             = "splunk-source"
	SourcetypeKey         = "splunk-sourcetype"
	IndexKey              = "splunk-index"
	CapathKey             = "splunk-capath"
	CanameKey             = "splunk-caname"
	InsecureskipverifyKey = "splunk-insecureskipverify"
	FormatKey             = "splunk-format"
	VerifyConnectionKey   = "splunk-verify-connection"
	GzipKey               = "splunk-gzip"
	GzipLevelKey          = "splunk-gzip-level"
	SplunkTagKey          = "splunk-tag"
	LabelsKey             = "labels"
	EnvKey                = "env"
	EnvRegexKey           = "env-regex"
)

splunk driver argument keys.

Types

type Args

type Args struct {
	Token              string
	URL                string
	Source             string
	Sourcetype         string
	Index              string
	Capath             string
	Caname             string
	Insecureskipverify string
	Format             string
	VerifyConnection   string
	Gzip               string
	GzipLevel          string
	Tag                string
	// TagSpecified represents whether a splunk tag was specified. It is used to differentiate between the default value
	// of the splunk tag when the flag is initialized and the client specifying the default value of the tag,
	// as they may be the same.
	TagSpecified bool
	Labels       string
	Env          string
	EnvRegex     string
}

Args represents splunk log driver arguments.

type LoggerArgs

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

LoggerArgs stores global logger args and splunk specific args.

func InitLogger

func InitLogger(globalArgs *logger.GlobalArgs, dockerConfigs *logger.DockerConfigs, splunkArgs *Args) *LoggerArgs

InitLogger initialize the input arguments.

func (*LoggerArgs) RunLogDriver

func (la *LoggerArgs) RunLogDriver(ctx context.Context, config *logging.Config, ready func() error) error

RunLogDriver initiates the splunk driver.