Database Dictionary Audit for Verify:Pipeline Insights
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
-
ci_daily_build_group_report_results -
code_testing is the correct feature category or has been updated -
ci_daily_build_group_report_results description has been updated -
ci_daily_build_group_report_results milestone
andintroduced_by_url
seem accurate
-
-
ci_unit_test_failures -
code_testing is the correct feature category or has been updated -
ci_unit_test_failures description has been updated -
ci_unit_test_failures milestone
andintroduced_by_url
seem accurate
-
-
ci_build_report_results -
code_testing is the correct feature category or has been updated -
ci_build_report_results description has been updated -
ci_build_report_results milestone
andintroduced_by_url
seem accurate
-
-
ci_pipeline_artifacts -
build_artifacts is the correct feature category or has been updated -
ci_pipeline_artifacts description has been updated -
ci_pipeline_artifacts milestone
andintroduced_by_url
seem accurate
-
-
ci_job_artifacts -
build_artifacts is the correct feature category or has been updated -
ci_job_artifacts description has been updated -
ci_job_artifacts milestone
andintroduced_by_url
seem accurate
-
-
ci_deleted_objects -
build_artifacts is the correct feature category or has been updated -
ci_deleted_objects description has been updated -
⚠ ci_deleted_objectsmilestone
andintroduced_by_url
seem accurate- MR URL is not correct. The commit is 9bf76fe0, but can't find the MR.
-
-
project_build_artifacts_size_refreshes -
build_artifacts is the correct feature category or has been updated -
project_build_artifacts_size_refreshes description has been updated -
project_build_artifacts_size_refreshes milestone
andintroduced_by_url
seem accurate
-
-
reviews -
🔴 review_apps is the correct feature category or has been updatedThis is ~"Category:Code Review"
-
-
ci_unit_tests -
⚠ ~~continuous_integration will be updated to ~"group::pipeline insights" feature category~~ Category should becode_testing
-
ci_unit_tests description has been updated -
ci_unit_tests milestone
andintroduced_by_url
seem accurate
-
-
project_ci_feature_usages -
continuous_integration will be updated to ~"group::pipeline insights" feature category -
project_ci_feature_usages description has been updated -
project_ci_feature_usages 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.