-
Notifications
You must be signed in to change notification settings - Fork 177
chore: Modernize the Apache CouchDB mixin #1522
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
Open
schmikei
wants to merge
3
commits into
grafana:master
Choose a base branch
from
schmikei:chore/couchdb-modernization
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,26 +1,49 @@ | ||
| { | ||
| _config+:: { | ||
| enableMultiCluster: false, | ||
| couchDBSelector: if self.enableMultiCluster then 'job=~"$job", cluster=~"$cluster"' else 'job=~"$job"', | ||
| multiClusterSelector: 'job=~"$job"', | ||
| local this = self, | ||
| filteringSelector: 'job="integrations/apache-couchdb"', | ||
| groupLabels: ['job', 'couchdb_cluster', 'cluster'], | ||
| logLabels: ['job', 'cluster', 'instance'], | ||
| instanceLabels: ['instance'], | ||
|
|
||
| dashboardTags: ['apache-couchdb-mixin'], | ||
| dashboardPeriod: 'now-1h', | ||
| dashboardTimezone: 'default', | ||
| dashboardRefresh: '1m', | ||
| dashboardTags: ['apache-couchdb-mixin'], | ||
| uid: 'couchdb', | ||
| dashboardNamePrefix: 'Apache CouchDB', | ||
| dashboardPeriod: 'now-1h', | ||
| dashboardTimezone: 'default', | ||
| dashboardRefresh: '1m', | ||
| metricsSource: [ | ||
| 'prometheus', | ||
| /* | ||
| * the prometheusWithTotal is used for backwards compatibility as some metrics are suffixed with _total but in later versions of the couchdb-mixin. | ||
| * i.e. couchdb_open_os_files_total => couchdb_open_os_files | ||
| * This is to ensure that the signals for the metrics that are suffixed with _total continue to work as expected. | ||
| * This was an identified as a noticeable change from 3.3.0 to 3.5.0 | ||
| */ | ||
| 'prometheusWithTotal', | ||
| ], | ||
|
|
||
| //alert thresholds | ||
| alertsCriticalClusterIsUnstable5m: 1, //1 is stable | ||
| alertsWarning4xxResponseCodes5m: 5, | ||
| alertsCritical5xxResponseCodes5m: 0, | ||
| alertsWarningRequestLatency5m: 500, //ms | ||
| alertsCriticalRequestLatency5m: 1000, //ms | ||
| alertsWarningPendingReplicatorJobs5m: 10, | ||
| alertsCriticalCrashingReplicatorJobs5m: 0, | ||
| alertsWarningDyingReplicatorChangesQueues5m: 0, | ||
| alertsWarningCrashingReplicatorConnectionOwners5m: 0, | ||
| alertsWarningCrashingReplicatorConnectionWorkers5m: 0, | ||
| // Logging configuration | ||
| enableLokiLogs: true, | ||
| extraLogLabels: ['level'], | ||
| logsVolumeGroupBy: 'level', | ||
| showLogsVolume: true, | ||
|
|
||
| enableLokiLogs: true, | ||
| //alert thresholds | ||
| alertsCriticalClusterIsUnstable5m: 1, //1 is stable | ||
| alertsWarning4xxResponseCodes5m: 5, | ||
| alertsCritical5xxResponseCodes5m: 0, | ||
| alertsWarningRequestLatency5m: 500, //ms | ||
| alertsCriticalRequestLatency5m: 1000, //ms | ||
| alertsWarningPendingReplicatorJobs5m: 10, | ||
| alertsCriticalCrashingReplicatorJobs5m: 0, | ||
| alertsWarningDyingReplicatorChangesQueues5m: 0, | ||
| alertsWarningCrashingReplicatorConnectionOwners5m: 0, | ||
| alertsWarningCrashingReplicatorConnectionWorkers5m: 0, | ||
|
|
||
| // Signals configuration | ||
| signals+: { | ||
| overview: (import './signals/overview.libsonnet')(this), | ||
| nodes: (import './signals/nodes.libsonnet')(this), | ||
| replicator: (import './signals/replicator.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,107 @@ | ||
| local g = import './g.libsonnet'; | ||
| local logslib = import 'logs-lib/logs/main.libsonnet'; | ||
|
|
||
| { | ||
| local root = self, | ||
|
|
||
| new(this):: | ||
| local prefix = this.config.dashboardNamePrefix; | ||
| local links = this.grafana.links; | ||
| local tags = this.config.dashboardTags; | ||
| local uid = g.util.string.slugify(this.config.uid); | ||
| local vars = this.grafana.variables; | ||
| local annotations = this.grafana.annotations; | ||
| local refresh = this.config.dashboardRefresh; | ||
| local period = this.config.dashboardPeriod; | ||
| local timezone = this.config.dashboardTimezone; | ||
| { | ||
| 'couchdb-overview.json': | ||
| g.dashboard.new(prefix + ' overview') | ||
| + g.dashboard.withPanels( | ||
| g.util.panel.resolveCollapsedFlagOnRows( | ||
| g.util.grid.wrapPanels( | ||
| [ | ||
| this.grafana.rows.overview, | ||
| this.grafana.rows.overviewRequests, | ||
| this.grafana.rows.overviewReplication, | ||
| ] | ||
| ) | ||
| ) | ||
| ) + root.applyCommon( | ||
| vars.multiInstance, | ||
| uid + '_overview', | ||
| tags, | ||
| links { couchdbOverview+:: {} }, | ||
| annotations, | ||
| timezone, | ||
| refresh, | ||
| period | ||
| ), | ||
|
|
||
| 'couchdb-nodes.json': | ||
| g.dashboard.new(prefix + ' nodes') | ||
| + g.dashboard.withPanels( | ||
| g.util.panel.resolveCollapsedFlagOnRows( | ||
| g.util.grid.wrapPanels( | ||
| [ | ||
| this.grafana.rows.nodes, | ||
| this.grafana.rows.nodeRequests, | ||
| this.grafana.rows.nodeLogs, | ||
| ], | ||
| ), | ||
| ), | ||
| ) + root.applyCommon( | ||
| vars.multiInstance, | ||
| uid + '_nodes', | ||
| tags, | ||
| links { couchdbNodes+:: {} }, | ||
| annotations, | ||
| timezone, | ||
| refresh, | ||
| period | ||
| ), | ||
|
|
||
| } | ||
| + if this.config.enableLokiLogs then { | ||
| 'couchdb-logs.json': | ||
| logslib.new( | ||
| prefix + ' logs', | ||
| datasourceName=this.grafana.variables.datasources.loki.name, | ||
| datasourceRegex=this.grafana.variables.datasources.loki.regex, | ||
| filterSelector=this.config.filteringSelector, | ||
| labels=this.config.groupLabels + this.config.extraLogLabels, | ||
| formatParser=null, | ||
| showLogsVolume=this.config.showLogsVolume, | ||
| ) | ||
| { | ||
| dashboards+: | ||
| { | ||
| logs+: | ||
| root.applyCommon(super.logs.templating.list, uid=uid + '-logs', tags=tags, links=links { couchdbLogs+:: {} }, annotations=annotations, timezone=timezone, refresh=refresh, period=period), | ||
| }, | ||
| panels+: | ||
| { | ||
| logs+: | ||
| g.panel.logs.options.withEnableLogDetails(true) | ||
| + g.panel.logs.options.withShowTime(false) | ||
| + g.panel.logs.options.withWrapLogMessage(false), | ||
| }, | ||
| variables+: { | ||
| toArray+: [ | ||
| this.grafana.variables.datasources.prometheus { hide: 2 }, | ||
| ], | ||
| }, | ||
| }.dashboards.logs, | ||
| } | ||
| else {}, | ||
|
|
||
| applyCommon(vars, uid, tags, links, annotations, timezone, refresh, period): | ||
| g.dashboard.withTags(tags) | ||
| + g.dashboard.withUid(uid) | ||
| + g.dashboard.withLinks(std.objectValues(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.
Thank you! 🚀
Can you call this out in the readme as well please? E.g. just what versions are supported, and what the different metricSources are for