feat: added single method option to configuration.yaml

Signed-off-by: Cagri Yonca <cagri@ibm.com>

Author: CagriYonca

src/instana/util/config.py

@@ -82,18 +82,26 @@ def parse_endpoints_of_service(
     """
     if service == "kafka" and isinstance(methods, list):
         for rule in methods:
-            for method, endpoint in itertools.product(
-                rule["methods"], rule["endpoints"]
-            ):
-                ignore_endpoints.append(
-                    f"{service.lower()}.{method.lower()}.{endpoint.lower()}"
-                )
+            ignore_endpoints.extend(parse_kafka_methods(rule))
     else:
         for method in methods:
             ignore_endpoints.append(f"{service.lower()}.{method.lower()}")
     return ignore_endpoints
 
 
+def parse_kafka_methods(rule: Union[str, Dict[str, any]]) -> List[str]:
+    parsed_rule = []
+    if isinstance(rule, dict):
+        for method, endpoint in itertools.product(rule["methods"], rule["endpoints"]):
+            parsed_rule.append(f"kafka.{method.lower()}.{endpoint.lower()}")
+    elif isinstance(rule, list):
+        for method in rule:
+            parsed_rule.append(f"kafka.{method.lower()}.*")
+    else:
+        parsed_rule.append(f"kafka.{rule.lower()}.*")
+    return parsed_rule
+
+
 def parse_ignored_endpoints(params: Union[Dict[str, Any], str]) -> List[str]:
     """
     Parses input to prepare a list for ignored endpoints.

tests/util/test_config.py

@@ -4,6 +4,7 @@
     parse_endpoints_of_service,
     parse_ignored_endpoints,
     parse_ignored_endpoints_dict,
+    parse_kafka_methods,
     parse_service_pair,
 )
 
@@ -157,3 +158,13 @@ def test_parse_endpoints_of_service(self) -> None:
             "kafka.method6.endpoint1",
             "kafka.method6.endpoint2",
         ]
+
+    def test_parse_kafka_methods_as_dict(self) -> None:
+        test_rule_as_dict = {"methods": ["send"], "endpoints": ["topic1"]}
+        parsed_rule = parse_kafka_methods(test_rule_as_dict)
+        assert parsed_rule == ["kafka.send.topic1"]
+
+    def test_parse_kafka_methods_as_str(self) -> None:
+        test_rule_as_str = ["send"]
+        parsed_rule = parse_kafka_methods(test_rule_as_str)
+        assert parsed_rule == ["kafka.send.*"]

tests/util/test_config_reader.py

@@ -47,6 +47,7 @@ def test_load_configuration_legacy(self, caplog: pytest.LogCaptureFixture) -> No
             "redis.get",
             "redis.type",
             "dynamodb.query",
+            "kafka.send.*",
             "kafka.consume.span-topic",
             "kafka.consume.topic1",
             "kafka.consume.topic2",

tests/util/test_configuration-2.yaml

@@ -9,6 +9,7 @@ com.instana.tracing:
     dynamodb:
       - query
     kafka: 
+      - send
       - methods: ["consume", "send"]
         endpoints: ["span-topic", "topic1", "topic2"]
       - methods: ["consume"]