Skip to content

Conversation

@brittanyrjones
Copy link
Contributor

@brittanyrjones brittanyrjones commented Jun 18, 2025

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

./bin/run pg:settings:data-connector-details-logs postgresql-bjones-rigid-84072 on -a bjones-test
data-connector-details-logs has been set to true for postgresql-bjones-rigid-84072.
Data replication slot details will be logged.

./bin/run pg:settings:data-connector-details-logs postgresql-bjones-rigid-84072 off -a bjones-test
data-connector-details-logs has been set to false for postgresql-bjones-rigid-84072.
Data replication slot details will no longer be logged.

# Ensure old command fails
./bin/run pg:settings:explain-data-connector-details postgresql-bjones-rigid-84072 on -a bjones-test
 ›   Warning: pg:settings:explain-data-connector-details is not a heroku command.
Did you mean pg:settings:data-connector-details-logs? [y/n]: y
data-connector-details-logs has been set to true for postgresql-bjones-rigid-84072.
Data replication slot details will be logged.
  • Ensure the command still works

@brittanyrjones brittanyrjones changed the title renaming setting chore: renaming setting explain_data_connector_details Jun 18, 2025
@brittanyrjones brittanyrjones marked this pull request as ready for review June 30, 2025 22:41
@brittanyrjones brittanyrjones requested a review from a team as a code owner June 30, 2025 22:41
@brittanyrjones brittanyrjones force-pushed the bj-rename-explain-data-connector-details branch from 75e44f6 to 26afc66 Compare July 3, 2025 17:01
Copy link
Contributor

@zwhitfield3 zwhitfield3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work here! Thank you for the touch up!

@zwhitfield3 zwhitfield3 merged commit 798e3cb into main Jul 15, 2025
8 checks passed
@zwhitfield3 zwhitfield3 deleted the bj-rename-explain-data-connector-details branch July 15, 2025 23:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants