Deprecate Praefect's metrics configurations
For guidance on the overall deprecations, removals and breaking changes workflow, please visit Breaking changes, deprecations, and removing features
Deprecation Summary
Implementation Issue: Deprecate Praefect's `prometheus_exclude_databa... (omnibus-gitlab#7072 - closed)
Scraping Praefect DB metrics requires expensive queries. Currently the prometheus_exclude_database_from_default_metrics
configuration determines whether the DB metrics get exported to separate endpoint. By default DB metrics are exported to separate /db_metrics
endpoint for scraping. This reduces resource consumption by enabling separate configuration of the metrics scraping intervals. It is now desired to deprecate this configuration option in v16.0 in favor of always exporting Praefect DB metrics to a separate endpoint for scraping.
Breaking Change
This is a breaking change as the impacted configuration entry prometheus_exclude_database_from_default_metrics
will no longer function and will be removed. Users should recognize that the Praefect metrics will by default exported to /db_metrics
endpoint and update their metrics collection configurations.
Affected Topology
This impacts self-managed users. Those users on SaaS offerings do not have access to these metrics, nor would they be impacted.
Affected Tier
This impacts all tiers.
Checklists
Labels
-
This issue is labeled deprecation, and with the relevant ~devops::
,~group::
, and~Category:
labels. -
This issue is labeled breaking change if the removal of the deprecated item will be a breaking change.
Timeline
Please add links to the relevant merge requests.
- As soon as possible, but no later than the third milestone preceding the major release (for example, given the following release schedule:
14.8, 14.9, 14.10, 15.0
–14.8
is the third milestone preceding the major release):-
A deprecation announcement entry has been created so the deprecation will appear in release posts and on the general deprecation page. -
Documentation has been updated to mark the feature as deprecated.
-
-
On or before the major milestone: A removal entry has been created so the removal will appear on the removals by milestones page and be announced in the release post. - On the major milestone:
-
The deprecated item has been removed. -
If the removal of the deprecated item is a breaking change, the merge request is labeled breaking change.
-
Mentions
-
Your stage's stable counterparts have been @mentioned
on this issue. For example, Customer Support, Customer Success (Technical Account Manager), Product Marketing Manager.- To see who the stable counterparts are for a product team visit product categories
- If there is no stable counterpart listed for Sales/CS please mention
@timtams
- If there is no stable counterpart listed for Support please mention
@gitlab-com/support/managers
- If there is no stable counterpart listed for Marketing please mention
@cfoster3
- If there is no stable counterpart listed for Sales/CS please mention
- To see who the stable counterparts are for a product team visit product categories
-
Your GPM has been @mentioned
so that they are aware of planned deprecations. The goal is to have reviews happen at least two releases before the final removal of the feature or introduction of a breaking change.
Deprecation Milestone
This will be announced in %15.9
Planned Removal Milestone
This will be removed in %16.0.