chore: upgrade Ruff configuration and reformat codebase

.pre-commit-config.yaml

@@ -1,10 +1,11 @@
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.7.0
+  rev: v0.15.9
   hooks:
     # Run the linter.
-    - id: ruff
+    - id: ruff-check
       args: [ --fix ]
     # Run the formatter.
     - id: ruff-format
+      types_or: [python, markdown]

pyproject.toml

@@ -65,6 +65,7 @@ dev = [
     "pytest-mock",
     "pre-commit>=3.0.0",
     "ruff",
+    "gunicorn",
 ]
 
 [project.urls]
@@ -94,3 +95,32 @@ exclude_also = [
     "except Exception:",
     "except Exception as exc:",
     ]
+
+[tool.ruff]
+# https://docs.astral.sh/ruff/configuration/
+target-version = "py39"
+# In addition to the standard set of exclusions, omit all tests, plus a specific file.
+extend-exclude = [".bob", "bin", ".github", ".circleci", ".tekton"]
+preview = true
+output-format = "concise"
+
+[tool.ruff.lint]
+# https://docs.astral.sh/ruff/rules/
+select = [
+    "E",        # pycodestyle
+    "F",        # Pyflakes
+    "I",        # isort
+    "CPY",      # flake8-copyright
+    "SIM",      # flake8-simplify
+    "FLY",      # flynt (static-join-to-f-string)
+    "UP031",    # printf-string-formatting
+    "UP032",    # f-string
+]
+ignore = ["E501", "I001"]
+
+[tool.ruff.lint.flake8-copyright]
+notice-rgx = "(?i)#\\s?(\\(c\\)\\s+)?Copyright\\s+IBM Corp\\.\\s+(\\d{4}((-|,\\s)\\d{4})?)"
+min-file-size = 1024
+
+# [tool.ruff.format]
+# preview = true

src/instana/agent/aws_eks_fargate.py

@@ -4,19 +4,19 @@
 The Instana agent (for AWS EKS Fargate) that manages
 monitoring state and reporting that data.
 """
-import os
-import time
-from instana.options import EKSFargateOptions
+
+from instana.agent.base import BaseAgent
 from instana.collector.aws_eks_fargate import EKSFargateCollector
 from instana.collector.helpers.eks.process import get_pod_name
 from instana.log import logger
+from instana.options import EKSFargateOptions
 from instana.util import to_json
-from instana.agent.base import BaseAgent
 from instana.version import VERSION
 
 
 class EKSFargateAgent(BaseAgent):
-    """ In-process agent for AWS Fargate """
+    """In-process agent for AWS Fargate"""
+
     def __init__(self):
         super(EKSFargateAgent, self).__init__()
 
@@ -29,15 +29,20 @@ def __init__(self):
         # Update log level (if INSTANA_LOG_LEVEL was set)
         self.update_log_level()
 
-        logger.info("Stan is on the EKS Pod on AWS Fargate scene.  Starting Instana instrumentation version: %s", VERSION)
+        logger.info(
+            "Stan is on the EKS Pod on AWS Fargate scene.  Starting Instana instrumentation version: %s",
+            VERSION,
+        )
 
         if self._validate_options():
             self._can_send = True
             self.collector = EKSFargateCollector(self)
             self.collector.start()
         else:
-            logger.warning("Required INSTANA_AGENT_KEY and/or INSTANA_ENDPOINT_URL environment variables not set.  "
-                           "We will not be able to monitor this Pod.")
+            logger.warning(
+                "Required INSTANA_AGENT_KEY and/or INSTANA_ENDPOINT_URL environment variables not set.  "
+                "We will not be able to monitor this Pod."
+            )
 
     def can_send(self):
         """
@@ -52,7 +57,7 @@ def get_from_structure(self):
         @return: dict()
         """
 
-        return {'hl': True, 'cp': 'k8s', 'e': self.podname}
+        return {"hl": True, "cp": "k8s", "e": self.podname}
 
     def report_data_payload(self, payload):
         """
@@ -67,15 +72,20 @@ def report_data_payload(self, payload):
                 self.report_headers["X-Instana-Host"] = self.podname
                 self.report_headers["X-Instana-Key"] = self.options.agent_key
 
-            response = self.client.post(self.__data_bundle_url(),
-                                        data=to_json(payload),
-                                        headers=self.report_headers,
-                                        timeout=self.options.timeout,
-                                        verify=self.options.ssl_verify,
-                                        proxies=self.options.endpoint_proxy)
+            response = self.client.post(
+                self.__data_bundle_url(),
+                data=to_json(payload),
+                headers=self.report_headers,
+                timeout=self.options.timeout,
+                verify=self.options.ssl_verify,
+                proxies=self.options.endpoint_proxy,
+            )
 
             if not 200 <= response.status_code < 300:
