Add issue prefilling support for o11y metrics
What does this MR do and why?
- Adds support for prefilling issue titles and descriptions with metric information.
MR acceptance checklist
Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.
Screenshots or screen recordings
Screenshots are required for UI changes, and strongly recommended for all other merge requests.
Before | After |
---|---|
How to set up and validate locally
-
Enable feature flag
observability_features
-
Ensure you have a working Ultimate licence.
-
Create a new group, and project within it.
-
Create a new issue by visiting the
issues/new
page with the correct urlencoded payload. Here's an example:/new?observability_metric_details={"fullUrl"%3A"http%3A%2F%2Fgdk.test%3A3000%2Fgitlab-org%2Fgitlab-test%2F-%2Fmetrics%2Fapp.ads.ad_requests%3Ftype%3DSum%26date_range%3D1h%26group_by_fn%3Dsum%26group_by_attrs[]%3Dapp.ads.ad_request_type%26group_by_attrs[]%3Dapp.ads.ad_response_type"%2C"name"%3A"app.ads.ad_requests"%2C"type"%3A"Sum"%2C"dimensions"%3A["app.ads.ad_request_type"%2C"app.ads.ad_response_type"]%2C"timeframe"%3A["2024-07-2504%3A47%3A00UTC"%2C"2024-07-2505%3A47%3A00UTC"]%2C"latestValues"%3A["app.ads.ad_request_type%3ANOT_TARGETED%2Capp.ads.ad_response_type%3ARANDOM%3A281.000"%2C"app.ads.ad_request_type%3ATARGETED%2Capp.ads.ad_response_type%3ATARGETED%3A1387.000"%2C"app.ads.ad_request_type%3ATARGETED%2Capp.ads.ad_response_type%3ARANDOM%3A287.000"]}
Note: This issue will add a button that generates and links that payload automatically.
-
Ensure that the issue is prefilled with a title that looks like
Issue created from app.ads.ad_requests
-
Ensure that the issue is prefilled with the description
[Metric details](http://gdk.test:3000/gitlab-org/gitlab-test/-/metrics/app.ads.ad_requests?type=Sum&date_range=1h&group_by_fn=sum&group_by_attrs[]=app.ads.ad_request_type&group_by_attrs[]=app.ads.ad_response_type) \ Name: `app.ads.ad_requests` \ Type: `Sum` \ Timeframe: `2024-07-2504:47:00UTC - 2024-07-2505:47:00UTC`
Relates to gitlab-org/opstrace/opstrace#2886 (closed)
Merge request reports
Activity
assigned to @mwoolf
added pipelinetier-1 label
- A deleted user
added backend label
2 Warnings 4da349e5: 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. featureaddition and featureenhancement merge requests normally have a documentation change. Consider adding a documentation update or confirming the documentation plan with the Technical Writer counterpart.
For more information, see:
- The Handbook page on merge request types.
- The definition of done documentation.
1 Message CHANGELOG missing: If this merge request needs a changelog entry, add the
Changelog
trailer to the commit message you want to add to the changelog.If this merge request doesn't need a CHANGELOG entry, feel free to ignore this message.
Reviewer roulette
Category Reviewer Maintainer backend @Quintasan
(UTC+2, 1 hour ahead of author)
@nbelokolodov
(UTC+8, 7 hours ahead of author)
Please refer to documentation page for guidance on how you can benefit from the Reviewer Roulette, or use the GitLab Review Workload Dashboard to find other available reviewers.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Danger- Resolved by 🤖 GitLab Bot 🤖
Proper labels assigned to this merge request. Please ignore me.
@mwoolf
- please see the following guidance and update this merge request.1 Error Please add typebug typefeature, or typemaintenance label to this merge request. Edited by 🤖 GitLab Bot 🤖
- Resolved by Rutger Wessels
- Resolved by Max Woolf
changed milestone to %17.3
added typebug label
added featureaddition groupobservability typefeature labels and removed typebug label
added devopsmonitor sectionanalytics labels
- Resolved by Rutger Wessels
- Resolved by Rutger Wessels
- Resolved by Rutger Wessels
Quickly tested it with my draft changes, and all looking good so far! ( I've temporarily removed dimensions while we decide on gitlab-org/opstrace/opstrace#2886 (comment 2024681937) )
added Category:Metrics label
- Resolved by Rutger Wessels
requested review from @drosse
- Resolved by Daniele Rossetti
- Resolved by Rutger Wessels
@ssuman3 Do you want another backend maintainer practice review? Feel free to take this on if you have capacity?
requested review from @ssuman3
@mwoolf LGTM from o11y point of view
removed review request for @drosse
added pipeline:mr-approved label
added pipelinetier-2 label and removed pipelinetier-1 label
Before you set this MR to auto-merge
This merge request will progress on pipeline tiers until it reaches the last tier: pipelinetier-3. We will trigger a new pipeline for each transition to a higher tier.
Before you set this MR to auto-merge, please check the following:
- You are the last maintainer of this merge request
- The latest pipeline for this merge request is pipelinetier-3 (You can find which tier it is in the pipeline name)
- This pipeline is recent enough (created in the last 8 hours)
If all the criteria above apply, please set auto-merge for this merge request.
See pipeline tiers and merging a merge request for more details.
mentioned in merge request !161449 (merged)
E2E Test Result Summary
allure-report-publisher
generated test report!e2e-test-on-gdk:
test report for 1fba0757expand test summary
+------------------------------------------------------------------+ | suites summary | +-------------+--------+--------+---------+-------+-------+--------+ | | passed | failed | skipped | flaky | total | result | +-------------+--------+--------+---------+-------+-------+--------+ | Release | 5 | 0 | 0 | 0 | 5 | ✅ | | Create | 127 | 0 | 12 | 0 | 139 | ✅ | | Verify | 44 | 0 | 2 | 0 | 46 | ✅ | | Plan | 70 | 0 | 0 | 0 | 70 | ✅ | | Data Stores | 31 | 0 | 1 | 0 | 32 | ✅ | | Fulfillment | 2 | 0 | 0 | 0 | 2 | ✅ | | Govern | 71 | 0 | 0 | 0 | 71 | ✅ | | Monitor | 8 | 0 | 0 | 0 | 8 | ✅ | | Package | 16 | 0 | 15 | 0 | 31 | ✅ | | Analytics | 2 | 0 | 0 | 0 | 2 | ✅ | | Secure | 2 | 0 | 0 | 0 | 2 | ✅ | | Manage | 0 | 0 | 1 | 0 | 1 | ➖ | +-------------+--------+--------+---------+-------+-------+--------+ | Total | 378 | 0 | 31 | 0 | 409 | ✅ | +-------------+--------+--------+---------+-------+-------+--------+
e2e-package-and-test:
test report for 1fba0757expand test summary
+---------------------------------------------------------------------+ | suites summary | +----------------+--------+--------+---------+-------+-------+--------+ | | passed | failed | skipped | flaky | total | result | +----------------+--------+--------+---------+-------+-------+--------+ | GitLab Metrics | 2 | 0 | 1 | 0 | 3 | ✅ | | Monitor | 12 | 0 | 13 | 0 | 25 | ✅ | | Create | 270 | 0 | 34 | 0 | 304 | ✅ | +----------------+--------+--------+---------+-------+-------+--------+ | Total | 284 | 0 | 48 | 0 | 332 | ✅ | +----------------+--------+--------+---------+-------+-------+--------+
- Resolved by Max Woolf
- Resolved by Surabhi Suman
- Resolved by Surabhi Suman
- Resolved by Mat Appelman
requested review from @drosse
mentioned in issue gitlab-com/www-gitlab-com#34918
requested review from @ssuman3
- Resolved by Max Woolf
requested review from @rutgerwessels
mentioned in issue gitlab-org/opstrace/opstrace#2885 (closed)
- Resolved by Rutger Wessels
- Resolved by Rutger Wessels
@mwoolf I still believe that this 'create title/description' should live somewhere else so we have better separation of concerns. And use
issue[title]
andissue[description]
parameters (with some?o11y_isssue=true
flag.I have one comment for the specs. The code itself looks good.
removed review request for @rutgerwessels
added 1 commit
- 4da349e5 - Refactor to move presentation out of issue service
requested review from @rutgerwessels
added pipelinetier-3 pipeline:run-e2e-omnibus-once labels and removed pipelinetier-2 label
aborted automatic add to merge train because the source branch was updated. Learn more.
reset approvals from @rutgerwessels by pushing to the branch
started a merge train
mentioned in commit ec6ee0e0
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added workflowpost-deploy-db-staging label and removed workflowproduction label
added workflowpost-deploy-db-production label and removed workflowpost-deploy-db-staging label
mentioned in merge request !161619 (merged)
mentioned in epic gitlab-org/opstrace&140 (closed)
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label
mentioned in merge request !163150 (merged)
mentioned in issue gitlab-com/www-gitlab-com#35061