-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add Kyverno monitoring alerts and update documentation #6
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
a91b146
feat: add Kyverno monitoring alerts and update documentation
filippolmt 583ba11
fix example
filippolmt 40dad8f
feat: enhance Kyverno monitoring configuration with notification enab…
filippolmt 717a669
feat: update Kyverno monitoring configuration and improve Makefile fo…
filippolmt 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
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
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
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,29 @@ | ||
|
|
||
| variable "project" { | ||
| type = string | ||
| default = "" | ||
| variable "project_id" { | ||
| description = "The Google Cloud project ID where logging exclusions will be created" | ||
| type = string | ||
| } | ||
|
|
||
| variable "notification_channels" { | ||
| type = list(string) | ||
| default = [] | ||
| description = "List of notification channel IDs to notify when an alert is triggered" | ||
| type = list(string) | ||
| default = [] | ||
| } | ||
|
|
||
| variable "kyverno" { | ||
| description = "Configuration for Kyverno monitoring alerts. Allows customization of cluster name, project, notification channels, alert documentation, metric thresholds, auto-close timing, enablement, extra filters, and namespace." | ||
| type = object({ | ||
| cluster_name = string | ||
| project_id = optional(string, null) | ||
| notification_channels = optional(list(string), []) | ||
| logmatch_notification_rate_limit = optional(string, "300s") | ||
| alert_documentation = optional(string, null) | ||
| use_metric_threshold = optional(bool, false) | ||
| metric_threshold_count = optional(number, 2) | ||
| metric_lookback_minutes = optional(number, 1) | ||
| auto_close_seconds = optional(number, 3600) | ||
| enabled = optional(bool, true) | ||
| filter_extra = optional(string, "") | ||
| namespace = optional(string, "kyverno") | ||
| }) | ||
| } | ||
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,118 @@ | ||
| locals { | ||
| kyverno_project_id = var.kyverno.project_id != null ? var.kyverno.project_id : var.project_id | ||
| alert_documentation = var.kyverno.alert_documentation != null ? var.kyverno.alert_documentation : "Kyverno controllers produced ERROR logs in namespace ${var.kyverno.namespace}." | ||
| kyverno_notification_channels = var.kyverno.notification_enabled ? (length(var.kyverno.notification_channels) > 0 ? var.kyverno.notification_channels : var.notification_channels) : [] | ||
andypanix marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| kyverno_log_filter = <<-EOT | ||
| resource.type="k8s_container" | ||
| resource.labels.project_id="${local.kyverno_project_id}" | ||
| resource.labels.cluster_name="${var.kyverno.cluster_name}" | ||
| resource.labels.namespace_name="${var.kyverno.namespace}" | ||
| severity>=ERROR | ||
| ( | ||
| labels."k8s-pod/app_kubernetes_io/component"=~"(admission-controller|background-controller|cleanup-controller|reports-controller)" | ||
| OR resource.labels.pod_name=~"kyverno-(admission|background|cleanup|reports)-controller-.*" | ||
| ) | ||
| ${trimspace(var.kyverno.filter_extra)} | ||
| EOT | ||
|
|
||
| kyverno_metric_name = lower(replace( | ||
| "kyverno_error_logs_count_${var.kyverno.cluster_name}_${var.kyverno.namespace}", | ||
| "/[^a-zA-Z0-9_]/", "_" | ||
| )) | ||
| } | ||
|
|
||
| resource "google_monitoring_alert_policy" "kyverno_logmatch_alert" { | ||
| count = ( | ||
| var.kyverno.enabled | ||
andypanix marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| && !var.kyverno.use_metric_threshold | ||
| && trimspace(var.kyverno.cluster_name) != "" | ||
| ) ? 1 : 0 | ||
|
|
||
| display_name = "Kyverno controllers ERROR logs (namespace=${var.kyverno.namespace})" | ||
| combiner = "OR" | ||
| enabled = var.kyverno.enabled | ||
|
|
||
| conditions { | ||
| display_name = "Kyverno ERROR in logs" | ||
| condition_matched_log { | ||
| filter = local.kyverno_log_filter | ||
| } | ||
| } | ||
|
|
||
| documentation { | ||
| content = local.alert_documentation | ||
| mime_type = "text/markdown" | ||
| } | ||
|
|
||
| notification_channels = local.kyverno_notification_channels | ||
|
|
||
| alert_strategy { | ||
| auto_close = "${var.kyverno.auto_close_seconds}s" | ||
| notification_rate_limit { | ||
| period = var.kyverno.logmatch_notification_rate_limit | ||
| } | ||
| } | ||
| } | ||
|
|
||
| resource "google_logging_metric" "kyverno_error_metric" { | ||
| count = ( | ||
| var.kyverno.enabled | ||
| && var.kyverno.use_metric_threshold | ||
| && trimspace(var.kyverno.cluster_name) != "" | ||
| ) ? 1 : 0 | ||
|
|
||
| name = local.kyverno_metric_name | ||
| description = "Count of ERROR+ logs from Kyverno controllers in namespace ${var.kyverno.namespace}" | ||
| filter = local.kyverno_log_filter | ||
|
|
||
| metric_descriptor { | ||
| metric_kind = "DELTA" | ||
| value_type = "INT64" | ||
| unit = "1" | ||
| } | ||
| } | ||
|
|
||
| resource "google_monitoring_alert_policy" "kyverno_metric_threshold_alert" { | ||
| count = ( | ||
| var.kyverno.enabled | ||
| && var.kyverno.use_metric_threshold | ||
| && trimspace(var.kyverno.cluster_name) != "" | ||
| ) ? 1 : 0 | ||
|
|
||
| display_name = "Kyverno ERROR rate alert (namespace=${var.kyverno.namespace})" | ||
| combiner = "OR" | ||
| enabled = var.kyverno.enabled | ||
|
|
||
| conditions { | ||
| display_name = "Kyverno ERROR rate alert >= ${var.kyverno.metric_threshold_count} logs in ${var.kyverno.metric_lookback_minutes} min (namespace ${var.kyverno.namespace})" | ||
| condition_threshold { | ||
| filter = "metric.type=\"logging.googleapis.com/user/${local.kyverno_metric_name}\" resource.type=\"global\"" | ||
| comparison = "COMPARISON_GE" | ||
| threshold_value = var.kyverno.metric_threshold_count | ||
| duration = "0s" | ||
|
|
||
| aggregations { | ||
| alignment_period = "${var.kyverno.metric_lookback_minutes * 60}s" | ||
| per_series_aligner = "ALIGN_DELTA" | ||
| cross_series_reducer = "REDUCE_SUM" | ||
| group_by_fields = [] | ||
| } | ||
|
|
||
| trigger { | ||
| count = 1 | ||
| } | ||
| } | ||
| } | ||
|
|
||
| documentation { | ||
| content = local.alert_documentation | ||
| mime_type = "text/markdown" | ||
| } | ||
|
|
||
| notification_channels = local.kyverno_notification_channels | ||
|
|
||
| alert_strategy { | ||
| auto_close = "${var.kyverno.auto_close_seconds}s" | ||
| } | ||
| } | ||
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 @@ | ||
|
|
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.
Uh oh!
There was an error while loading. Please reload this page.