-                logger.info("report_data_payload: Instana responded with status code %s", response.status_code)
+                logger.info(
+                    "report_data_payload: Instana responded with status code %s",
+                    response.status_code,
+                )
         except Exception as exc:
             logger.debug("report_data_payload: connection error (%s)", type(exc))
         return response
@@ -84,10 +94,12 @@ def _validate_options(self):
         """
         Validate that the options used by this Agent are valid.  e.g. can we report data?
         """
-        return self.options.endpoint_url is not None and self.options.agent_key is not None
+        return (
+            self.options.endpoint_url is not None and self.options.agent_key is not None
+        )
 
     def __data_bundle_url(self):
         """
         URL for posting metrics to the host agent.  Only valid when announced.
         """
-        return "%s/bundle" % self.options.endpoint_url
+        return f"{self.options.endpoint_url}/bundle"

src/instana/agent/aws_fargate.py

@@ -5,17 +5,19 @@
 The Instana agent (for AWS Fargate) that manages
 monitoring state and reporting that data.
 """
-import time
-from instana.options import AWSFargateOptions
+
 from instana.collector.aws_fargate import AWSFargateCollector
+from instana.options import AWSFargateOptions
+
 from ..log import logger
 from ..util import to_json
-from .base import BaseAgent
 from ..version import VERSION
+from .base import BaseAgent
 
 
 class AWSFargateAgent(BaseAgent):
-    """ In-process agent for AWS Fargate """
+    """In-process agent for AWS Fargate"""
+
     def __init__(self):
         super(AWSFargateAgent, self).__init__()
 
@@ -27,15 +29,20 @@ def __init__(self):
         # Update log level (if INSTANA_LOG_LEVEL was set)
         self.update_log_level()
 
-        logger.info("Stan is on the AWS Fargate scene.  Starting Instana instrumentation version: %s", VERSION)
+        logger.info(
+            "Stan is on the AWS Fargate scene.  Starting Instana instrumentation version: %s",
+            VERSION,
+        )
 
         if self._validate_options():
             self._can_send = True
             self.collector = AWSFargateCollector(self)
             self.collector.start()
         else:
-            logger.warning("Required INSTANA_AGENT_KEY and/or INSTANA_ENDPOINT_URL environment variables not set.  "
-                           "We will not be able monitor this AWS Fargate cluster.")
+            logger.warning(
+                "Required INSTANA_AGENT_KEY and/or INSTANA_ENDPOINT_URL environment variables not set.  "
+                "We will not be able monitor this AWS Fargate cluster."
+            )
 
     def can_send(self):
         """
@@ -49,7 +56,7 @@ def get_from_structure(self):
         Retrieves the From data that is reported alongside monitoring data.
         @return: dict()
         """
-        return {'hl': True, 'cp': 'aws', 'e': self.collector.get_fq_arn()}
+        return {"hl": True, "cp": "aws", "e": self.collector.get_fq_arn()}
 
     def report_data_payload(self, payload):
         """
@@ -64,15 +71,20 @@ def report_data_payload(self, payload):
                 self.report_headers["X-Instana-Host"] = self.collector.get_fq_arn()
                 self.report_headers["X-Instana-Key"] = self.options.agent_key
 
-            response = self.client.post(self.__data_bundle_url(),
-                                        data=to_json(payload),
-                                        headers=self.report_headers,
-                                        timeout=self.options.timeout,
-                                        verify=self.options.ssl_verify,
-                                        proxies=self.options.endpoint_proxy)
+            response = self.client.post(
+                self.__data_bundle_url(),
+                data=to_json(payload),
+                headers=self.report_headers,
+                timeout=self.options.timeout,
+                verify=self.options.ssl_verify,
+                proxies=self.options.endpoint_proxy,
+            )
 
             if not 200 <= response.status_code < 300:
-                logger.info("report_data_payload: Instana responded with status code %s", response.status_code)
+                logger.info(
+                    "report_data_payload: Instana responded with status code %s",
+                    response.status_code,
+                )
         except Exception as exc:
             logger.debug("report_data_payload: connection error (%s)", type(exc))
         return response
@@ -81,10 +93,12 @@ def _validate_options(self):
         """
         Validate that the options used by this Agent are valid.  e.g. can we report data?
         """
-        return self.options.endpoint_url is not None and self.options.agent_key is not None
+        return (
+            self.options.endpoint_url is not None and self.options.agent_key is not None
+        )
 
     def __data_bundle_url(self):
         """
         URL for posting metrics to the host agent.  Only valid when announced.
         """
-        return "%s/bundle" % self.options.endpoint_url
+        return f"{self.options.endpoint_url}/bundle"

src/instana/agent/google_cloud_run.py

