Address review: connectivity metric, deps, secret flag, tests

- check.py: report connectivity as the genesys_mos.can_connect gauge (1/0)
  instead of a service check; add it to metadata.csv and empty service_checks.json
- README: add a manual step to install the PureCloudPlatformClientV2 dependency
  into the Agent's embedded env (the wheel install does not pull deps); document
  can_connect under Service checks and Troubleshooting
- spec.yaml: mark client_secret as secret so it is hidden from Agent output
- tests: assert the can_connect metric and validate metrics against metadata.csv
  via assert_metrics_using_metadata(get_metadata_metrics())

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Author: edferron-dd

genesys_mos/README.md

@@ -30,10 +30,15 @@ versions of the Agent.
    datadog-agent integration install -w /path/to/genesys_mos/dist/datadog_genesys_mos-1.0.0-py3-none-any.whl
    ```
 
-   This also installs the check's dependency, the Genesys Cloud Python SDK
-   (`PureCloudPlatformClientV2`), into the Agent's embedded environment.
+2. This command does not install the check's third-party dependency, so install the Genesys
+   Cloud Python SDK (`PureCloudPlatformClientV2`) into the Agent's embedded environment
+   manually:
 
-2. Configure your integration similar to core [integrations][5].
+   ```shell
+   sudo -u dd-agent /opt/datadog-agent/embedded/bin/pip install "PureCloudPlatformClientV2==261.0.0"
+   ```
+
+3. Configure your integration similar to core [integrations][5].
 
 ### Configuration
 
@@ -119,15 +124,18 @@ See [metadata.csv][10] for a list of metrics provided by this integration.
 
 ### Service checks
 
-See [service_checks.json][11] for a list of service checks provided by this integration.
+The Genesys Cloud MOS integration does not include any service checks. Connectivity is
+reported through the `genesys_mos.can_connect` metric, which is `1` when the check can
+authenticate against the Genesys Cloud API and run the analytics conversation query, and
+`0` otherwise.
 
 ### Events
 
 The Genesys Cloud MOS integration does not include any events.
 
 ## Troubleshooting
 
-- `genesys_mos.can_connect` reports `CRITICAL`: verify the `region`, `client_id`, and
+- `genesys_mos.can_connect` is `0`: verify the `region`, `client_id`, and
   `client_secret`, and confirm the OAuth client's role has the
   **Analytics > Conversation Detail > View** permission.
 - No conversations reported: MOS is only present on conversations that used media with
@@ -151,6 +159,5 @@ requests, contact the maintainer at ed.ferron@datadoghq.com or open an issue in
 [8]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
 [9]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
 [10]: https://github.com/DataDog/integrations-extras/blob/master/genesys_mos/metadata.csv
-[11]: https://github.com/DataDog/integrations-extras/blob/master/genesys_mos/assets/service_checks.json
 [12]: https://github.com/DataDog/integrations-extras/issues
 [13]: https://docs.datadoghq.com/agent/configuration/secrets-management/

genesys_mos/assets/configuration/spec.yaml

@@ -25,6 +25,7 @@ files:
     - name: client_secret
       description: The Client Secret for the OAuth client above.
       required: true
+      secret: true
       value:
         type: string
     - name: mos_threshold

genesys_mos/assets/service_checks.json

@@ -1,11 +1 @@
-[
-  {
-    "agent_version": "7.0.0",
-    "integration": "Genesys Cloud MOS",
-    "check": "genesys_mos.can_connect",
-    "statuses": ["ok", "critical"],
-    "groups": ["region"],
-    "name": "Genesys Cloud MOS: can connect",
-    "description": "Returns `OK` if the Agent can authenticate against the Genesys Cloud API and run the analytics conversation query, otherwise `CRITICAL`."
-  }
-]
+[]

genesys_mos/datadog_checks/genesys_mos/check.py

@@ -23,7 +23,7 @@
 class GenesysMosCheck(AgentCheck):
     __NAMESPACE__ = "genesys_mos"
 
-    SERVICE_CHECK_CONNECT = "can_connect"
+    CAN_CONNECT_METRIC = "can_connect"
 
     def __init__(self, name, init_config, instances):
         super(GenesysMosCheck, self).__init__(name, init_config, instances)
@@ -50,12 +50,13 @@ def check(self, _):
         try:
             analytics_api = self._authenticate()
             conversations = self._collect_conversations(analytics_api, interval)
-        except Exception as e:
-            self.service_check(self.SERVICE_CHECK_CONNECT, AgentCheck.CRITICAL, tags=self.base_tags, message=str(e))
+        except Exception:
+            # Report connectivity as a 0/1 gauge rather than a service check.
+            self.gauge(self.CAN_CONNECT_METRIC, 0, tags=self.base_tags)
             self.log.exception("Genesys Cloud MOS collection failed")
             raise
 
-        self.service_check(self.SERVICE_CHECK_CONNECT, AgentCheck.OK, tags=self.base_tags)
+        self.gauge(self.CAN_CONNECT_METRIC, 1, tags=self.base_tags)
         self._submit_metrics(conversations)
 
     def _query_interval(self):

genesys_mos/metadata.csv

@@ -3,3 +3,4 @@ genesys_mos.conversation.mos.avg,gauge,,,,Average of the per-conversation minimu
 genesys_mos.conversation.mos.min,gauge,,,,Worst (lowest) per-conversation minimum MOS observed across ended conversations in the query window.,1,genesys_cloud_mos,min mos,,region
 genesys_mos.conversation.count,gauge,,,,Number of ended conversations with a MOS value in the query window.,0,genesys_cloud_mos,conversation count,,region
 genesys_mos.conversation.below_threshold.count,gauge,,,,Number of conversations with MOS at or below the configured quality threshold.,-1,genesys_cloud_mos,below threshold count,,region
+genesys_mos.can_connect,gauge,,,,1 if the check can authenticate against the Genesys Cloud API and run the analytics conversation query else 0.,0,genesys_cloud_mos,can connect,,region

genesys_mos/tests/test_integration.py

@@ -96,7 +96,7 @@ def test_documented_pagination_dedupe_and_metrics(aggregator, instance):
     aggregator.assert_metric("genesys_mos.conversation.mos.min", value=3.61, tags=EXPECTED_TAGS)
     # threshold 4.2 -> 4.05 and 3.61 are at/below.
     aggregator.assert_metric("genesys_mos.conversation.below_threshold.count", value=2, tags=EXPECTED_TAGS)
-    aggregator.assert_service_check("genesys_mos.can_connect", status=GenesysMosCheck.OK, tags=EXPECTED_TAGS)
+    aggregator.assert_metric("genesys_mos.can_connect", value=1, tags=EXPECTED_TAGS)
     aggregator.assert_all_metrics_covered()
 
     # Paged until an empty page was returned (3 requests: page 1, 2, and the empty page 3).
@@ -149,4 +149,4 @@ def test_conversation_without_mos_is_skipped(aggregator, instance):
     aggregator.assert_metric("genesys_mos.conversation.mos.avg", value=4.30, tags=EXPECTED_TAGS)
     aggregator.assert_metric("genesys_mos.conversation.mos.min", value=4.30, tags=EXPECTED_TAGS)
     aggregator.assert_metric("genesys_mos.conversation.below_threshold.count", value=0, tags=EXPECTED_TAGS)
-    aggregator.assert_service_check("genesys_mos.can_connect", status=GenesysMosCheck.OK, tags=EXPECTED_TAGS)
+    aggregator.assert_metric("genesys_mos.can_connect", value=1, tags=EXPECTED_TAGS)

genesys_mos/tests/test_unit.py

@@ -6,7 +6,8 @@
 import pytest
 from mock import MagicMock, patch
 
-from datadog_checks.base import AgentCheck, ConfigurationError
+from datadog_checks.base import ConfigurationError
+from datadog_checks.dev.utils import get_metadata_metrics
 from datadog_checks.genesys_mos import GenesysMosCheck
 
 pytestmark = pytest.mark.unit
@@ -54,7 +55,7 @@ def test_query_interval_is_rfc3339_range(instance):
     assert start < end
 
 
-def test_emits_distribution_gauges_and_ok_service_check(aggregator, instance):
+def test_emits_distribution_gauges_and_can_connect(aggregator, instance):
     check = _check(instance)
     conversations = {"c1": 4.8, "c2": 4.1, "c3": 3.5}
 
@@ -70,8 +71,10 @@ def test_emits_distribution_gauges_and_ok_service_check(aggregator, instance):
     aggregator.assert_metric("genesys_mos.conversation.mos.min", value=3.5, tags=tags)
     # threshold 4.2 -> 4.1 and 3.5 are at/below
     aggregator.assert_metric("genesys_mos.conversation.below_threshold.count", value=2, tags=tags)
-    aggregator.assert_service_check("genesys_mos.can_connect", status=AgentCheck.OK, tags=tags)
+    # Connectivity is reported as a 0/1 gauge, not a service check.
+    aggregator.assert_metric("genesys_mos.can_connect", value=1, tags=tags)
     aggregator.assert_all_metrics_covered()
+    aggregator.assert_metrics_using_metadata(get_metadata_metrics())
 
 
 def test_no_conversations_reports_zero(aggregator, instance):
@@ -88,16 +91,16 @@ def test_no_conversations_reports_zero(aggregator, instance):
     # No quality gauges when there is no data.
     aggregator.assert_metric("genesys_mos.conversation.mos.avg", count=0)
     aggregator.assert_metric("genesys_mos.conversation.mos.min", count=0)
-    aggregator.assert_service_check("genesys_mos.can_connect", status=AgentCheck.OK)
+    aggregator.assert_metric("genesys_mos.can_connect", value=1)
 
 
-def test_auth_failure_reports_critical_and_raises(aggregator, instance):
+def test_auth_failure_reports_can_connect_zero_and_raises(aggregator, instance):
     check = _check(instance)
     with patch.object(check, "_authenticate", side_effect=RuntimeError("bad secret")):
         with pytest.raises(RuntimeError, match="bad secret"):
             check.check(None)
 
-    aggregator.assert_service_check("genesys_mos.can_connect", status=AgentCheck.CRITICAL)
+    aggregator.assert_metric("genesys_mos.can_connect", value=0)
     aggregator.assert_metric("genesys_mos.conversation.count", count=0)