Skip to content

Deprecate `options` key for internal_events yaml

Michał Wielich requested to merge michold-intev-deprecate-options into master

What does this MR do and why?

Related to #427298 (closed)

We want to deprecate usage of options attribute in internal_events. We already have all the necessary data under the events: key in the metrics. With !144899 (merged), we made it so that the options attribute is not longer needed for the calculations. In this MR, we make it so that options are also removed in our documentation and our cli doesn't generate files with options: anymore.

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

  1. Play around with our cli, generating metrics.
  2. Make sure that the generated metrics files don't include options and have valid events yaml data
  3. To make sure the metric config is valid, you can also try calculating the metric in the rails console by passing its key_path attribute in this command: Gitlab::Usage::ServicePing::InstrumentedPayload.new([key_path], :with_value).build. This should not raise any errors and return the correct value for given events config.
Edited by Michał Wielich

Merge request reports