Database Dictionary Audit for Ecosystem:Integrations
Recently the database team has started documenting all database tables in db/doc
. As an MVP, we've assigned
each table to a feature category. We attempted to automate this, and then made rough guesses on the ones that
couldn't be automatically identified either using this spreadsheet
or just by guessing based on their name and code references. In order to make sure these are accurate, I'm
asking every team to take a look at the tables associated with their feature categories assoicated with their
stages.
What we need from your team? Look through the list of tables and fix any mistaken labels and update the description field to help folks know what purpose the table serves.
Process (per table)
- Are the feature categories correct?
- Keep in mind that tables can have multiple categories. Look at the list and if there are any other categories it belongs to, add them.
- If a table has no category that seems to be a perfect match, assign it to the closest match. Tables must have at least one feature category.
- If the table is assigned to a feature category for a different group, open a merge request changing the category and assign it to the EM for the group responsible for that category.
- Update the description of the table to give anybody interacting with it context around the purpose and submit a merge request with the information.
- Double check the
milestone
andintroduced_by_url
to see if they are accurate
Tables
-
integrations -
integrations is the correct feature category or has been updated -
integrations description has been updated -
integrations milestone
andintroduced_by_url
seem accurate
-
-
clusters_integration_elasticstack -
integrations is the correct feature category or has been updated -
clusters_integration_elasticstack description has been updated -
clusters_integration_elasticstack milestone
andintroduced_by_url
seem accurate
-
-
web_hook_logs -
integrations is the correct feature category or has been updated -
web_hook_logs description has been updated -
web_hook_logs milestone
andintroduced_by_url
seem accurate
-
-
application_settings -
integrations is the correct feature category or has been updated -
application_settings description has been updated -
application_settings milestone
andintroduced_by_url
seem accurate
-
-
jira_tracker_data -
integrations is the correct feature category or has been updated -
jira_tracker_data description has been updated -
jira_tracker_data milestone
andintroduced_by_url
seem accurate
-
-
operations_feature_flags -
integrations is the correct feature category or has been updated -
operations_feature_flags description has been updated -
operations_feature_flags milestone
andintroduced_by_url
seem accurate
-
-
issue_tracker_data -
integrations is the correct feature category or has been updated -
issue_tracker_data description has been updated -
issue_tracker_data milestone
andintroduced_by_url
seem accurate
-
-
jira_connect_installations -
integrations is the correct feature category or has been updated -
jira_connect_installations description has been updated -
jira_connect_installations milestone
andintroduced_by_url
seem accurate
-
-
slack_integrations -
integrations is the correct feature category or has been updated -
slack_integrations description has been updated -
slack_integrations milestone
andintroduced_by_url
seem accurate
-
-
web_hooks -
integrations is the correct feature category or has been updated -
web_hooks description has been updated -
web_hooks milestone
andintroduced_by_url
seem accurate
-
-
jira_connect_subscriptions -
integrations is the correct feature category or has been updated -
jira_connect_subscriptions description has been updated -
jira_connect_subscriptions milestone
andintroduced_by_url
seem accurate
-
-
jira_imports -
integrations is the correct feature category or has been updated -
jira_imports description has been updated -
jira_imports milestone
andintroduced_by_url
seem accurate
-
-
zentao_tracker_data -
integrations is the correct feature category or has been updated -
zentao_tracker_data description has been updated -
zentao_tracker_data milestone
andintroduced_by_url
seem accurate
-
Why is this effort happening?
There have been many times that issues occur in production, but the the infrastructure team doesn't have the information it needs to identify subject matter experts who can help resolve things quickly. This in turn can delay the time it takes to find and fix pressing issues.
How much time should we expect to spend on this?
Depends, if the team has a lot of tables, it may take a little bit to get all of the information together. If not, this could be very fast. The descriptions are as much or little as the team wants to add. More information may help folks self service better.
How urgent is this?
The urgency is up to the team. If the tables have poor information or are misassigned, that may cause more burden on the team when answering questions.