Resource: Alerts #297
Merged
Resource: Alerts #297
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
Codecov ReportBase: 88.59% // Head: 88.49% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #297 +/- ##
==========================================
- Coverage 88.59% 88.49% -0.10%
==========================================
Files 46 48 +2
Lines 3709 3939 +230
==========================================
+ Hits 3286 3486 +200
- Misses 423 453 +30
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
quajones
pushed a commit
to quajones/goblet
that referenced
this pull request
Oct 19, 2023
<b>New Alert Resource</b> (closes goblet#278) You can deploy alerts related to your application by using the alert method. Each alert takes a name and a list of conditions. Notification channels can be added to the `alerts.notification_channel` key in `config.json` or explicity in the alert. The base `AlertCondition` class allows you to fully customize your alert based on the fields privided by the [GCP Alert Resource](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.alertPolicies#conditionhttps://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.alertPolicies#condition>) If you do not need a fully customized alert you can use the built in classes for `MetricCondition`, `LogMatchCondition`, and `CustomMetricCondition`. These come with defaults in terms of duration and aggregations, but can be overriden as needed. The `CustomMetricCondition` creates a custom metric based on the filter provided and then creates an alert using that metric. from goblet.resources.alerts import MetricCondition,LogMatchCondition,CustomMetricCondition app = Goblet() # Example Metric Alert for the cloudfunctin metric execution_count with a threshold of 10 app.alert("metric",conditions=[MetricCondition("test", metric="cloudfunctions.googleapis.com/function/execution_count", value=10)]) # Example Log Match metric that will trigger an incendent off of any Error logs app.alert("error",conditions=[LogMatchCondition("error", "severity>=ERROR")]) # Example Metric Alert that creates a custom metric for severe errors with http code in the 500's and creates an alert with a threshold of 10 app.alert("custom",conditions=[CustomMetricCondition("custom", metric_filter='severity=(ERROR OR CRITICAL OR ALERT OR EMERGENCY) httpRequest.status=(500 OR 501 OR 502 OR 503 OR 504)', value=10)])
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.
New Alert Resource (closes #278)
You can deploy alerts related to your application by using the alert method. Each alert takes a name and a list of conditions. Notification channels
can be added to the
alerts.notification_channelkey inconfig.jsonor explicity in the alert. The baseAlertConditionclass allows you tofully customize your alert based on the fields privided by the GCP Alert Resource
If you do not need a fully customized alert you can use the built in classes for
MetricCondition,LogMatchCondition, andCustomMetricCondition. These come withdefaults in terms of duration and aggregations, but can be overriden as needed. The
CustomMetricConditioncreates a custom metric based on the filter provided and thencreates an alert using that metric.