Run ruff format

spicedb/datadog_checks/spicedb/__about__.py

@@ -1,2 +1 @@
-
-__version__ = '1.0.0'
+__version__ = "1.0.0"

spicedb/datadog_checks/spicedb/check.py

@@ -11,17 +11,17 @@
 
 
 class SpicedbCheck(OpenMetricsBaseCheckv2, ConfigMixin):
-
     # This will be the prefix of every metric and service check the integration sends
-    __NAMESPACE__ = 'spicedb'
+    __NAMESPACE__ = "spicedb"
 
     def get_default_config(self):
         """
-        Provides a default configuration, e.g. for tests.
+        Provides a default configuration. Anything configured by the user overrides this,
+        but this is where we provide the metrics definitions used by the scraper.
         """
         return {
-                # TODO: this is technically the prometheus endpoint, not the openmetrics endpoint
-                # Need to see if that'll be a problem.
-                'openmetrics_endpoint': 'http://localhost:9090/metrics',
-                'metrics': METRICS_CONFIG
-                }
+            # TODO: this is technically the prometheus endpoint, not the openmetrics endpoint
+            # Need to see if that'll be a problem.
+            "openmetrics_endpoint": "http://localhost:9090/metrics",
+            "metrics": METRICS_CONFIG,
+        }

spicedb/datadog_checks/spicedb/config_models/defaults.py

@@ -17,7 +17,7 @@ def instance_allow_redirects():
 
 
 def instance_auth_type():
-    return 'basic'
+    return "basic"
 
 
 def instance_cache_metric_wildcards():
@@ -57,7 +57,7 @@ def instance_ignore_connection_errors():
 
 
 def instance_kerberos_auth():
-    return 'disabled'
+    return "disabled"
 
 
 def instance_kerberos_delegate():
@@ -81,7 +81,7 @@ def instance_non_cumulative_histogram_buckets():
 
 
 def instance_openmetrics_endpoint():
-    return 'http://localhost:9090/metrics'
+    return "http://localhost:9090/metrics"
 
 
 def instance_persist_connections():

spicedb/datadog_checks/spicedb/config_models/instance.py

@@ -28,7 +28,7 @@ class AuthToken(BaseModel):
 class ExtraMetrics(BaseModel):
     model_config = ConfigDict(
         arbitrary_types_allowed=True,
-        extra='allow',
+        extra="allow",
         frozen=True,
     )
     name: Optional[str] = None
@@ -47,7 +47,7 @@ class MetricPatterns(BaseModel):
 class Metrics(BaseModel):
     model_config = ConfigDict(
         arbitrary_types_allowed=True,
-        extra='allow',
+        extra="allow",
         frozen=True,
     )
     name: Optional[str] = None
@@ -116,7 +116,7 @@ class InstanceConfig(BaseModel):
     metric_patterns: Optional[MetricPatterns] = None
     metrics: Optional[tuple[Union[str, MappingProxyType[str, Union[str, Metrics]]], ...]] = None
     min_collection_interval: Optional[float] = None
-    namespace: Optional[str] = Field(None, pattern='\\w*')
+    namespace: Optional[str] = Field(None, pattern="\\w*")
     non_cumulative_histogram_buckets: Optional[bool] = None
     ntlm_domain: Optional[str] = None
     openmetrics_endpoint: Optional[str] = None
@@ -147,21 +147,21 @@ class InstanceConfig(BaseModel):
     use_process_start_time: Optional[bool] = None
     username: Optional[str] = None
 
-    @model_validator(mode='before')
+    @model_validator(mode="before")
     def _initial_validation(cls, values):
-        return validation.core.initialize_config(getattr(validators, 'initialize_instance', identity)(values))
+        return validation.core.initialize_config(getattr(validators, "initialize_instance", identity)(values))
 
-    @field_validator('*', mode='before')
+    @field_validator("*", mode="before")
     def _validate(cls, value, info):
         field = cls.model_fields[info.field_name]
         field_name = field.alias or info.field_name
