Add a version number to metrics dashboard cache keys
What does this MR do?
Out-of-the-box dashboards are defined in the GitLab repository, unlike custom dashboards that are defined in the customer's repository (under .gitlab/dashboards).
All dashboards are cached (using Rails.cache). Custom dashboard caches are refreshed by the Repository model when it detects a change in the .gitlab/dashboards folder.
Out-of-the-box dashboard caches are not refreshed when we modify the files in our repository. This MR adds a version string into the cache key for out-of-the-box dashboards. Changing this version string results in a new cache key. This gives us a mechanism to force cache refreshes when we update out-of-the-box dashboards.
The version string holds a SHA256 hash of the content of the dashboard file.
Issue: #216022 (closed)
Screenshots
Does this MR meet the acceptance criteria?
Conformity
-
Changelog entry -
Documentation (if required) -
Code review guidelines -
Merge request performance guidelines -
Style guides -
Database guides -
Separation of EE specific content
Availability and Testing
-
Review and add/update tests for this feature/bug. Consider all test levels. See the Test Planning Process. -
Tested in all supported browsers -
Informed Infrastructure department of a default or new setting change, if applicable per definition of done
Security
If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:
-
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