init.go

// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

package main

import (
	"github.com/spf13/pflag"

	"github.com/aws/shim-loggers-for-containerd/logger/awslogs"
	"github.com/aws/shim-loggers-for-containerd/logger/fluentd"
	"github.com/aws/shim-loggers-for-containerd/logger/splunk"
)

const (
	// Container options.
	containerIDKey   = "container-id"
	containerNameKey = "container-name"

	// Mode and buffer size options.
	modeKey          = "mode"
	maxBufferSizeKey = "max-buffer-size"

	// LogDriver options.
	logDriverTypeKey  = "log-driver"
	awslogsDriverName = "awslogs"
	fluentdDriverName = "fluentd"
	splunkDriverName  = "splunk"

	// Verbose mode option.
	verboseKey = "verbose"

	// UID/GID option.
	uidKey = "uid"
	gidKey = "gid"

	// cleanup time option.
	cleanupTimeKey = "cleanup-time"

	// docker config options.

	// ContainerImageIDKey represents the key for the container's image ID.
	ContainerImageIDKey = "container-image-id"
	// ContainerImageNameKey represents the key for the container's image name.
	ContainerImageNameKey = "container-image-name"
	// ContainerEnvKey represents the key for the container's environment variables.
	ContainerEnvKey = "container-env"
	// ContainerLabelsKey represents the key for the container's labels.
	ContainerLabelsKey = "container-labels"

	// Windows config options.

	// ProxyEnvVarKey represents the key for the proxy environment variable on Windows.
	ProxyEnvVarKey = "proxy-variable"
	// LogFileDirKey represents the key for the directory where log files are stored on Windows.
	LogFileDirKey = "log-file-dir"
)

// initCommonLogOpts initialize common options that get used by any log drivers.
func initCommonLogOpts() {
	// container info
	pflag.String(containerIDKey, "", "Id of the container")
	pflag.String(containerNameKey, "", "Name of the container")

	// log driver options
	pflag.String(logDriverTypeKey, "", "`awslogs`, `fluentd` or `splunk`")

	// mode options
	pflag.String(modeKey, "", "Whether the writer is blocked or not blocked")
	pflag.String(maxBufferSizeKey, "", "The size of intermediate buffer for non-blocking mode")

	// verbose mode option
	pflag.Bool(verboseKey, false, "If set, then more logs will be printed for debugging")

	// set uid/gid option
	pflag.Int(uidKey, -1, "Customized uid for all the goroutines in shim logger process")
	pflag.Int(gidKey, -1, "Customized gid for all the goroutines in shim logger process")

	// cleanup time option
	pflag.String(cleanupTimeKey, "5s", "Cleanup time after pipes are closed, default to 5 seconds")
}

// initDockerConfigOpts initialize the docker configuration variables for the container.
func initDockerConfigOpts() {
	pflag.String(ContainerImageIDKey, "", "Image id of the container")
	pflag.String(ContainerImageNameKey, "", "Image name of the container")
	pflag.String(ContainerEnvKey, "", "Environment variables of the container")
	pflag.String(ContainerLabelsKey, "", "Labels of the container")
}

// initWindowsOpts initialize the Windows specific options.
func initWindowsOpts() {
	// Optional proxy environment variable
	pflag.String(ProxyEnvVarKey, "", "Set `HTTP_PROXY` and `HTTPS_PROXY` environment variable")
	// Optional file log directory
	pflag.String(LogFileDirKey, "", "The log file dir will be used to set the path for debug log files for Windows")
}

// initAWSLogsOpts initialize awslogs driver specified options.
func initAWSLogsOpts() {
	pflag.String(awslogs.GroupKey, "", "The CloudWatch log group to use")
	pflag.String(awslogs.RegionKey, "", "The CloudWatch region to use")
	pflag.String(awslogs.StreamKey, "", "The CloudWatch log stream to use")
	pflag.String(awslogs.CreateGroupKey, "false", "Is this a new group that needs to be created?")
	pflag.String(awslogs.CreateStreamKey, "True", "Is this a new stream that needs to be created?")
	pflag.String(awslogs.CredentialsEndpointKey, "", "The endpoint for iam credentials")
	pflag.String(awslogs.MultilinePatternKey, "", "Support multiline pattern for debug")
	pflag.String(awslogs.DatetimeFormatKey, "", "Multiline pattern in strftime format")
	pflag.String(awslogs.EndpointKey, "", "The CloudWatch endpoint to use")
}

// initFluentdOpts initialize fluentd driver specified options.
func initFluentdOpts() {
	pflag.String(fluentd.AddressKey, "", "The address connected to Fluentd daemon")
	pflag.Bool(fluentd.AsyncConnectKey, false, "If connecting Fluentd daemon in background")
	pflag.Bool(fluentd.SubsecondPrecisionKey, true, "Ensures event logs are generated in nanosecond resolution.")
	pflag.Int(fluentd.BufferLimitKey, -1, "The number of events buffered on the memory")
	pflag.String(fluentd.FluentdTagKey, "", "The tag used to identify log messages")
}

// initSplunkOpts initialize splunk driver specified options.
// Argument usage taken from https://docs.docker.com/config/containers/logging/splunk/.
func initSplunkOpts() {
	pflag.String(splunk.TokenKey, "", "Splunk HTTP Event Collector token.")
	pflag.String(splunk.URLKey, "", "Path to your Splunk Enterprise, self-service Splunk Cloud instance, "+
		"or Splunk Cloud managed cluster (including port and scheme used by HTTP Event Collector).")
	pflag.String(splunk.SourceKey, "", "Event source.")
	pflag.String(splunk.SourcetypeKey, "", "Event source type.")
	pflag.String(splunk.IndexKey, "", "Event index.")
	pflag.String(splunk.CapathKey, "", "Path to root certificate.")
	pflag.String(splunk.CanameKey, "", "Name to use for validating server certificate; by default the hostname of the splunk-url is used.")
	pflag.String(splunk.InsecureskipverifyKey, "", "Ignore server certificate validation.")
	pflag.String(splunk.FormatKey, "", "Message format. Can be inline, json or raw. Defaults to inline.")
	pflag.String(splunk.VerifyConnectionKey, "", "Verify on start, that docker can connect to Splunk server. "+
		"Defaults to true.")
	pflag.String(splunk.GzipKey, "", "Enable/disable gzip compression to send events to Splunk Enterprise "+
		"or Splunk Cloud instance. Defaults to false.")
	pflag.String(splunk.GzipLevelKey, "", "Set compression level for gzip. Valid values are -1 (default), "+
		"0 (no compression), 1 (best speed) ... 9 (best compression). Defaults to DefaultCompression.")
	pflag.String(splunk.SplunkTagKey, "", "Specify tag for message, which interpret some markup.")
	pflag.String(splunk.LabelsKey, "", "Comma-separated list of keys of labels, which should be included "+
		"in message, if these labels are specified for container.")
	pflag.String(splunk.EnvKey, "", "Comma-separated list of keys of environment variables, which should be "+
		"included in message, if these variables are specified for container.")
	pflag.String(splunk.EnvRegexKey, "", "Similar to and compatible with env. A regular expression to "+
		"match logging-related environment variables. Used for advanced log tag options.")
}