-        if field_name in info.context['configured_fields']:
-            value = getattr(validators, f'instance_{info.field_name}', identity)(value, field=field)
+        if field_name in info.context["configured_fields"]:
+            value = getattr(validators, f"instance_{info.field_name}", identity)(value, field=field)
         else:
-            value = getattr(defaults, f'instance_{info.field_name}', lambda: value)()
+            value = getattr(defaults, f"instance_{info.field_name}", lambda: value)()
 
         return validation.utils.make_immutable(value)
 
-    @model_validator(mode='after')
+    @model_validator(mode="after")
     def _final_validation(cls, model):
-        return validation.core.check_model(getattr(validators, 'check_instance', identity)(model))
+        return validation.core.check_model(getattr(validators, "check_instance", identity)(model))

spicedb/datadog_checks/spicedb/config_models/shared.py

@@ -36,21 +36,21 @@ class SharedConfig(BaseModel):
     skip_proxy: Optional[bool] = None
     timeout: Optional[float] = None
 
-    @model_validator(mode='before')
+    @model_validator(mode="before")
     def _initial_validation(cls, values):
-        return validation.core.initialize_config(getattr(validators, 'initialize_shared', identity)(values))
+        return validation.core.initialize_config(getattr(validators, "initialize_shared", identity)(values))
 
-    @field_validator('*', mode='before')
+    @field_validator("*", mode="before")
     def _validate(cls, value, info):
         field = cls.model_fields[info.field_name]
         field_name = field.alias or info.field_name
-        if field_name in info.context['configured_fields']:
-            value = getattr(validators, f'shared_{info.field_name}', identity)(value, field=field)
+        if field_name in info.context["configured_fields"]:
+            value = getattr(validators, f"shared_{info.field_name}", identity)(value, field=field)
         else:
-            value = getattr(defaults, f'shared_{info.field_name}', lambda: value)()
+            value = getattr(defaults, f"shared_{info.field_name}", lambda: value)()
 
         return validation.utils.make_immutable(value)
 
-    @model_validator(mode='after')
+    @model_validator(mode="after")
     def _final_validation(cls, model):
-        return validation.core.check_model(getattr(validators, 'check_shared', identity)(model))
+        return validation.core.check_model(getattr(validators, "check_shared", identity)(model))

spicedb/datadog_checks/spicedb/config_models/validators.py

@@ -1,5 +1,3 @@
-
-
 # Here you can include additional config validators or transformers
 #
 # def initialize_instance(values, **kwargs):

spicedb/tests/conftest.py

@@ -5,23 +5,24 @@
 
 from .util import HOST, PORT
 
-@pytest.fixture(scope='session')
+
+@pytest.fixture(scope="session")
 def dd_environment(instance):
     env_vars = {"SPICEDB_GRPC_PRESHARED_KEY": "some random key"}
 
     with docker_run(
-            os.path.join(get_here(), "docker", "docker-compose.yml"),
-            env_vars=env_vars,
-            endpoints=instance['openmetrics_endpoint'],
-            conditions=None,
-            ):
+        os.path.join(get_here(), "docker", "docker-compose.yml"),
+        env_vars=env_vars,
+        endpoints=instance["openmetrics_endpoint"],
+        conditions=None,
+    ):
         yield instance
 
 
 @pytest.fixture
-def instance(scope='session'):
+def instance(scope="session"):
     return {
-        'openmetrics_endpoint': 'http://{}:{}/metrics'.format(HOST, PORT),
-        'histogram_buckets_as_distributions': True,
-        'tags': ['cluster:cockroachdb-cluster', 'node:1'],
+        "openmetrics_endpoint": "http://{}:{}/metrics".format(HOST, PORT),
+        "histogram_buckets_as_distributions": True,
+        "tags": ["cluster:cockroachdb-cluster", "node:1"],
     }

