[postgres] Clarify relations config requires dbname or database_autodiscovery#23988
[postgres] Clarify relations config requires dbname or database_autodiscovery#23988joeykelroy wants to merge 1 commit into
Conversation
…iscovery The previous description only mentioned `dbname` as a requirement when using the `relations` parameter, omitting `database_autodiscovery` as a valid alternative for collecting relation metrics across all databases. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 431012c41c
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| # dbstrict: false | ||
|
|
||
| ## @param ignore_databases - list of strings - optional - default: ['template0', 'template1', 'rdsadmin', 'azure_maintenance', 'cloudsqladmin', 'alloydbadmin', 'alloydbmetadata'] | ||
| ## @param ignore_databases - list of strings - optional |
There was a problem hiding this comment.
Preserve documented list defaults
This generated example now drops the - default: [...] suffix even though instance_ignore_databases() still applies the template/admin database exclusions when the option is omitted; the same regeneration also removes default annotations for several other list-valued options. In the public example this makes these values look like examples rather than effective defaults, so users can misconfigure monitoring by assuming omitted ignore_databases has no exclusions. Please regenerate with the expected defaults preserved or update the spec so the example continues to show the runtime default.
Useful? React with 👍 / 👎.
Summary
relationsparameter description inspec.yamlonly mentioneddbnameas a requirement, omittingdatabase_autodiscoveryas a valid alternativedbname(single database) ordatabase_autodiscovery(all databases on the instance) must be configured when usingrelationsconf.yaml.examplefrom the updated spec viaddev validate config -s postgresTest plan
conf.yaml.exampledescription for therelationsparameter matches the updated spec