Database Dictionary Audit for Monitor:Respond
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
-
sentry_issues -
error_tracking is the correct feature category or has been updated -
sentry_issues description has been updated -
sentry_issues milestone
andintroduced_by_url
seem accurate
-
-
error_tracking_errors -
error_tracking is the correct feature category or has been updated -
error_tracking_errors description has been updated -
error_tracking_errors milestone
andintroduced_by_url
seem accurate
-
-
project_error_tracking_settings -
error_tracking is the correct feature category or has been updated -
project_error_tracking_settings description has been updated -
project_error_tracking_settings milestone
andintroduced_by_url
seem accurate
-
-
error_tracking_client_keys -
error_tracking is the correct feature category or has been updated -
error_tracking_client_keys description has been updated -
error_tracking_client_keys milestone
andintroduced_by_url
seem accurate
-
-
error_tracking_error_events -
error_tracking is the correct feature category or has been updated -
error_tracking_error_events description has been updated -
error_tracking_error_events milestone
andintroduced_by_url
seem accurate
-
-
alert_management_alerts -
incident_management is the correct feature category or has been updated -
alert_management_alerts description has been updated -
alert_management_alerts milestone
andintroduced_by_url
seem accurate
-
-
incident_management_escalation_policies -
incident_management is the correct feature category or has been updated -
incident_management_escalation_policies description has been updated -
incident_management_escalation_policies milestone
andintroduced_by_url
seem accurate
-
-
incident_management_oncall_participants -
incident_management is the correct feature category or has been updated -
incident_management_oncall_participants description has been updated -
incident_management_oncall_participants milestone
andintroduced_by_url
seem accurate
-
-
issuable_slas -
incident_management is the correct feature category or has been updated -
issuable_slas description has been updated -
issuable_slas milestone
andintroduced_by_url
seem accurate
-
-
alert_management_alert_metric_images -
incident_management is the correct feature category or has been updated -
alert_management_alert_metric_images description has been updated -
alert_management_alert_metric_images milestone
andintroduced_by_url
seem accurate
-
-
alert_management_alert_user_mentions -
incident_management is the correct feature category or has been updated -
alert_management_alert_user_mentions description has been updated -
alert_management_alert_user_mentions milestone
andintroduced_by_url
seem accurate
-
-
status_page_published_incidents -
incident_management is the correct feature category or has been updated -
status_page_published_incidents description has been updated -
status_page_published_incidents milestone
andintroduced_by_url
seem accurate
-
-
incident_management_pending_alert_escalations -
incident_management is the correct feature category or has been updated -
incident_management_pending_alert_escalations description has been updated -
incident_management_pending_alert_escalations milestone
andintroduced_by_url
seem accurate
-
-
incident_management_oncall_schedules -
incident_management is the correct feature category or has been updated -
incident_management_oncall_schedules description has been updated -
incident_management_oncall_schedules milestone
andintroduced_by_url
seem accurate
-
-
incident_management_timeline_events -
incident_management is the correct feature category or has been updated -
incident_management_timeline_events description has been updated -
incident_management_timeline_events milestone
andintroduced_by_url
seem accurate
-
-
clusters -
incident_management is the correct feature category or has been updated -
clusters description has been updated -
clusters milestone
andintroduced_by_url
seem accurate
-
-
incident_management_issuable_escalation_statuses -
incident_management is the correct feature category or has been updated -
incident_management_issuable_escalation_statuses description has been updated -
incident_management_issuable_escalation_statuses milestone
andintroduced_by_url
seem accurate
-
-
issues_prometheus_alert_events -
incident_management is the correct feature category or has been updated -
issues_prometheus_alert_events description has been updated -
issues_prometheus_alert_events milestone
andintroduced_by_url
seem accurate
-
-
incident_management_escalation_rules -
incident_management is the correct feature category or has been updated -
incident_management_escalation_rules description has been updated -
incident_management_escalation_rules milestone
andintroduced_by_url
seem accurate
-
-
alert_management_alert_assignees -
incident_management is the correct feature category or has been updated -
alert_management_alert_assignees description has been updated -
alert_management_alert_assignees milestone
andintroduced_by_url
seem accurate
-
-
incident_management_oncall_rotations -
incident_management is the correct feature category or has been updated -
incident_management_oncall_rotations description has been updated -
incident_management_oncall_rotations milestone
andintroduced_by_url
seem accurate
-
-
clusters_integration_prometheus -
incident_management is the correct feature category or has been updated -
clusters_integration_prometheus description has been updated -
clusters_integration_prometheus milestone
andintroduced_by_url
seem accurate
-
-
issues_self_managed_prometheus_alert_events -
incident_management is the correct feature category or has been updated -
issues_self_managed_prometheus_alert_events description has been updated -
issues_self_managed_prometheus_alert_events milestone
andintroduced_by_url
seem accurate
-
-
project_alerting_settings -
incident_management is the correct feature category or has been updated -
project_alerting_settings description has been updated -
project_alerting_settings milestone
andintroduced_by_url
seem accurate
-
-
zoom_meetings -
incident_management is the correct feature category or has been updated -
zoom_meetings description has been updated -
zoom_meetings milestone
andintroduced_by_url
seem accurate
-
-
project_incident_management_settings -
incident_management is the correct feature category or has been updated -
project_incident_management_settings description has been updated -
project_incident_management_settings milestone
andintroduced_by_url
seem accurate
-
-
incident_management_oncall_shifts -
incident_management is the correct feature category or has been updated -
incident_management_oncall_shifts description has been updated -
incident_management_oncall_shifts milestone
andintroduced_by_url
seem accurate
-
-
prometheus_alerts -
incident_management is the correct feature category or has been updated -
prometheus_alerts description has been updated -
prometheus_alerts milestone
andintroduced_by_url
seem accurate
-
-
status_page_settings -
incident_management is the correct feature category or has been updated -
status_page_settings description has been updated -
status_page_settings milestone
andintroduced_by_url
seem accurate
-
-
alert_management_http_integrations -
incident_management is the correct feature category or has been updated -
alert_management_http_integrations description has been updated -
alert_management_http_integrations milestone
andintroduced_by_url
seem accurate
-
-
incident_management_pending_issue_escalations -
incident_management is the correct feature category or has been updated -
incident_management_pending_issue_escalations description has been updated -
incident_management_pending_issue_escalations 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.