Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add config option for disabling reporting #354

Merged
merged 13 commits into from
Nov 18, 2024
Merged

Conversation

sed-i
Copy link
Contributor

@sed-i sed-i commented Nov 2, 2024

Issue

By default, grafana sends out anonymous usage stats. This may be undesired in hardened environments.

Solution

Add charm config option to disable reporting.

  • In grafana's config file, this option is called reporting_enabled (ref), while in grafana-agent there's a cli flag called -disable-reporting. We want to be consistent across charms, as well as use a positive rather than negative term, for simplicity. So we'll go with reporting_enabled everywhere.
  • There is asymmetry between reporting_enabled=true and reporting_enabled=false: when true, we do not render any config, so grafana will use default values; when false, we disable both reporting and plugin update checks. This is desirable because:
    • Having a single config option (at least for now) is a simple solution that covers most use cases.
    • If an admin needs to disable reporting, it is also likely they would like to prevent auto checking for plugin updates.
    • In the future we could add another config option for plugin checks without any breaking changes.

In tandem with:

Fixes #353.

Context

Testing Instructions

Upgrade Notes

charmcraft.yaml Outdated Show resolved Hide resolved
@sed-i sed-i force-pushed the feature/disable_reporting branch from a2d9e0b to 4dc761d Compare November 14, 2024 04:57
@sed-i sed-i marked this pull request as ready for review November 14, 2024 04:58
@sed-i sed-i requested a review from a team as a code owner November 14, 2024 04:58
@sed-i sed-i merged commit 946d39a into main Nov 18, 2024
14 checks passed
@sed-i sed-i deleted the feature/disable_reporting branch November 18, 2024 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add option --disable-reporting to the command line via charm configuration switch
2 participants