spicedb/tests/test_e2e.py

@@ -1,4 +1,3 @@
-
 def test_metrics(dd_agent_check, instance):
     aggregator = dd_agent_check(instance, rate=True)
     expected_metrics = []

spicedb/tests/test_integration.py

@@ -5,19 +5,19 @@
 from datadog_checks.dev.utils import assert_service_checks, get_metadata_metrics
 
 # NOTE: this is the same as annotating all of the test functions in this file with the dd_environment fixture.
-pytestmark = [pytest.mark.usefixtures('dd_environment')]
+pytestmark = [pytest.mark.usefixtures("dd_environment")]
 
 
 def test_metrics(aggregator, instance, dd_run_check):
-    check = CockroachdbCheck('spicedb', {}, [instance])
+    check = CockroachdbCheck("spicedb", {}, [instance])
     dd_run_check(check)
 
     expected_metrics = []
 
     for metric in expected_metrics:
         aggregator.assert_metric(f"spicedb.{metric}", at_least=0)
 
-    aggregator.assert_service_check('spicedb.openmetrics.health', ServiceCheck.OK)
+    aggregator.assert_service_check("spicedb.openmetrics.health", ServiceCheck.OK)
     aggregator.assert_metrics_using_metadata(get_metadata_metrics(), check_submission_type=True)
 
     assert_service_checks(aggregator)

spicedb/tests/test_unit.py

@@ -1,5 +1,3 @@
-
-
 from typing import Any, Callable, Dict  # noqa: F401
 
 from datadog_checks.base import AgentCheck  # noqa: F401
@@ -12,24 +10,24 @@
 
 def test_metrics(aggregator, instance, dd_run_check, mock_http_response):
     mock_http_response(file_path=get_fixture_path("all_metrics.txt"))
-    dd_run_check(SpicedbCheck('spicedb', {}, [instance]))
+    dd_run_check(SpicedbCheck("spicedb", {}, [instance]))
 
-    tags = ['cluster:spicedb-cluster', 'endpoint:http://localhost:9090/metrics', 'node:1', 'node_id:1']
+    tags = ["cluster:spicedb-cluster", "endpoint:http://localhost:9090/metrics", "node:1", "node_id:1"]
 
     # TODO:
     for metric in metrics:
-        aggregator.assert_metric('spicedb.{}'.format(metric))
+        aggregator.assert_metric("spicedb.{}".format(metric))
         for tag in tags:
-            aggregator.assert_metric_has_tag('spicedb.{}'.format(metric), tag)
+            aggregator.assert_metric_has_tag("spicedb.{}".format(metric), tag)
 
-    aggregator.assert_service_check('cockroachdb.prometheus.health', ServiceCheck.OK)
+    aggregator.assert_service_check("cockroachdb.prometheus.health", ServiceCheck.OK)
     aggregator.assert_all_metrics_covered()
     aggregator.assert_metrics_using_metadata(get_metadata_metrics(), check_submission_type=True)
 
     assert_service_checks(aggregator)
 
 
 def test_emits_critical_service_check_when_service_is_down(dd_run_check, aggregator, instance):
-    check = SpicedbCheck('spicedb', {}, [instance])
+    check = SpicedbCheck("spicedb", {}, [instance])
     dd_run_check(check)
-    aggregator.assert_service_check('spicedb.prometheus.health', SpicedbCheck.CRITICAL)
+    aggregator.assert_service_check("spicedb.prometheus.health", SpicedbCheck.CRITICAL)

spicedb/tests/util.py

@@ -3,7 +3,8 @@
 from datadog_checks.dev import get_docker_hostname, get_here
 
 HOST = get_docker_hostname()
-PORT = '8080'
+PORT = "8080"
+
 
 def get_fixture_path(filename):
-    return os.path.join(get_here(), 'fixtures', filename)
+    return os.path.join(get_here(), "fixtures", filename)