[RUN ALL RSPEC] [RUN AS-IF-FOSS] Use instrumented classes in Usage Ping
What does this MR do?
Use instrumentation classes defined in metrics definitions and usage_data.rb
to build the Usage Ping Payload
This will allow us use instrumentation classes for a limited type of metrics. See &6118 (closed) for adding more support
Proposed roadmap
-
add add_metric(instrumentation)
method tousage_data.rb
-
Use the existing instrumentation classes in usage_data.rb
-
overite add_metric(instrumentation)
in usage_data_queries.rb in order to continue support for generating metrics queries -
overite add_metric(instrumentation)
for naming suggestions in order to continue support for metrics suggestions -
overite add_metric(instrumentation)
forlib/gitlab/usage_data_non_sql_metrics.rb
to continue support for non SQL metrics API
Testing considerations:
Metrics migrated to instrumentation classes in usage_data.rb:
- uuid
- hostname
- counts.issues
- count.boards
- usage_activity_by_stage.plan.issues
- usage_activity_by_stage_monthly.plan.issues
- settings.collected_data_categories
- Ensure JSON payload generated with
SubmitUsagePingService
is generating without any errors. - Correspondent RawUsageData is created correctly
- Payload is submitted to version app
RawUsageData.count SubmitUsagePingService.new.execute RawUsageData.count # inspect payload payload = RawUsageData.last.payload payload['uuid'] payload['hostname'] payload['counts']['issues'] payload['counts']['boards'] payload['usage_activity_by_stage']['plan']['issues'] payload['usage_activity_by_stage_monthly']['plan']['issues']
- Ensure we can generate the metrics queries
bundle exec rake gitlab:usage_data:dump_sql_in_yaml
- Ensure non SQL usage data is working correct
Gitlab::UsageDataNonSqlMetrics.uncached_data
- Name suggestions are correct:
Gitlab::Usage::Metrics::NamesSuggestions::Generator.generate("counts.boards")
Screenshots (strongly suggested)
Does this MR meet the acceptance criteria?
Conformity
-
I have included changelog trailers, or none are needed. (Does this MR need a changelog?) -
I have added/updated documentation, or it's not needed. (Is documentation required?) -
I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?) -
I have added information for database reviewers in the MR description, or it's not needed. (Does this MR have database related changes?) -
I have self-reviewed this MR per code review guidelines. -
This MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines) -
I have followed the style guides. -
This change is backwards compatible across updates, or this does not apply.
Availability and Testing
-
I have added/updated tests following the Testing Guide, or it's not needed. (Consider all test levels. See the Test Planning Process.) -
I have tested this MR in all supported browsers, or it's not needed. -
I have informed the Infrastructure department of a default or new setting change per definition of done, or it's not needed.
Security
Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team
Related to #330842 (closed)
Edited by Alina Mihaila