Monitor: Metrics Deprecation

Deprecation Summary

Summary of the feature that is being deprecated:

We previously launched a solution that allows users to view performance metrics by displaying data stored in a Prometheus instance. The Prometheus instance can be setup as a GitLab managed app or the user can connect a previously configured Prometheus instance. The latter is known as an "external Prometheus" in GitLab lingo. The value we provided was to enable the user to easily set up monitoring (using GitLab Managed Apps) and have the visualization of the metrics all in the same tool you used to build the application.

However, since we are deprecating certificate-based integrations, the full monitoring experience is also deprecated as the user will not have the option to easily setup Prometheus all from within GitLab. Furthermore, with the acquisition of OpsTrace, we should consolidate on a single user experience instead of allowing users multiple paths on how to view metrics. Because of this, we will deprecate the external Prometheus experience, together with the metrics visualization capability, as well. For users that want to bring their own pre-configured and operational Prometheus, they can instead forward the metrics to GitLab Observability once we make that capability available.

This deprecation does not include:

• Deprecating alerts for Prometheus
• Capabilities that GitLab comes with that allow operators of GitLab to retrieve metrics from those instances

Documentation:

• Prometheus Metrics library
• Custom dashboards
• DO NOT DEPRECATE OR REMOVE Alerts for Prometheus

Proposal

• %14.7 documentation changes are made to reflect features that are being deprecated, !77417 (merged)
• %14.7 Deprecation MR, !77420 (merged)
• %14.8 in-product shows the features that are being deprecated. #350601 (closed)
• %15.10 Deprecation message added to the CHANGELOG.md file
• %15.10 Technical Breakdown for feature removal, Technical Breakdown for Monitor: Metrics Removal (gitlab-org/monitor/respond#109 - closed)
• %16.0 Removal MR
• %16.0 Deprecated code removed in %16.0: MR (consider removing code in multiple phases/MRs)
  • UI removal (required for %16.0)
  • API removal (required for %16.0)
  • Backend removal (can be done in future milestones if necessary)

Here is a link to the Deprecations, removals, and breaking changes process.

Note: A deprecation needs to have an initial announcement in the release post notifying the community at least two releases in advance of the date of planned removal. Deprecations should also be included in the documentation for at least 2 releases prior to the final removal.

Breaking Change

Affected Topology

TBD

Affected Tier

Checklist

• This issue/epic is shared with the team at a team meeting for ~"group::monitor"
• @mention your stage's stable counterparts 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 @williamchia
• @mention your GPM 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.
• Post the announcement of this deprecation in the following Slack Channels:
  • #ops-section
  • #37993

Deprecation Milestone

In which milestone will this deprecation be announced? %14.8

Planned Removal Milestone

In which milestone will the feature or functionality be removed and announced? %15.0

Links