Add option INCLUDE_PUBSUB_METRICS to manage verbose metrics

Author: andriusm

documentation/docs/getting-started/configuration.mdx

@@ -121,6 +121,9 @@ Please use this table as a reference.
 | OPAL_POLICY_REPO_CLONE_PATH                   | Where (i.e: base target path) to clone the repo in your docker filesystem (not important unless you mount a docker volume).                                                                                                                                                                                                 |                                          |
 | OPAL_POLICY_REPO_MAIN_BRANCH                  | Name of the git branch to track for policy files (default: `master`).                                                                                                                                                                                                                                                       |                                          |
 | OPAL_BUNDLE_IGNORE                            | Paths to omit from policy bundle. List of glob style paths, or paths without wildcards but ending with "/\*\*" indicating a parent path (ignoring all under it).                                                                                                                                                            | `bundle_ignore: Optional[List[str]]`     |
+| INCLUDE_PUBSUB_METRICS                        | Set if OPAL should include pubsub info in OpenTelemetry metrics                     |                                          |
+
+
 
 ## OPAL Client Configuration Variables
 
@@ -178,4 +181,4 @@ Please use this table as a reference.
 | OPA_HEALTH_CHECK_TRANSACTION_LOG_PATH | Path to OPA document that stores the OPA write transactions.                                                                                    |         |
 | OPAL_CLIENT_STAT_ID                   | Unique client statistics identifier.                                                                                                            |         |
 | OPA_HEALTH_CHECK_POLICY_PATH          |                                                                                                                                                 |         |
-| SCOPE_ID                              |                                                                                                                                                 |         |
+| SCOPE_ID                              |                                                                                                                                                 |         |

packages/opal-server/opal_server/config.py

@@ -384,10 +384,16 @@ class OpalServerConfig(Confi):
         description="Policy polling refresh interval",
     )
 
+    INCLUDE_PUBSUB_METRICS = confi.bool(
+        "INCLUDE_PUBSUB_METRICS",
+        False,
+        description="Set if OPAL should include pubsub info in OpenTelemetry metrics",
+    )
+
     def on_load(self):
         if self.SERVER_PORT is not None and self.SERVER_PORT.isdigit():
             # Backward compatibility - if SERVER_PORT is set with a valid value, use it as SERVER_BIND_PORT
             self.SERVER_BIND_PORT = int(self.SERVER_PORT)
 
 
-opal_server_config = OpalServerConfig(prefix="OPAL_")
+opal_server_config = OpalServerConfig(prefix="OPAL_")

packages/opal-server/opal_server/pubsub.py

@@ -45,6 +45,8 @@ def get_active_clients_counter():
     if _active_clients_counter is None:
         if not opal_common_config.ENABLE_OPENTELEMETRY_METRICS:
             return None
+        if not opal_server_config.INCLUDE_PUBSUB_METRICS:
+            return None
         meter = get_meter()
         _active_clients_counter = meter.create_counter(
             name="opal_server_active_clients",
@@ -58,6 +60,8 @@ def get_client_data_subscriptions_counter():
     if _client_data_subscriptions_counter is None:
         if not opal_common_config.ENABLE_OPENTELEMETRY_METRICS:
             return None
+        if not opal_server_config.INCLUDE_PUBSUB_METRICS:
+            return None
         meter = get_meter()
         _client_data_subscriptions_counter = meter.create_up_down_counter(
             name="opal_client_data_subscriptions",
@@ -279,4 +283,4 @@ async def _verify_permitted_topics(
         if unauthorized_topics:
             raise Unauthorized(
                 description=f"Invalid 'topics' to subscribe {unauthorized_topics}"
-            )
+            )