Add Container name to the logs being fetched from Loki

Adding container name to help us figure out from which step
a particular log is generated.

Author: khrm

config/base/env/config

@@ -41,6 +41,7 @@ LOGGING_PLUGIN_PROXY_PATH=/api/logs/v1/application
 LOGGING_PLUGIN_API_URL=
 LOGGING_PLUGIN_TOKEN_PATH=/var/run/secrets/kubernetes.io/serviceaccount/token
 LOGGING_PLUGIN_NAMESPACE_KEY=kubernetes_namespace_name
+LOGGING_PLUGIN_CONTAINER_KEY=kubernetes.container_name
 LOGGING_PLUGIN_STATIC_LABELS='log_type=application'
 LOGGING_PLUGIN_CA_CERT=
 LOGGING_PLUGIN_QUERY_LIMIT=1700

docs/logging-support.md

@@ -43,6 +43,7 @@ These are the common configuration options for all third party logging APIs.
 - `LOGGING_PLUGIN_API_URL`: The URL of the third party logging API.
 - `LOGGING_PLUGIN_TOKEN_PATH`: The path to the file containing the API token. (optional)
 - `LOGGING_PLUGIN_NAMESPACE_KEY`: The key to use for the namespace filtering.
+- `LOGGING_PLUGIN_CONTAINER_KEY`: The key to use for adding container name to the logs. (optional)
 - `LOGGING_PLUGIN_STATIC_LABELS`: The static labels to use for the logs.
 - `LOGGING_PLUGIN_PROXY_PATH`: The path to the proxy to use for the third party logging API. (optional)
 - `LOGGING_PLUGIN_CA_CERT`: The CA certificate to use for the third party logging API. This should ideally be passed as environment variable in the deployment spec of the results-api pod. (optional)

pkg/api/server/config/config.go

@@ -55,6 +55,7 @@ type Config struct {
 
 	LOGGING_PLUGIN_API_URL                  string `mapstructure:"LOGGING_PLUGIN_API_URL"`
 	LOGGING_PLUGIN_NAMESPACE_KEY            string `mapstructure:"LOGGING_PLUGIN_NAMESPACE_KEY"`
+	LOGGING_PLUGIN_CONTAINER_KEY            string `mapstructure:"LOGGING_PLUGIN_CONTAINER_KEY"`
 	LOGGING_PLUGIN_STATIC_LABELS            string `mapstructure:"LOGGING_PLUGIN_STATIC_LABELS"`
 	LOGGING_PLUGIN_TOKEN_PATH               string `mapstructure:"LOGGING_PLUGIN_TOKEN_PATH"`
 	LOGGING_PLUGIN_PROXY_PATH               string `mapstructure:"LOGGING_PLUGIN_PROXY_PATH"`

pkg/api/server/v1alpha2/plugin/plugin_logs.go

@@ -170,7 +170,11 @@ func getLokiLogs(s *LogServer, writer io.Writer, parent string, rec *db.Record)
 	for k, v := range s.queryParams {
 		parameters.Add(k, v)
 	}
-	parameters.Add("query", `{ `+s.staticLabels+s.config.LOGGING_PLUGIN_NAMESPACE_KEY+`="`+parent+`" }|json uid="`+uidKey+`", message="message" |uid="`+rec.Name+`"| line_format "{{.message}}"`)
+	query := `{ ` + s.staticLabels + s.config.LOGGING_PLUGIN_NAMESPACE_KEY + `="` + parent + `" }|json uid="` + uidKey + `", message="message" |uid="` + rec.Name + `"| line_format "{{.message}}"`
+	if s.config.LOGGING_PLUGIN_CONTAINER_KEY != "" {
+		query = `{ ` + s.staticLabels + s.config.LOGGING_PLUGIN_NAMESPACE_KEY + `="` + parent + `" }|json uid="` + uidKey + `", container="` + s.config.LOGGING_PLUGIN_CONTAINER_KEY + `", message="message" |uid="` + rec.Name + `"| line_format "container-{{.container}}: message={{.message}}"`
+	}
+	parameters.Add("query", query)
 	parameters.Add("end", endTime)
 	parameters.Add("start", startTime)
 	parameters.Add("limit", strconv.FormatUint(uint64(s.queryLimit), 10))

test/e2e/loki_vector/loki-vector-api-config.yaml

@@ -24,6 +24,7 @@ data:
     LOGGING_PLUIN_TOKEN_PATH=/var/run/secrets/kubernetes.io/serviceaccount/token
     LOGGING_PLUGIN_PROXY_PATH=
     LOGGING_PLUGIN_NAMESPACE_KEY=kubernetes_namespace_name
+    LOGGING_PLUGIN_CONTAINER_KEY=kubernetes.container_name
     LOGGING_PLUGIN_API_URL=http://loki.logging.svc.cluster.local:3100/loki/api/v1/query_range
 kind: ConfigMap
 metadata: