Additional internal event properties handling

assigned to @michold

changed milestone to %16.9

added devopsmonitor featureaddition groupanalytics instrumentation missed:16.8 sectionanalytics typefeature workflowin dev + 1 deleted label

removed missed:16.8 label

removed workflowin dev label

added backend label

	1 Message
	This MR contains docs in the /development directory. Any Maintainer, other than the author, can merge. You do not need tech writer review.

Reviewer roulette

Category	Reviewer	Maintainer
backend	`@tyleramos` (UTC-5, 6 hours behind author)	`@jwoodwardgl` (UTC+0, 1 hour behind author)

Please check reviewer's status!

Reviewer is available!
Reviewer is unavailable!

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

E2E Test Result Summary

allure-report-publisher generated test report!

e2e-test-on-gdk: test report for 7f14713c

expand test summary

+------------------------------------------------------------------+
|                          suites summary                          |
+-------------+--------+--------+---------+-------+-------+--------+
|             | passed | failed | skipped | flaky | total | result |
+-------------+--------+--------+---------+-------+-------+--------+
| Govern      | 3      | 0      | 0       | 0     | 3     | ✅     |
| Monitor     | 7      | 0      | 0       | 0     | 7     | ✅     |
| Plan        | 4      | 0      | 0       | 0     | 4     | ✅     |
| Data Stores | 2      | 0      | 0       | 0     | 2     | ✅     |
| Create      | 8      | 0      | 3       | 0     | 11    | ✅     |
| Package     | 0      | 0      | 1       | 0     | 1     | ➖     |
+-------------+--------+--------+---------+-------+-------+--------+
| Total       | 24     | 0      | 4       | 0     | 28    | ✅     |
+-------------+--------+--------+---------+-------+-------+--------+

e2e-package-and-test: test report for 7f14713c

expand test summary

+---------------------------------------------------------------------+
|                           suites summary                            |
+----------------+--------+--------+---------+-------+-------+--------+
|                | passed | failed | skipped | flaky | total | result |
+----------------+--------+--------+---------+-------+-------+--------+
| Monitor        | 36     | 0      | 13      | 0     | 49    | ✅     |
| GitLab Metrics | 2      | 0      | 1       | 0     | 3     | ✅     |
| Create         | 153    | 0      | 19      | 4     | 172   | ✅     |
| Govern         | 6      | 0      | 0       | 0     | 6     | ✅     |
| Plan           | 8      | 0      | 0       | 0     | 8     | ✅     |
| Package        | 0      | 0      | 2       | 0     | 2     | ➖     |
| Data Stores    | 4      | 0      | 0       | 0     | 4     | ✅     |
+----------------+--------+--------+---------+-------+-------+--------+
| Total          | 209    | 0      | 35      | 4     | 244   | ✅     |
+----------------+--------+--------+---------+-------+-------+--------+

added 1 commit

888fa11a - Additional internal event properties handling

Compare with previous version

changed the description

added 1 commit

ecb15c5f - Additional internal event properties handling

Compare with previous version

Hi @syasonik! Can you please give this a backend & analytics instrumentation review?

requested review from @syasonik

added development guidelines docsimprovement documentation maintenancerefactor typemaintenance labels and removed typefeature label

removed featureaddition label

@michold I'm a bit confused here: #434504 (closed) and the accompanying epic &12212 (closed) both call out a method signature that's different. Specifically, the idea was that the signature should clearly signify that label, properties etc. are additional properties that are not pseudo-required such as user or namespace (which always should be passed if available), and which makes it easy to transition to fully custom properties with different names without having to change the signature, e.g.

Gitlab::InternalEvents.track_event(
        "push_package_to_repository",
        user: user,
        namespace: namespace,
        project: project
        additionalProperties: { label: "nuget"}
)

could become

Gitlab::InternalEvents.track_event(
        "push_package_to_repository",
        user: user,
        namespace: namespace,
        project: project
        additionalProperties: { repository_type: "nuget"}
)

in a later iteration.

Is there a specific reason why you put label etc on the same level as user?

removed review request for @syasonik

mentioned in issue #434504 (closed)

mentioned in issue #440450 (closed)

added 1 commit

7a9c41dc - Additional internal event properties handling

Compare with previous version

added 2477 commits

7a9c41dc...bb458267 - 2476 commits from branch master
5aa3fa7e - Additional internal event properties handling

Compare with previous version

added 1 commit

ad35a336 - Additional internal event properties handling

Compare with previous version

changed the description

requested review from @syasonik

removed review request for @syasonik

changed milestone to %16.10

added missed:16.9 label

added 1 commit

13f37721 - Rewrite the add_prop documentation

Compare with previous version

requested review from @syasonik

removed review request for @syasonik

mentioned in issue #442452

added 1 commit

36e9c805 - Add ruby SDK tracking of additional properties

Compare with previous version

requested review from @syasonik

approved this merge request

removed review request for @syasonik

@syasonik, thanks for approving this merge request.

This is the first time the merge request has been approved. To ensure we don't only run predictive pipelines, and we don't break master, a new pipeline will be started shortly.

Please wait for the pipeline to start before resolving this discussion and set auto-merge for the new pipeline. See merging a merge request for more details.