Add dashboard uid generation helper

[sed-i]

Issue

• Currently it is not possible to auto generate dashboard uid consistently without code duplication in GrafanaDashboardProvider and COSAgentProvider.
• The "GrafanaDashboard" class has a confusing terminology: "serialize" and "deserialize" are inconsistent.

Solution

New function for rendering dashboard uid

In tandem with:

• Automatically overwrite dashboard UIDs with a prescribed naming pattern, on the provider side grafana-k8s-operator#363
• Automatically overwrite dashboard UIDs with a prescribed naming pattern grafana-agent-operator#224
• Replace GrafanaDashboard with LZMABase64 grafana-agent-k8s-operator#337

Extract LZMA base64 logic from GrafanaDashboard class

Also, deprecate the GrafanaDashboard class.

The new LZMABase64 class is consistent with the following view:

graph LR

dict -->|serialize| json-str
json-str -->|deserialize| dict

json-str -->|compress + base64 encode| compressed-str
compressed-str -->|base64 decode + decompress| json-str

Loading

Context

This change was prompted by an ADR for addressing dashboard UID collisions.

Testing Instructions

This is an ops-independent change. See unit tests.

Upgrade Notes

If dependent code is using grafana_dashboard.GrafanaDashboard, a deprecation warning will now be printed. Switch to using LZMABase64.

[MichaelThamm]

Looks great to me!