Skip to content

Add support to suggest metrics names

What does this MR do?

  • Refactor the existing name suggestions generator in a factory
  • This can be used now for both case usage_data.rb and in instrumentation classes
  • Add support in instrumentation classes for the metric name suggestions.
  • This name will be later used when generate metric definitions with instrumentation classes

Usage/Test

> Gitlab::Usage::Metrics::Instrumentations::CountIssuesMetric.new(time_frame: '28d').suggested_name
=> "count_issues"
[6] pry(main)> Gitlab::Usage::Metrics::Instrumentations::CountUsersCreatingIssuesMetric.new(time_frame: '28d').suggested_name
=> "count_distinct_author_id_from_issues"
 Gitlab::Usage::Metrics::Instrumentations::RedisHLLMetric.new(time_frame: '28d', options: {events: 'i_quickactions_approve'}).suggested_name
=> "<please fill metric name, suggested format is: {subject}_{verb}{ing|ed}_{object} eg: users_creating_epics or merge_requests_viewed_in_single_file_mode>"
 Gitlab::Usage::Metrics::Instrumentations::UuidMetric.new(time_frame: 'none').suggested_name
=> "<please fill metric name>"

Screenshots (strongly suggested)

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

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 #331133 (closed)

Edited by Alina Mihaila

Merge request reports