chore: Modernize squid-mixin #1526
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,3 +2,4 @@ | |
| vendor | ||
| jsonnetfile.lock.json | ||
| *.zip | ||
| .worktrees | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,14 @@ | ||
| exclusions: | ||
| template-job-rule: | ||
| reason: "Prometheus datasource variable is being named as prometheus_datasource now while linter expects 'datasource'" | ||
| panel-datasource-rule: | ||
| reason: "Modern mixins use signal-based architecture where datasource references are handled by the framework" | ||
| template-datasource-rule: | ||
| reason: "Based on new convention we are using variable names prometheus_datasource and loki_datasource where as linter expects 'datasource'" | ||
| template-instance-rule: | ||
| reason: "Based on new convention we are using variable names prometheus_datasource and loki_datasource where as linter expects 'datasource'" | ||
| panel-units-rule: | ||
| reason: "Custom units are used for better user experience in these panels" | ||
| entries: | ||
| - panel: "Client request errors" | ||
| - panel: "Server request errors" | ||
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,16 +1,41 @@ | ||||||
| { | ||||||
| local this = self, | ||||||
|
|
||||||
| // Basic filtering | ||||||
| filteringSelector: 'job=~"$job", instance=~"$instance"', | ||||||
|
Contributor
There was a problem hiding this comment. I think this is the incorrect filtering selector. I believe its default should probably be
Suggested change
|
||||||
| groupLabels: ['job'], | ||||||
| instanceLabels: ['instance'], | ||||||
|
|
||||||
| // Dashboard settings | ||||||
| dashboardTags: ['squid'], | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
| dashboardPeriod: 'now-1h', | ||||||
| dashboardTimezone: 'default', | ||||||
| dashboardRefresh: '1m', | ||||||
| uid: 'squid', | ||||||
| dashboardNamePrefix: 'Squid', | ||||||
|
|
||||||
| // Logs configuration | ||||||
| enableLokiLogs: true, | ||||||
| logLabels: ['job', 'instance', 'filename'], | ||||||
| extraLogLabels: [], | ||||||
| logsVolumeGroupBy: 'level', | ||||||
| showLogsVolume: true, | ||||||
|
|
||||||
| // Multi-cluster support | ||||||
| enableMultiCluster: false, | ||||||
| multiclusterSelector: if self.enableMultiCluster then 'job=~"$job", cluster=~"$cluster"' else 'job=~"$job"', | ||||||
|
|
||||||
| // Alert thresholds | ||||||
| alertsCriticalHighPercentageRequestErrors: 5, // % | ||||||
| alertsWarningLowCacheHitRatio: 85, // % | ||||||
|
|
||||||
| // Metrics source | ||||||
| metricsSource: 'prometheus', | ||||||
|
|
||||||
| // Signal definitions | ||||||
| signals: { | ||||||
| client: (import './signals/client.libsonnet')(this), | ||||||
| server: (import './signals/server.libsonnet')(this), | ||||||
| serviceTime: (import './signals/service_time.libsonnet')(this), | ||||||
| }, | ||||||
| } | ||||||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| local g = import './g.libsonnet'; | ||
| local commonlib = import 'common-lib/common/main.libsonnet'; | ||
|
|
||
| { | ||
| local root = self, | ||
| new(this): | ||
| local prefix = this.config.dashboardNamePrefix; | ||
| local links = this.grafana.links; | ||
| local tags = this.config.dashboardTags; | ||
| local uid = this.config.uid; | ||
| local vars = commonlib.variables.new( | ||
| filteringSelector=this.config.filteringSelector, | ||
| groupLabels=this.config.groupLabels, | ||
| instanceLabels=this.config.instanceLabels, | ||
| varMetric='squid_server_http_requests_total', | ||
| customAllValue='.+', | ||
| enableLokiLogs=this.config.enableLokiLogs, | ||
| ); | ||
| local annotations = {}; | ||
| local refresh = this.config.dashboardRefresh; | ||
| local period = this.config.dashboardPeriod; | ||
| local timezone = this.config.dashboardTimezone; | ||
|
|
||
| { | ||
| 'squid-overview.json': | ||
| g.dashboard.new(prefix + ' overview') | ||
| + g.dashboard.withDescription('') | ||
| + g.dashboard.withPanels( | ||
| g.util.panel.resolveCollapsedFlagOnRows( | ||
| g.util.grid.wrapPanels( | ||
| [ | ||
| this.grafana.rows.clientRow, | ||
| this.grafana.rows.serverRow, | ||
| ] | ||
| + | ||
| if this.config.enableLokiLogs then | ||
|
Contributor
There was a problem hiding this comment. I think we should be using the logs-lib library here instead of combined logs/metrics panels. |
||
| [this.grafana.rows.logsRow] | ||
| else | ||
| [] | ||
| ) | ||
| ) | ||
| ) | ||
| + root.applyCommon( | ||
| vars.multiInstance, | ||
| uid + '-overview', | ||
| tags, | ||
| links, | ||
| annotations, | ||
| timezone, | ||
| refresh, | ||
| period | ||
| ), | ||
| }, | ||
|
|
||
| applyCommon(vars, uid, tags, links, annotations, timezone, refresh, period): | ||
| g.dashboard.withTags(tags) | ||
| + g.dashboard.withUid(uid) | ||
| + g.dashboard.withLinks([links[key].asDashboardLink() for key in std.objectFields(links)]) | ||
| + g.dashboard.withTimezone(timezone) | ||
| + g.dashboard.withRefresh(refresh) | ||
| + g.dashboard.time.withFrom(period) | ||
| + g.dashboard.withVariables(vars) | ||
| + g.dashboard.withAnnotations(std.objectValues(annotations)), | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is wrong. Ideally our refactor shouldn't really touch the .lint file