chore: renaming setting explain_data_connector_details #3319
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
renaming setting explain_data_connector_details
Description
This PR renames the pg:setting explain_data_connector_details to data_connector_details_logs
GUS
https://gus.lightning.force.com/lightning/r/ADM_Work__c/a07EE00002BpMjhYAF/view
related shogun backend PR: https://github.com/heroku/shogun/pull/20599
related staging doc updates: https://salesforce-internal.slack.com/archives/CCS6NJYG2/p1743180785156639?thread_ts=1742919403.551169&cid=CCS6NJYG2
Why
we noticed that the Dev Center and our code are not aligned on the name of the PGSetting to enable emitting Streaming Data Connectors replication metrics to the Heroku Postgres metrics logs. We're not documenting the right name of the setting to be used.This feature was built for British Airways to have visibility on the spill files and disk usage caused by Streaming Data Connectors, and apparently hasn't been used by any other customers.
HCE and Product discussed this briefly through https://salesforce-internal.slack.com/archives/CCS6NJYG2/p1742942119820559?thread_ts=1742919403.551169&cid=CCS6NJYG2.
The Dev Center currently calls this setting "pg-replication-slot-logs" (https://devcenter.heroku.com/articles/heroku-postgres-settings#pg-replication-slot-logs). However, in reality it is called "explain-data-connector-details".
While discussing fixing the Dev Center article to include the right setting name, we wondered if it makes sense to rename the setting name to try avoid confusion. The current name, "explain-data-connector-details", might sound similar to a PG EXPLAIN, especially given that we document auto-explain on the same page.
Assuming this setting isn't being used, and after discussing with Product, we consider renaming the setting to "data-connector-details-logs". The risk is low, as noted in the thread BA was the only customer utilizing this setting.
Testing