From c7109e18cdc80488bcffecbd331e74d637ac9084 Mon Sep 17 00:00:00 2001 From: root Date: Fri, 12 Jul 2024 20:33:50 +0000 Subject: [PATCH] adds param name to spec.yaml --- postgres/assets/configuration/spec.yaml | 6 ++++++ .../postgres/config_models/instance.py | 13 +++++++------ .../datadog_checks/postgres/data/conf.yaml.example | 10 +++++----- postgres/datadog_checks/postgres/postgres.py | 1 - 4 files changed, 18 insertions(+), 12 deletions(-) diff --git a/postgres/assets/configuration/spec.yaml b/postgres/assets/configuration/spec.yaml index 485e3f43e5b84..4442ea2afc6b6 100644 --- a/postgres/assets/configuration/spec.yaml +++ b/postgres/assets/configuration/spec.yaml @@ -332,6 +332,12 @@ files: type: boolean example: false display_default: false + - name: global_view_db + description: Database the agent connects to perform autodiscovery operations + value: + type: string + example: postgres + display_default: postgres - name: max_databases description: The maximum number of databases this host should monitor. value: diff --git a/postgres/datadog_checks/postgres/config_models/instance.py b/postgres/datadog_checks/postgres/config_models/instance.py index a88b04c5bbe9b..1f602da5dd824 100644 --- a/postgres/datadog_checks/postgres/config_models/instance.py +++ b/postgres/datadog_checks/postgres/config_models/instance.py @@ -25,8 +25,8 @@ class ManagedAuthentication(BaseModel): arbitrary_types_allowed=True, frozen=True, ) - enabled: Optional[bool] = Field(None, examples=[False]) - role_arn: Optional[str] = Field(None, examples=['arn:aws:iam::123456789012:role/MyRole']) + enabled: Optional[bool] = Field(None, example=False) + role_arn: Optional[str] = Field(None, example='arn:aws:iam::123456789012:role/MyRole') class Aws(BaseModel): @@ -45,8 +45,8 @@ class ManagedAuthentication1(BaseModel): frozen=True, ) client_id: Optional[str] = None - enabled: Optional[bool] = Field(None, examples=[False]) - identity_scope: Optional[str] = Field(None, examples=['https://ossrdbms-aad.database.windows.net/.default']) + enabled: Optional[bool] = Field(None, example=False) + identity_scope: Optional[str] = Field(None, example='https://ossrdbms-aad.database.windows.net/.default') class Azure(BaseModel): @@ -105,6 +105,7 @@ class DatabaseAutodiscovery(BaseModel): ) enabled: Optional[bool] = None exclude: Optional[tuple[str, ...]] = None + global_view_db: Optional[str] = None include: Optional[tuple[str, ...]] = None max_databases: Optional[int] = None refresh: Optional[int] = None @@ -195,7 +196,7 @@ class QuerySamples(BaseModel): seen_samples_cache_maxsize: Optional[int] = None -class Relations(BaseModel): +class Relation(BaseModel): model_config = ConfigDict( arbitrary_types_allowed=True, frozen=True, @@ -258,7 +259,7 @@ class InstanceConfig(BaseModel): query_metrics: Optional[QueryMetrics] = None query_samples: Optional[QuerySamples] = None query_timeout: Optional[int] = None - relations: Optional[tuple[Union[str, Relations], ...]] = None + relations: Optional[tuple[Union[str, Relation], ...]] = None reported_hostname: Optional[str] = None service: Optional[str] = None ssl: Optional[str] = None diff --git a/postgres/datadog_checks/postgres/data/conf.yaml.example b/postgres/datadog_checks/postgres/data/conf.yaml.example index b1a357df4942a..d4d385a2f344b 100644 --- a/postgres/datadog_checks/postgres/data/conf.yaml.example +++ b/postgres/datadog_checks/postgres/data/conf.yaml.example @@ -344,16 +344,16 @@ instances: # # enabled: false - ## @param max_databases - integer - optional - default: 100 - ## The maximum number of databases this host should monitor. - # - # max_databases: 100 - ## @param global_view_db - string - optional - default: postgres ## Database the agent connects to perform autodiscovery operations # # global_view_db: postgres + ## @param max_databases - integer - optional - default: 100 + ## The maximum number of databases this host should monitor. + # + # max_databases: 100 + ## @param include - list of strings - optional - default: ['.*'] ## Regular expression for database names to include as part of ## database autodiscovery. diff --git a/postgres/datadog_checks/postgres/postgres.py b/postgres/datadog_checks/postgres/postgres.py index 1f07bef40d0e2..f10a6ef063d5e 100644 --- a/postgres/datadog_checks/postgres/postgres.py +++ b/postgres/datadog_checks/postgres/postgres.py @@ -156,7 +156,6 @@ def _build_autodiscovery(self): "Database autodiscovery is enabled, but relation-level metrics are not being collected." "All metrics will be gathered from global view." ) - return None discovery = PostgresAutodiscovery( self,