Add Metrics Dashboard annnotations API to FF
What does this MR do and why?
This MR gates the metrics dashboard annotations API behind the remove_monitor_metrics
feature flag. Frontend is done, but we also want to deprecate/remove any API access.
Related issue: Metrics: Delete API entrypoints & helpers (#397138 - closed) (one of many MRs)
Context for removal:
- The Metrics Dashboard feature is being removed in %16.0.
- Feature docs: https://docs.gitlab.com/ee/operations/metrics
- Removal issue: Monitor: Metrics Deprecation and Removal (&10107)
- Most of the metrics dashboard frontend is currently behind the
remove_monitor_metrics
flag, but the flag has not yet been enabled. It needs to be enabled by default in time for %16.0.- The entire frontend should be behind the flag in order to enable it by default, but the API can merge after - as long as we make all breaking changes within %16.0.
- Rollout issue: [Feature flag] Rollout of `remove_monitor_metrics` (#399248)
- Tracking issue: Metrics: hide deprecated modules behind a featu... (#399231 - closed)
- Enable-by-default MR: Set remove_monitor_metrics flag to true (!119989 - merged)
backend MRs to flag all metrics dashboard endpoints
All related- Add Metrics Dashboard annnotations API to FF (!120286 - merged)
- Add Metrics Dashboard starred dashboard API to FF (!120288 - merged)
- Add Metrics Dashboard templates viewer to FF (!120289 - merged)
- Add Metrics Dashboard environments API to FF (!120299 - merged)
- Add Metrics Dashboard settings API to FF (!120305 - merged)
- Add Metrics Dashboard GraphQL alert queries to FF (!120307 - merged)
- Add Metrics Dashboard embed pipeline to FF (!120310 - merged)
- Add Metrics Dashboard for internal dashboard en... (!120313 - merged)
- Add Metrics Dashboard base API to FF (!120316 - merged)
How to set up and validate locally
Pre-req: Project with environments
- Use graphiql to test the query -> http://gdk.test:3000/-/graphql-explorer
- We can verify the flag without annotations actually set up, because the response attribute will switch from
[]
tonull
or error
Query | Response before | Response after |
---|---|---|
|
|
|
|
|
|
|
|
|
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.
Merge request reports
Activity
changed milestone to %16.0
assigned to @syasonik
1 Warning ea4fb7f1: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. 2 Messages CHANGELOG missing: If you want to create a changelog entry for GitLab FOSS, add the
Changelog
trailer to the commit message you want to add to the changelog.If you want to create a changelog entry for GitLab EE, also add the
EE: true
trailer to your commit message.If this merge request doesn't need a CHANGELOG entry, feel free to ignore this message.
This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
-
doc/api/graphql/reference/index.md
(Link to current live version)
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
Reviewer roulette
Changes that require review have been detected!
Please refer to the table below for assigning reviewers and maintainers suggested by Danger in the specified category:
Category Reviewer Maintainer backend Dzmitry Meshcharakou (
@dmeshcharakou
) (UTC+2, 6 hours ahead of@syasonik
)Ethan Urie (
@eurie
) (UTC-4, same timezone as@syasonik
)To spread load more evenly across eligible reviewers, Danger has picked a candidate for each review slot, based on their timezone. Feel free to override these selections if you think someone else would be better-suited or use the GitLab Review Workload Dashboard to find other available reviewers.
To read more on how to use the reviewer roulette, please take a look at the Engineering workflow and code review guidelines. Please consider assigning a reviewer or maintainer who is a domain expert in the area of the merge request.
Once you've decided who will review this merge request, assign them as a reviewer! Danger does not automatically notify them for you.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Danger-
- Resolved by Sarah Yasonik
added 1 commit
- 8b70fefb - Add Metrics Dashboard annnotations API to FF
- A deleted user
added documentation label
added 1 commit
- 811bee98 - Add Metrics Dashboard annnotations API to FF
mentioned in merge request !120288 (merged)
mentioned in merge request !120289 (merged)
mentioned in merge request !120299 (merged)
mentioned in merge request !120305 (merged)
mentioned in merge request !120307 (merged)
mentioned in merge request !120309 (closed)
mentioned in merge request !120310 (merged)
mentioned in merge request !120313 (merged)
mentioned in merge request !120316 (merged)