@@ -5,7 +5,7 @@
 The Instana agent (for GCR) that manages
 monitoring state and reporting that data.
 """
-import time
+
 from instana.options import GCROptions
 from instana.collector.google_cloud_run import GCRCollector
 from instana.log import logger
@@ -15,7 +15,7 @@
 
 
 class GCRAgent(BaseAgent):
-    """ In-process agent for Google Cloud Run """
+    """In-process agent for Google Cloud Run"""
 
     def __init__(self, service, configuration, revision):
         super(GCRAgent, self).__init__()
@@ -28,15 +28,20 @@ def __init__(self, service, configuration, revision):
         # Update log level (if INSTANA_LOG_LEVEL was set)
         self.update_log_level()
 
-        logger.info("Stan is on the AWS Fargate scene.  Starting Instana instrumentation version: %s", VERSION)
+        logger.info(
+            "Stan is on the AWS Fargate scene.  Starting Instana instrumentation version: %s",
+            VERSION,
+        )
 
         if self._validate_options():
             self._can_send = True
             self.collector = GCRCollector(self, service, configuration, revision)
             self.collector.start()
         else:
-            logger.warning("Required INSTANA_AGENT_KEY and/or INSTANA_ENDPOINT_URL environment variables not set.  "
-                           "We will not be able monitor this GCR cluster.")
+            logger.warning(
+                "Required INSTANA_AGENT_KEY and/or INSTANA_ENDPOINT_URL environment variables not set.  "
+                "We will not be able monitor this GCR cluster."
+            )
 
     def can_send(self):
         """
@@ -50,7 +55,7 @@ def get_from_structure(self):
         Retrieves the From data that is reported alongside monitoring data.
         @return: dict()
         """
-        return {'hl': True, 'cp': 'gcp', 'e': self.collector.get_instance_id()}
+        return {"hl": True, "cp": "gcp", "e": self.collector.get_instance_id()}
 
     def report_data_payload(self, payload):
         """
@@ -62,20 +67,24 @@ def report_data_payload(self, payload):
                 # Prepare request headers
                 self.report_headers = {
                     "Content-Type": "application/json",
-                    "X-Instana-Host": "gcp:cloud-run:revision:{revision}".format(
-                        revision=self.collector.revision),
-                    "X-Instana-Key": self.options.agent_key
+                    "X-Instana-Host": f"gcp:cloud-run:revision:{self.collector.revision}",
+                    "X-Instana-Key": self.options.agent_key,
                 }
 
-            response = self.client.post(self.__data_bundle_url(),
-                                        data=to_json(payload),
-                                        headers=self.report_headers,
-                                        timeout=self.options.timeout,
-                                        verify=self.options.ssl_verify,
-                                        proxies=self.options.endpoint_proxy)
+            response = self.client.post(
+                self.__data_bundle_url(),
+                data=to_json(payload),
+                headers=self.report_headers,
+                timeout=self.options.timeout,
+                verify=self.options.ssl_verify,
+                proxies=self.options.endpoint_proxy,
+            )
 
             if response.status_code >= 400:
-                logger.info("report_data_payload: Instana responded with status code %s", response.status_code)
+                logger.info(
+                    "report_data_payload: Instana responded with status code %s",
+                    response.status_code,
+                )
         except Exception as exc:
             logger.debug("report_data_payload: connection error (%s)", type(exc))
         return response
@@ -84,10 +93,12 @@ def _validate_options(self):
         """
         Validate that the options used by this Agent are valid.  e.g. can we report data?
         """
-        return self.options.endpoint_url is not None and self.options.agent_key is not None
+        return (
+            self.options.endpoint_url is not None and self.options.agent_key is not None
+        )
 
     def __data_bundle_url(self):
         """
         URL for posting metrics to the host agent.  Only valid when announced.
         """
-        return "{endpoint_url}/bundle".format(endpoint_url=self.options.endpoint_url)
+        return f"{self.options.endpoint_url}/bundle"

src/instana/agent/host.py

@@ -123,10 +123,7 @@ def can_send(self) -> bool:
             logger.debug("Fork detected; Handling like a pro...")
             self.handle_fork()
 
-        if self.machine.fsm.current in ["wait4init", "good2go"]:
-            return True
-
-        return False
+        return self.machine.fsm.current in ["wait4init", "good2go"]
 
     def set_from(
         self,
@@ -371,7 +368,7 @@ def filter_spans(self, spans: List[Dict[str, Any]]) -> List[Dict[str, Any]]:
             service_name = ""
 
             # Set the service name
-            for span_value in span.data.keys():
+            for span_value in span.data:
                 if isinstance(span.data[span_value], dict):
                     service_name = span_value
 
@@ -413,13 +410,12 @@ def __is_endpoint_ignored(self, span_attributes: dict) -> bool:
 
         # Check exclude rules
         exclude_rules = filters.get("exclude", [])
-        if any(
-            matches_rule(rule.get("attributes", []), span_attributes)
-            for rule in exclude_rules
-        ):
-            return True
-
-        return False
+        return bool(
+            any(
+                matches_rule(rule.get("attributes", []), span_attributes)
+                for rule in exclude_rules
+            )
+        )
 
     def handle_agent_tasks(self, task: Dict[str, Any]) -> None:
         """