Add container logs scraping from file by default (#88)

Align with the Helm chart. We are mounting pod logs host path and container logs host path.
DataDog · May 12, 2020 · 8b1b1fe · 8b1b1fe
1 parent 302f86c
commit 8b1b1fe
Show file tree

Hide file tree

Showing 10 changed files with 78 additions and 34 deletions.
diff --git a/Makefile b/Makefile
@@ -12,9 +12,9 @@ SOURCES := $(shell find $(SOURCEDIR) ! -name "*_test.go" -name '*.go')
 BUILDINFOPKG=github.com/DataDog/${PROJECT_NAME}/version
 GIT_TAG?=$(shell git tag -l --contains HEAD | tail -1)
 LAST_TAG=$(or $(shell git tag | tail -1),v0.0.0)
-TAG?=${GIT_TAG}
 TAG_HASH=${LAST_TAG}_$(shell git rev-parse --short HEAD)
 VERSION?=$(if $(GIT_TAG),$(GIT_TAG),$(TAG_HASH))
+TAG?=${VERSION}
 GIT_COMMIT?=$(shell git rev-parse HEAD)
 DATE=$(shell date +%Y-%m-%d/%H:%M:%S )
 GOMOD?="-mod=vendor"

diff --git a/deploy/crds/datadoghq.com_datadogagents_crd.yaml b/deploy/crds/datadoghq.com_datadogagents_crd.yaml
@@ -2073,6 +2073,12 @@ spec:
                 log:
                   description: Log Agent configuration
                   properties:
+                    containerCollectUsingFiles:
+                      description: 'Collect logs from files in /var/log/pods instead
+                        of using container runtime API. It''s usually the most efficient
+                        way of collecting logs. ref: https://docs.datadoghq.com/agent/basic_agent_usage/kubernetes/#log-collection-setup
+                        Default: true'
+                      type: boolean
                     containerLogsPath:
                       description: 'This to allow log collection from container log
                         path. Set to a different path if not using docker runtime.

diff --git a/pkg/apis/datadoghq/v1alpha1/const.go b/pkg/apis/datadoghq/v1alpha1/const.go
@@ -35,39 +35,40 @@ const (
 
 // Datadog env var names
 const (
-	DDAPIKey                        = "DD_API_KEY"
-	DDClusterName                   = "DD_CLUSTER_NAME"
-	DDSite                          = "DD_SITE"
-	DDddURL                         = "DD_DD_URL"
-	DDHealthPort                    = "DD_HEALTH_PORT"
-	DDLogLevel                      = "DD_LOG_LEVEL"
-	DDPodLabelsAsTags               = "DD_KUBERNETES_POD_LABELS_AS_TAGS"
-	DDPodAnnotationsAsTags          = "DD_KUBERNETES_POD_ANNOTATIONS_AS_TAGS"
-	DDTags                          = "DD_TAGS"
-	DDCollectKubeEvents             = "DD_COLLECT_KUBERNETES_EVENTS"
-	DDLeaderElection                = "DD_LEADER_ELECTION"
-	DDLogsEnabled                   = "DD_LOGS_ENABLED"
-	DDLogsConfigContainerCollectAll = "DD_LOGS_CONFIG_CONTAINER_COLLECT_ALL"
-	DDDogstatsdOriginDetection      = "DD_DOGSTATSD_ORIGIN_DETECTION"
-	DDClusterAgentEnabled           = "DD_CLUSTER_AGENT_ENABLED"
-	DDClusterAgentKubeServiceName   = "DD_CLUSTER_AGENT_KUBERNETES_SERVICE_NAME"
-	DDClusterAgentAuthToken         = "DD_CLUSTER_AGENT_AUTH_TOKEN"
-	DDMetricsProviderEnabled        = "DD_EXTERNAL_METRICS_PROVIDER_ENABLED"
-	DDMetricsProviderPort           = "DD_EXTERNAL_METRICS_PROVIDER_PORT"
-	DDAppKey                        = "DD_APP_KEY"
-	DDClusterChecksEnabled          = "DD_CLUSTER_CHECKS_ENABLED"
-	DDClcRunnerEnabled              = "DD_CLC_RUNNER_ENABLED"
-	DDClcRunnerHost                 = "DD_CLC_RUNNER_HOST"
-	DDExtraConfigProviders          = "DD_EXTRA_CONFIG_PROVIDERS"
-	DDExtraListeners                = "DD_EXTRA_LISTENERS"
-	DDHostname                      = "DD_HOSTNAME"
-	DDAPMEnabled                    = "DD_APM_ENABLED"
-	DDProcessAgentEnabled           = "DD_PROCESS_AGENT_ENABLED"
-	DDSystemProbeAgentEnabled       = "DD_SYSTEM_PROBE_ENABLED"
-	DDEnableMetadataCollection      = "DD_ENABLE_METADATA_COLLECTION"
-	DDKubeletHost                   = "DD_KUBERNETES_KUBELET_HOST"
-	DDCriSocketPath                 = "DD_CRI_SOCKET_PATH"
-	DockerHost                      = "DOCKER_HOST"
+	DDAPIKey                         = "DD_API_KEY"
+	DDClusterName                    = "DD_CLUSTER_NAME"
+	DDSite                           = "DD_SITE"
+	DDddURL                          = "DD_DD_URL"
+	DDHealthPort                     = "DD_HEALTH_PORT"
+	DDLogLevel                       = "DD_LOG_LEVEL"
+	DDPodLabelsAsTags                = "DD_KUBERNETES_POD_LABELS_AS_TAGS"
+	DDPodAnnotationsAsTags           = "DD_KUBERNETES_POD_ANNOTATIONS_AS_TAGS"
+	DDTags                           = "DD_TAGS"
+	DDCollectKubeEvents              = "DD_COLLECT_KUBERNETES_EVENTS"
+	DDLeaderElection                 = "DD_LEADER_ELECTION"
+	DDLogsEnabled                    = "DD_LOGS_ENABLED"
+	DDLogsConfigContainerCollectAll  = "DD_LOGS_CONFIG_CONTAINER_COLLECT_ALL"
+	DDLogsContainerCollectUsingFiles = "DD_LOGS_CONFIG_K8S_CONTAINER_USE_FILE"
+	DDDogstatsdOriginDetection       = "DD_DOGSTATSD_ORIGIN_DETECTION"
+	DDClusterAgentEnabled            = "DD_CLUSTER_AGENT_ENABLED"
+	DDClusterAgentKubeServiceName    = "DD_CLUSTER_AGENT_KUBERNETES_SERVICE_NAME"
+	DDClusterAgentAuthToken          = "DD_CLUSTER_AGENT_AUTH_TOKEN"
+	DDMetricsProviderEnabled         = "DD_EXTERNAL_METRICS_PROVIDER_ENABLED"
+	DDMetricsProviderPort            = "DD_EXTERNAL_METRICS_PROVIDER_PORT"
+	DDAppKey                         = "DD_APP_KEY"
+	DDClusterChecksEnabled           = "DD_CLUSTER_CHECKS_ENABLED"
+	DDClcRunnerEnabled               = "DD_CLC_RUNNER_ENABLED"
+	DDClcRunnerHost                  = "DD_CLC_RUNNER_HOST"
+	DDExtraConfigProviders           = "DD_EXTRA_CONFIG_PROVIDERS"
+	DDExtraListeners                 = "DD_EXTRA_LISTENERS"
+	DDHostname                       = "DD_HOSTNAME"
+	DDAPMEnabled                     = "DD_APM_ENABLED"
+	DDProcessAgentEnabled            = "DD_PROCESS_AGENT_ENABLED"
+	DDSystemProbeAgentEnabled        = "DD_SYSTEM_PROBE_ENABLED"
+	DDEnableMetadataCollection       = "DD_ENABLE_METADATA_COLLECTION"
+	DDKubeletHost                    = "DD_KUBERNETES_KUBELET_HOST"
+	DDCriSocketPath                  = "DD_CRI_SOCKET_PATH"
+	DockerHost                       = "DOCKER_HOST"
 
 	// KubernetesEnvvarName Env var used by the Datadog Agent container entrypoint
 	// to add kubelet config provider and listener

diff --git a/pkg/apis/datadoghq/v1alpha1/datadogagent_default.go b/pkg/apis/datadoghq/v1alpha1/datadogagent_default.go
@@ -30,6 +30,7 @@ const (
 	defaultApmEnabled                             bool   = false
 	defaultLogEnabled                             bool   = false
 	defaultLogsConfigContainerCollectAll          bool   = false
+	defaultLogsContainerCollectUsingFiles         bool   = true
 	defaultContainerLogsPath                      string = "/var/lib/docker/containers"
 	defaultPodLogsPath                            string = "/var/log/pods"
 	defaultLogsTempStoragePath                    string = "/var/lib/datadog-agent/logs"
@@ -561,6 +562,10 @@ func DefaultDatadogAgentSpecAgentLog(log *LogSpec) *LogSpec {
 		log.LogsConfigContainerCollectAll = NewBoolPointer(defaultLogsConfigContainerCollectAll)
 	}
 
+	if log.ContainerCollectUsingFiles == nil {
+		log.ContainerCollectUsingFiles = NewBoolPointer(defaultLogsContainerCollectUsingFiles)
+	}
+
 	if log.ContainerLogsPath == nil {
 		log.ContainerLogsPath = NewStringPointer(defaultContainerLogsPath)
 	}

diff --git a/pkg/apis/datadoghq/v1alpha1/datadogagent_types.go b/pkg/apis/datadoghq/v1alpha1/datadogagent_types.go
@@ -255,6 +255,14 @@ type LogSpec struct {
 	// +optional
 	LogsConfigContainerCollectAll *bool `json:"logsConfigContainerCollectAll,omitempty"`
 
+	// Collect logs from files in /var/log/pods instead of using container runtime API.
+	// It's usually the most efficient way of collecting logs.
+	// ref: https://docs.datadoghq.com/agent/basic_agent_usage/kubernetes/#log-collection-setup
+	// Default: true
+	//
+	// +optional
+	ContainerCollectUsingFiles *bool `json:"containerCollectUsingFiles,omitempty"`
+
 	// This to allow log collection from container log path. Set to a different path if not using docker runtime.
 	// ref: https://docs.datadoghq.com/agent/kubernetes/daemonset_setup/?tab=k8sfile#create-manifest
 	// Default to `/var/lib/docker/containers`

diff --git a/pkg/apis/datadoghq/v1alpha1/zz_generated.deepcopy.go b/pkg/apis/datadoghq/v1alpha1/zz_generated.deepcopy.go
diff --git a/pkg/apis/datadoghq/v1alpha1/zz_generated.openapi.go b/pkg/apis/datadoghq/v1alpha1/zz_generated.openapi.go
diff --git a/pkg/controller/datadogagent/agent_test.go b/pkg/controller/datadogagent/agent_test.go
@@ -200,6 +200,10 @@ func defaultEnvVars() []corev1.EnvVar {
 			Name:  "DD_LOGS_CONFIG_CONTAINER_COLLECT_ALL",
 			Value: "false",
 		},
+		{
+			Name:  "DD_LOGS_CONFIG_K8S_CONTAINER_USE_FILE",
+			Value: "true",
+		},
 		{
 			Name:  "DD_DOGSTATSD_ORIGIN_DETECTION",
 			Value: "false",

diff --git a/pkg/controller/datadogagent/utils.go b/pkg/controller/datadogagent/utils.go
@@ -501,6 +501,10 @@ func getEnvVarsForAgent(dda *datadoghqv1alpha1.DatadogAgent) ([]corev1.EnvVar, e
 			Name:  datadoghqv1alpha1.DDLogsConfigContainerCollectAll,
 			Value: strconv.FormatBool(*spec.Agent.Log.LogsConfigContainerCollectAll),
 		},
+		{
+			Name:  datadoghqv1alpha1.DDLogsContainerCollectUsingFiles,
+			Value: strconv.FormatBool(*spec.Agent.Log.ContainerCollectUsingFiles),
+		},
 		{
 			Name:  datadoghqv1alpha1.DDDogstatsdOriginDetection,
 			Value: strconv.FormatBool(*spec.Agent.Config.Dogstatsd.DogstatsdOriginDetection),

diff --git a/test/e2e/datadogagent_test.go b/test/e2e/datadogagent_test.go
@@ -714,11 +714,13 @@ type logWriter struct {
 }
 
 func (l *logWriter) Write(b []byte) (int, error) {
+	l.t.Helper()
 	l.t.Logf("pod [%s/%s - %s]: %s", l.namespace, l.name, l.container, string(b))
 	return len(b), nil
 }
 
 func exportPodsLogs(t *testing.T, f *framework.Framework, namespace string, err error) {
+	t.Helper()
 	if err == nil {
 		return
 	}
@@ -755,6 +757,7 @@ func exportPodsLogs(t *testing.T, f *framework.Framework, namespace string, err
 }
 
 func printPods(t *testing.T, f *framework.Framework, namespace string) {
+	t.Helper()
 	podList := &corev1.PodList{}
 	namespaceOption := &dynclient.ListOptions{Namespace: namespace}
 	_ = f.Client.List(goctx.TODO(), podList, namespaceOption)
@@ -768,6 +771,7 @@ func printPods(t *testing.T, f *framework.Framework, namespace string) {
 }
 
 func printDaemonSet(t *testing.T, f *framework.Framework, namespace string) {
+	t.Helper()
 	dsList := &appsv1.DaemonSetList{}
 	namespaceOption := &dynclient.ListOptions{Namespace: namespace}
 	_ = f.Client.List(goctx.TODO(), dsList, namespaceOption)