Release 2.2.15 (#1271)

Author: alesnovak-s1

CHANGELOG.md

@@ -1,6 +1,22 @@
 Scalyr Agent 2 Changes By Release
 =================================
 
+## 2.2.15 "Jain" - May 20, 2024
+<!---
+Packaged by Ales Novak <[email protected]> on May 20, 2024 00:00 -0800
+--->
+
+Features:
+Ability to ignore k8s labels (https://github.com/scalyr/scalyr-agent-2/issues/1213).
+A user can now define glob filters for including and excluding container and controller labels in logs.
+For label to be included it needs to match one of the globs in k8s_label_include_globs and none of the globs in k8s_label_exclude_globs.
+
+From documentation:
+| k8s_label_include_globs | Optional, (defaults to ['*']). Specifies a list of K8s labels to be added to logs. |
+| k8s_label_exclude_globs | Optional, (defaults to []]). Specifies a list of K8s labels to be ignored and not added to logs. |
+
+Follows the same logic as label_include_globs and label_exclude_globs from the docker_monitor.
+
 ## 2.2.14 "Tycho" - May 6, 2024
 <!---
 Packaged by Ales Novak <[email protected]> on May 6, 2024 00:00 -0800

VERSION

@@ -1 +1 @@
-2.2.14
+2.2.15

k8s/default-namespace/scalyr-agent-2.yaml

@@ -50,7 +50,7 @@ spec:
         envFrom:
         - configMapRef:
             name: scalyr-config
-        image: scalyr/scalyr-k8s-agent:2.2.14
+        image: scalyr/scalyr-k8s-agent:2.2.15
         imagePullPolicy: Always
         name: scalyr-agent
         securityContext:

k8s/no-kustomize/scalyr-agent-2.yaml

@@ -50,7 +50,7 @@ spec:
         envFrom:
         - configMapRef:
             name: scalyr-config
-        image: scalyr/scalyr-k8s-agent:2.2.14
+        image: scalyr/scalyr-k8s-agent:2.2.15
         imagePullPolicy: Always
         name: scalyr-agent
         securityContext:

k8s/scalyr-agent-2-envfrom.yaml

@@ -49,7 +49,7 @@ spec:
         envFrom:
         - configMapRef:
             name: scalyr-config
-        image: scalyr/scalyr-k8s-agent:2.2.14
+        image: scalyr/scalyr-k8s-agent:2.2.15
         imagePullPolicy: Always
         name: scalyr-agent
         securityContext:

k8s/scalyr-agent-2.yaml

@@ -49,7 +49,7 @@ spec:
         envFrom:
         - configMapRef:
             name: scalyr-config
-        image: scalyr/scalyr-k8s-agent:2.2.14
+        image: scalyr/scalyr-k8s-agent:2.2.15
         imagePullPolicy: Always
         name: scalyr-agent
         securityContext:

scalyr_agent/builtin_monitors/apache_monitor.py

@@ -49,7 +49,7 @@
     "number, at which the Apache status module is served. The URL should end in `/?auto` to "
     "indicate that the machine-readable version of the page should be returned.",
     default="http://localhost/server-status/?auto",
-    allow_http=False,
+    allow_http=False
 )
 define_config_option(
     __monitor__,

scalyr_agent/builtin_monitors/kubernetes_monitor.py

@@ -71,8 +71,7 @@
     KubeletApiException,
     K8sApiTemporaryError,
     K8sConfigBuilder,
-    K8sNamespaceFilter,
-    KubernetesCache,
+    K8sNamespaceFilter, KubernetesCache,
 )
 from scalyr_agent.monitor_utils.k8s import (
     K8sApiPermanentError,
@@ -297,7 +296,7 @@
     "DEPRECATED.",
     convert_to=six.text_type,
     default="https://kubernetes.default",
-    allow_http=False,
+    allow_http=False
 )
 
 define_config_option(
@@ -425,7 +424,7 @@
     convert_to=six.text_type,
     default="https://${host_ip}:10250",
     env_aware=True,
-    allow_http=False,
+    allow_http=False
 )
 
 define_config_option(
@@ -2353,6 +2352,7 @@ def _get_containers(
                         if not k8s_include_by_default:
                             continue
 
+
                 # add this container to the list of results
                 result[cid] = {
                     "name": cname,
@@ -2534,7 +2534,6 @@ class DockerLog(object):
     """
     Represents a list of log configs for a container
     """
-
     def __init__(self, cid, stream, log_configs):
         assert len(log_configs) > 0, "log_configs must not be empty"
         self.__cid = cid
@@ -2670,7 +2669,7 @@ def __init__(
             "k8s_cache_init_abort_delay"
         )
 
-        self.k8s_cache = None  # type: Optional[KubernetesCache]
+        self.k8s_cache = None # type: Optional[KubernetesCache]
         self.__k8s_config_builder = None
 
         self.__node_name = None
@@ -2686,8 +2685,8 @@ def __init__(
         self.__controlled_warmer = controlled_warmer
 
         # give this an initial empty value
-        self.raw_logs = []  # type: List[DockerLog]
-        self.docker_logs = []  # type: List[DockerLog]
+        self.raw_logs = [] # type: List[DockerLog]
+        self.docker_logs = [] # type: List[DockerLog]
 
         self.__stopped = False
 
@@ -3067,11 +3066,7 @@ def check_containers(self, run_state):
                                 limit_key="check-container-pod-info-%s" % cid,
                             )
 
-                        namespace = self.k8s_cache.namespace(
-                            pod_namespace,
-                            current_time=current_time,
-                            allow_expired=False,
-                        )
+                        namespace = self.k8s_cache.namespace(pod_namespace, current_time=current_time, allow_expired=False)
                     # start the container if have a container that wasn't running
                     if cid not in self.containers:
                         self._logger.log(
@@ -3082,14 +3077,10 @@ def check_containers(self, run_state):
                     elif cid in prev_digests or cid in prev_digests_namespaces:
                         # container was running and it exists in the previous digest dict, so see if
                         # it has changed
-                        if (pod and prev_digests[cid] != pod.digest) or (
-                            namespace
-                            and prev_digests_namespaces[cid] != namespace.digest
-                        ):
+                        if (pod and prev_digests[cid] != pod.digest) or (namespace and prev_digests_namespaces[cid] != namespace.digest):
                             self._logger.log(
                                 scalyr_logging.DEBUG_LEVEL_1,
-                                "Pod or namespace digest changed for '%s/%s'"
-                                % (namespace.name, info["name"]),
+                                "Pod or namespace digest changed for '%s/%s'" % (namespace.name, info["name"]),
                             )
                             changed[cid] = info
 
@@ -3137,12 +3128,8 @@ def check_containers(self, run_state):
                                 "updating config for '%s'" % info["name"],
                             )
 
-                            logger.log_configs = (
-                                self.__log_watcher.update_log_configs_on_path(
-                                    info["log_path"],
-                                    self.__module.module_name,
-                                    new_configs,
-                                )
+                            logger.log_configs = self.__log_watcher.update_log_configs_on_path(
+                                info["log_path"], self.__module.module_name, new_configs
                             )
                 else:
                     self._logger.log(
@@ -3207,11 +3194,9 @@ def __start_docker_logs(self, docker_logs):
             if self.__log_watcher:
                 updated_log_configs = []
                 for log_config in log.log_configs:
-                    updated_log_configs.append(
-                        self.__log_watcher.add_log_config(
-                            self.__module.module_name, log_config, force_add=True
-                        )
-                    )
+                    updated_log_configs.append(self.__log_watcher.add_log_config(
+                        self.__module.module_name, log_config, force_add=True
+                    ))
                 log.log_configs = updated_log_configs
 
             self.raw_logs.append(log)
@@ -3525,47 +3510,26 @@ def __get_log_config_for_container(self, cid, info, k8s_cache, base_attributes):
 
         self._logger.log(
             scalyr_logging.DEBUG_LEVEL_0,
-            "log_config_for_container Checking for teams in annotations for container %s(%s), pod %s, namespace %s. Container annotations = %s, Pod annotations = %s, Namespace annotations = %s  "
-            % (
-                info["name"],
-                short_cid,
-                pod_name,
-                pod_namespace,
-                container_annotations,
-                all_annotations,
-                namespace_annotations,
-            ),
+            "log_config_for_container Checking for teams in annotations for container %s(%s), pod %s, namespace %s. Container annotations = %s, Pod annotations = %s, Namespace annotations = %s  " \
+            % (info["name"], short_cid, pod_name, pod_namespace, container_annotations, all_annotations, namespace_annotations)
         )
 
         if container_annotations or all_annotations or namespace_annotations:
-            api_keys = self.__container_api_keys_from_annotations(
-                k8s_cache,
-                pod_namespace,
-                container_annotations,
-                "container",
-                info["name"],
-            )
+            api_keys = self.__container_api_keys_from_annotations(k8s_cache, pod_namespace, container_annotations, "container", info["name"])
             if not api_keys:
-                api_keys = self.__container_api_keys_from_annotations(
-                    k8s_cache, pod_namespace, all_annotations, "pod", info["name"]
-                )
+                api_keys = self.__container_api_keys_from_annotations(k8s_cache, pod_namespace, all_annotations, "pod", info["name"])
             if not api_keys:
-                api_keys = self.__container_api_keys_from_annotations(
-                    k8s_cache,
-                    pod_namespace,
-                    namespace_annotations,
-                    "namespace",
-                    info["name"],
-                )
+                api_keys = self.__container_api_keys_from_annotations(k8s_cache, pod_namespace, namespace_annotations, "namespace", info["name"])
             if api_keys:
                 # Multiple matching api keys will result in multiple log configs, which will differ in the api_key field only.
-                results = [{**result, "api_key": api_key} for api_key in api_keys]
+                results = [
+                    {**result, "api_key": api_key}
+                    for api_key in api_keys
+                ]
 
         return results
 
-    def __container_api_keys_from_annotations(
-        self, k8s_cache, namespace, annotations, annotation_kind, container_name
-    ):
+    def __container_api_keys_from_annotations(self, k8s_cache, namespace, annotations, annotation_kind, container_name):
         def fetch_secret(name):
             if not name:
                 return None
@@ -3582,45 +3546,48 @@ def fetch_secret(name):
                 )
 
             self._logger.warning(
-                "Failed to fetch secret '%s/%s', ignoring." % (namespace, name),
+                "Failed to fetch secret '%s/%s', ignoring."
+                % (namespace, name),
                 limit_once_per_x_secs=300,
                 limit_key="k8s-fetch-secret-%s/%s" % (namespace, name),
             )
 
         def get_secret_api_key(secret):
             if not secret:
                 return None
-            api_key = base64.b64decode(secret.data.get("scalyr-api-key")).decode(
-                "utf-8"
-            )
+            api_key = base64.b64decode(secret.data.get("scalyr-api-key")).decode("utf-8")
 
             if not api_key:
                 self._logger.warning(
                     "Secret '%s/%s' does not contain a scalyr-api-key field, ingoring."
                     % (namespace, secret.name),
                     limit_once_per_x_secs=300,
-                    limit_key="k8s-fetch-secret-%s" % secret.name,
+                    limit_key="k8s-fetch-secret-%s" % secret.name
                 )
 
             return api_key
 
-        secrets_names = [team.get("secret") for team in annotations.get("teams", [])]
+        secrets_names = [
+            team.get("secret")
+            for team in annotations.get("teams", [])
+        ]
 
-        secrets = [secret for secret in map(fetch_secret, secrets_names) if secret]
+        secrets = [
+            secret
+            for secret in map(fetch_secret, secrets_names)
+            if secret
+        ]
 
-        api_keys = [api_key for api_key in map(get_secret_api_key, secrets) if api_key]
+        api_keys = [
+            api_key
+            for api_key in map(get_secret_api_key, secrets)
+            if api_key
+        ]
 
         self._logger.log(
             scalyr_logging.DEBUG_LEVEL_0,
-            "log_config_for_container From %s annotations of container %s and namespace %s, got %d non-empty api keys, %d secrets for secret names %s"
-            % (
-                annotation_kind,
-                container_name,
-                namespace,
-                len(api_keys),
-                len(secrets),
-                ",".join(secrets_names),
-            ),
+            "log_config_for_container From %s annotations of container %s and namespace %s, got %d non-empty api keys, %d secrets for secret names %s" \
+            % (annotation_kind, container_name, namespace, len(api_keys), len(secrets), ",".join(secrets_names))
         )
 
         return api_keys

scalyr_agent/builtin_monitors/kubernetes_openmetrics_monitor.py

@@ -254,7 +254,7 @@
     convert_to=six.text_type,
     default="https://${host_ip}:10250",
     env_aware=True,
-    allow_http=False,
+    allow_http=False
 )
 
 # Monitor specific options

scalyr_agent/builtin_monitors/mysql_monitor.py

@@ -459,9 +459,7 @@ def _connect(self):
             self._cursor = None
             self._logger.error("Database connect failed: %s" % me)
         except Exception as ex:
-            self._logger.error(
-                "Exception trying to connect occured:  %s" % ex, exc_info=ex
-            )
+            self._logger.error("Exception trying to connect occured:  %s" % ex, exc_info=ex)
             raise Exception("Exception trying to connect:  %s" % ex)
 
     def _close(self):
@@ -1316,7 +1314,7 @@ def _connect_to_db(self):
                 "Error establishing database connection: %s" % (six.text_type(e)),
                 limit_once_per_x_secs=300,
                 limit_key="mysql_connect_to_db",
-                exc_info=e,
+                exc_info=e
             )
 
     def gather_sample(self):