Baremetal dashboards #2657
Merged
Baremetal dashboards #2657
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wilfriedroset
force-pushed
the
baremetal-dashboards
branch
2 times, most recently
from
816b4a1
to
23c6c64
Compare
wilfriedroset
force-pushed
the
baremetal-dashboards
branch
2 times, most recently
from
7ef943a
to
d1be862
Compare
pracucci
approved these changes
Aug 24, 2022
| @@ -78,6 +78,115 @@ | |||
| gateway: helmCompatibleName('(gateway|cortex-gw|cortex-gw).*'), | |||
| }, | |||
|
|
|||
| deployment_type: 'container', | |||
There was a problem hiding this comment.
I would call it kubernetes (instead of kubernetes) since some panels actually use K8S metrics. WDYT?
There was a problem hiding this comment.
indeed, I've made the changes accordingly.
| |||, | ||
| }, | ||
| baremetal: { | ||
| // Somes queries does not makes sens when running mimir on baremetal |
There was a problem hiding this comment.
Suggested change
| // Somes queries does not makes sens when running mimir on baremetal | |
| // Somes queries does not makes sense when running mimir on baremetal |
| resourcesPanelLegend(first_legend):: | ||
| if $._config.deployment_type == 'container' | ||
| then [first_legend, 'limit', 'request'] | ||
| // limit and request does not makes sens when running on baremetal |
There was a problem hiding this comment.
Suggested change
| // limit and request does not makes sens when running on baremetal | |
| // limit and request does not makes sense when running on baremetal |
| @@ -24,6 +24,10 @@ The following table shows the required label names and whether they can be custo | |||
|
|
|||
| For rules and alerts to function properly, you must configure your Prometheus or Grafana Agent to scrape metrics from Grafana Mimir at an interval of `15s` or shorter. | |||
|
|
|||
| ## Deployment type | |||
|
|
|||
| When running Grafana Mimir on baremetal, You can adjust the resulting dashboards via the `deployment_type` field in the mixin configuration. | |||
There was a problem hiding this comment.
Suggested change
| When running Grafana Mimir on baremetal, You can adjust the resulting dashboards via the `deployment_type` field in the mixin configuration. | |
| By default, Grafana Mimir dashboards assume Mimir is deployed in containers orchestrated by Kubernetes. | |
| If you're running Mimir on baremental, you should set the configuration field `deployment_type: 'baremetal'` and [re-compile the dashboards]({{< relref "../installing-dashboards-and-alerts.md" >}}). |
CHANGELOG.md
Outdated
| @@ -20,6 +20,7 @@ | |||
| ### Mixin | |||
|
|
|||
| * [ENHANCEMENT] Dashboards: added support to query-tee in front of ruler-query-frontend in the "Remote ruler reads" dashboard. #2761 | |||
| * [ENHANCEMENT] Dashboards: Introduce support for baremetal deployment. #2657 | |||
There was a problem hiding this comment.
Suggested change
| * [ENHANCEMENT] Dashboards: Introduce support for baremetal deployment. #2657 | |
| * [ENHANCEMENT] Dashboards: Introduce support for baremetal deployment, setting `deployment_type: 'baremetal'` in the mixin `_config`. #2657 |
This is the preliminary step to make room for supporting baremetal deployment dashboards. Signed-off-by: Wilfried Roset <wilfriedroset@users.noreply.github.com>
Queries and their arguments are in different files, hence using mapping for string formating helps for the readability. One other benefit is that it avoid to pass multiple time the same value or to pass exactly the same number of attributes. Signed-off-by: Wilfried Roset <wilfriedroset@users.noreply.github.com>
This is the preliminary step to make room for supporting baremetal deployment dashboards. Signed-off-by: Wilfried Roset <wilfriedroset@users.noreply.github.com>
wilfriedroset
force-pushed
the
baremetal-dashboards
branch
from
d1be862
to
88ffb07
Compare
The following commit introduce the support of baremetal deployment for *resources* dashboards. It's done by completing the hash `resources_panel_series` and `resources_panel_queries`. The promql queries are based on node_exporter. To accommodate panels where the number of query differ we rely on two intermediate functions `resourcesPanelLegend` and `resourcesPanelQueries` who are responsible for returning the proper number of queries/legends. Signed-off-by: Wilfried Roset <wilfriedroset@users.noreply.github.com>
As the dashboards supports both k8s and baremetal deployments, let's use one single term to avoid confusion, hence instanceName. Signed-off-by: Wilfried Roset <wilfriedroset@users.noreply.github.com>
Let's use a more meaning name for the deployment type. The metrics relates to k8s metrics, as such having the value as kubernetes instead of container makes more sense. Signed-off-by: Wilfried Roset <wilfriedroset@users.noreply.github.com>
wilfriedroset
force-pushed
the
baremetal-dashboards
branch
from
88ffb07
to
3e7a8fd
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does
Add support for baremetal deployments for the resources dashboards.
The default remains
deployment_type: 'container', hence the mixin-compiled remains unchanged.To test new dashboards update the configuration to
deployment_type: 'baremetal'then build the mixins.Which issue(s) this PR fixes or relates to
Relates #1642
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]