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

Added 'Mimir / Overview networking' dashboard #3487

Merged
merged 2 commits into from Nov 22, 2022

Conversation

pracucci
Copy link
Collaborator

@pracucci pracucci commented Nov 22, 2022

What this PR does

Following up the work done in #3481, in this PR I'm proposing the dashboard "Overview networking" which aims to provide an high level view over a Mimir cluster networking, grouping components into "Writes", "Reads" and "Backend".

Note to reviewers:

  • The dashboard itself is trivial, but I took the opportunity to do some refactoring in the config jsonnet and introduce componentNameRegexp and component_groups used to define (a) the mapping between a component name and the deployment/pod prefix/container (they all match in our jsonnet and Helm) and (b) the list of components belonging to each group, respectively.
  • A preview of the dashboard is at docs/sources/operators-guide/monitor-grafana-mimir/dashboards/overview-networking/mimir-overview-networking.png

This PR is expected to be a no-op for any other dashboards.

Which issue(s) this PR fixes or relates to

Part of #3361

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

@pracucci pracucci marked this pull request as ready for review November 22, 2022 10:45
@pracucci pracucci requested review from a team as code owners November 22, 2022 10:45
@osg-grafana osg-grafana added the type/docs Improvements or additions to documentation label Nov 22, 2022
Copy link
Contributor

@dimitarvdimitrov dimitarvdimitrov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I left a nitpick about making a field a variable, but happy to merge as-is too

operations/mimir-mixin/config.libsonnet Outdated Show resolved Hide resolved
Signed-off-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Marco Pracucci <marco@pracucci.com>
@pracucci pracucci force-pushed the add-overview-networking-dashboard branch from 1b8abff to f021c78 Compare November 22, 2022 14:05
Copy link
Contributor

@dimitarvdimitrov dimitarvdimitrov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@pracucci pracucci merged commit d7b5e1b into main Nov 22, 2022
@pracucci pracucci deleted the add-overview-networking-dashboard branch November 22, 2022 16:02
masonmei pushed a commit to udmire/mimir that referenced this pull request Dec 16, 2022
* Added 'Mimir / Overview networking' dashboard

Signed-off-by: Marco Pracucci <marco@pracucci.com>

* Do not expose component groups config

Signed-off-by: Marco Pracucci <marco@pracucci.com>

Signed-off-by: Marco Pracucci <marco@pracucci.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants