Releases: target/goalert
v0.33.0
GoAlert v0.33.0
After a significant hiatus since our last release, we're thrilled to announce GoAlert v0.33.0! This release lays the groundwork for some exciting future features while also delivering numerous fixes and stability improvements to enhance your current experience.
GraphQL API Keys
GraphQL API Keys are now fully supported and out of the experimental phase! We've introduced a dedicated editor to manage your API keys more efficiently, simplifying the process of creating, editing, and organizing your keys.
4 PRs by @mastercactapus
- gql-api-keys: only setState once when duplicating key by @mastercactapus in #3792
- gql-api-keys: Takes GQL API keys out of experimental state by @mastercactapus in #3797
- gqlapi: Ensure stable hash for API key policy by @mastercactapus in #3941
- admin/apikeys: add CodeMirror editor for editing keys by @mastercactapus in #4149
Alert Metadata
Introducing Alert Metadata: You can now attach arbitrary key-value metadata to alerts, enhancing the context and flexibility of your alerting workflow. This feature allows for more detailed and informative alerts, facilitating better incident management.
To add metadata to an alert, include it in your request parameters or JSON body. For example:
Via URL parameters:
bash
Copy code
/api/v2/generic/incomming?token=<token>&meta=example_key=example_value&meta=example_key2=example_value2
Or in a JSON body:
{
"summary": "test",
"details": "test",
"meta": {
"example_key": "example_value",
"example_key2": "example_value2"
}
}
Refer to the documentation (/docs
) on your GoAlert instance for more details.
1 PR by @shivanishendge
- Add alert metadata by @shivanishendge in #3764
Miscellaneous Enhancements
We've introduced several improvements to enhance usability and reliability:
-
Custom End Time for Service Maintenance Mode: You can now specify a custom end time when putting a service into maintenance mode, giving you more control over maintenance scheduling.
-
Externally Managed Integration Keys: Integration keys can now be marked as "externally managed," allowing seamless integration with external systems that manage keys.
-
Improved SMTP Reliability: The remote monitor will now retry sending emails if the SMTP server is unavailable, increasing the robustness of email notifications.
3 PRs by @mastercactapus, @nimjor
- service maint: allow specifying a custom end time by @mastercactapus in #3815
- int keys: Add support for externally-managed integration keys by @mastercactapus in #3818
- add smtp retries by @nimjor in #4115
Bug Fixes
This release includes numerous UI bug fixes and log improvements to enhance stability and user experience. We've addressed issues related to alert details, markdown links, schedule notifications, and more, reducing log noise and fixing various edge-case bugs.
20 PRs by @Forfold, @allending313, @cuishuang, @mastercactapus
- fix: alert detail markdown link bug by @allending313 in #3683
- util/Markdown: fix handling of links with URL-escapable characters by @mastercactapus in #3721
- sched/notif: retain time and weekday filter if swapping radio options by @mastercactapus in #3741
- graphql: Convert empty UUID strings to NullUUID by @mastercactapus in #3744
- intkeys: fix site24x7 label bug by @mastercactapus in #3763
- graphql: use tx with create alert by @mastercactapus in #3776
- util/sqlutil: fix handling of block delimiters in SplitQuery by @mastercactapus in #3775
- engine/statusmgr: Skip status updates without an associated log entry by @mastercactapus in #3794
- webworker: add check on worker method name by @mastercactapus in #3795
- profile: fix flicker when opening dialogs by @mastercactapus in #3790
- ui/list: padding and console fixes by @Forfold in #3850
- list pages: fix conditional create button rendering by @mastercactapus in #3855
- ui: fix step number display for EP step delay text by @Forfold in #3916
- ui: fix edit empy temp sched bug by @Forfold in #4019
- Fix no-rows bug with last message status by @mastercactapus in #4061
- test contact method: Fix verification dialog, and refactor send test dialog by @mastercactapus in #4062
- fix: fix slice init length by @cuishuang in #4090
- log: cleanup erroneous log messages by @mastercactapus in #4122
- util/timeutil: Ensure exponents are never encoded into the output String() by @mastercactapus in #4123
- engine: update advisory lock handling and add locked transaction support by @mastercactapus in #4152
Admin Features
Pprof Profiling Support
Administrators can now create Go pprof
profiles for performance analysis. By setting the --listen-pprof
flag, you can access profiling data to help diagnose and optimize GoAlert's performance.
1 PR by @mastercactapus
- Pprof endpoint by @mastercactapus in #3686
Future Features
A significant portion of this release is dedicated to laying the groundwork for upcoming major features:
- Programmable Integration Keys
- Plugin System for Outgoing Messages
- Job Queue System for Processing Tasks
Universal Integration Keys (Experimental)
We are excited to introduce Universal Integration Keys, currently available behind the univ-keys
experimental flag. This powerful feature allows you to use Expr expressions to define custom rules for handling incoming messages, providing unprecedented flexibility in configuring alert processing.
With Universal Integration Keys, you can programmatically control how alerts are created, modified, or suppressed based on dynamic conditions. Additionally, you can send "signals" for less critical payloads and pipe a request directly to a Slack message, for example.
For more information, please refer to the Universal Integration Keys documentation.
33 PRs by @Forfold, @mastercactapus
- univ-keys: add Expr <-> Condition support by @mastercactapus in #3778
- add type universal to integration keys by @Forfold in #3836
- intkey: update old code to use API-driven key types by @mastercactapus in #3837
- ui: add route for universal integration keys by @Forfold in #3838
- uik: add basic CRUD operations by @mastercactapus in #3847
- expr: use scalar GraphQL types to handle validation by @mastercactapus in #3849
- ui: update breadcrumbs to handle doubly nested routes by @Forfold in #3848
- uik: add bounds/limits on int key config by @mastercactapus in #3851
- uik: add token generation and rotation by @mastercactapus in #3873
- uik: add deleteSecondaryToken mutation by @mastercactapus in #3877
- uik: add methods of updating single rules by @mastercactapus in #3880
- uik: implement new endpoint and authorization by @mastercactapus in #3879
- uik: add token rotation dialogs and controls by @mastercactapus in #3894
- uik: add dynamic actions api by @mastercactapus in #3898
- ui: add DynamicActionField component by @mastercactapus in #3909
- uik: switch from global to per-rule continue option by @mastercactapus in #3924
- dest/action: simplify error flow in forms by @mastercactapus in #3926
- Update DynamicParams to use ExprStringMap by @mastercactapus in #3944
- Add Universal Key Actions management forms by @mastercactapus in #3945
- Add default action edit and rule management dialogs by @mastercactapus in #3946
- uik: Add a...
v0.32.0
GoAlert v0.32.0
Welcome to the unveiling of GoAlert v0.32.0! This release is a comprehensive package, featuring a range of exciting new features, critical bug fixes, and essential developer improvements to elevate your alert management experience.
Experimental Features
API Key Support
The 'API Keys' feature is currently an experimental feature. To explore this functionality, administrators must opt in by configuring GoAlert with EXPERIMENTAL=gql-api-keys
. As an experimental feature, it may change, and your feedback is appreciated. Caution is advised in production, and expect updates as we refine and enhance its capabilities.
Explore an up-and-coming new feature of GoAlert while it's still in its experimental stage! Once activated, discover the new 'API Keys' option in the admin sidebar, allowing administrators to create and tailor access using GraphQL queries or mutations for a more secure and customizable integration.
More information on implementation details and the decisions around this new feature can be found in an ADR here.
17 PRs by @mastercactapus, @1ddo, @Forfold
- add
listGQLFields
query by @mastercactapus in #3276 - add base admin API key support by @mastercactapus in #3274
- add role to gql api key info by @mastercactapus in #3312
- api key UI by @1ddo in #3324
- Implement Duplicate Functionality for API Keys by @mastercactapus in #3395
- add warning icon, update expires grammar by @Forfold in #3401
- add adr for api key arch by @mastercactapus in #3441
- allow omitting the api key's fixed query by @mastercactapus in #3464
- allow copy as JSON and fix query formatting by @mastercactapus in #3434
- Fix timestamp displays by @mastercactapus in #3415
- Switch policy from
allowedFields
toquery
by @mastercactapus in #3411 - Add integration test for GQL API keys by @mastercactapus in #3400
- Allow entering a query directly to generate Allowed Fields by @mastercactapus in #3370
- only enforce unique name on non-deleted keys by @mastercactapus in #3369
- cache policy info lookup & last usage updates by @mastercactapus in #3291
- add list and update of graphql api keys by @mastercactapus in #3292
- apikey: Fix issue where omitting the
query
field doesn't work by @mastercactapus in #3491
New Features
Monthly Rotations
Simplify your team's schedule with monthly handoffs! The new 'Monthly' option in Rotations enhances scheduling convenience, ensuring smooth handoffs once a month in GoAlert.
2 PRs by @allending313
- add monthly rotation option by @allending313 in #3243
- add monthly rotations UI by @allending313 in #3257
Service Metrics
Elevate service monitoring with new comprehensive metrics in GoAlert. Admins can now keep an eye on service health, check for setup issues, and review notification channels—all in one place for better awareness and management.
5 PRs by @KatieMSB
Full Calendar Subscription
Users can now opt into subscribe to all shifts on a schedule in GoAlert. Get a complete view of your commitments and your teammates for more comprehensive schedule management.
1 PR by @mastercactapus
- Full Schedule Support in Calendar Subscriptions by @mastercactapus in #3289
User Profile Calendar
The user profile page now renders a calendar for all on-call schedule shifts (broken down by schedule)
2 PRs by @Forfold
Misc Improvements
We've made a number of QOL improvements including a new splash screen, fixed favicon, labels are visible on services, and improved timestamp support in markdown.
6 PRs by @Forfold, @mastercactapus
- ui: splash screen from index.html by @Forfold in #3513
- ui: Markdown timestamp support by @mastercactapus in #3558
- add label chips to service details by @mastercactapus in #3530
- ui: update favicon by @Forfold in #3580
- ui/schedules: flip timezone locale for shifts list by @Forfold in #3510
- heartbeats: Add support for specifying additional details by @mastercactapus in #3559
Admin Options
There were a few new config options and tweaks added for admins, like requiring labels on services and closing stale alerts.
4 PRs by @mastercactapus
- config: add Service.RequiredLabels by @mastercactapus in #3531
- config: Add option to auto-close acked alerts by @mastercactapus in #3604
- prometheus: add service_id to created alerts and sent notification counters by @mastercactapus in #3603
- statusmgr: expire status subscriptions after 7 days by @mastercactapus in #3610
Bug Fixes
Temporary Schedules Improvements
A number of bug fixes for the Temporary Schedules features have been addressed and some new features!. Soft limits for start and end dates provide better control, default values are now set accurately, and temporary schedules seamlessly merge as intended.
Schedules are now broken down by a default shift length, and while custom shifts remain supported, this intends to make it easier to create and manage even handoffs amongst team members.
Additionally, if you need to edit a temporary schedule, you will now be prompted to confirm the changes, so you know EXACTLY what is being changed before saving!
6 PRs by @mastercactapus, @Forfold, @KatieMSB
- Add soft limits for min and max, apply to override and temp sched by @mastercactapus in #3474
- fix default value not set for temp sched dialog by @Forfold in #3380
- fix soft limits while typing by @mastercactapus in #3478
- Fix schedule not merging bug by @KatieMSB in #3473
- ui/schedules: create confirmation component for editing a temporary schedule by @Forfold in #3561
- ui/temp-sched: Add fixed shifts for temporary schedules by @KatieMSB in #3606
Misc Bug Fixes
Lots of bugs were squashed in this update to improve the overall GoAlert experience! Enhancements include improved linter and formatting, optimized search functionalities, enhanced concurrency and performance, streamlined dependency management, meticulous timestamp handling, and robust error handling.
20 PRs by @mastercactapus, @Forfold, @KatieMSB
- increase linter timeout by @mastercactapus in #3280
- preserve line breaks in markdown by @mastercactapus in #3344
- limit HistoryBySchedule to 3 concurrent calls by @mastercactapus in #3334
- use static query for override search by @mastercactapus in #3317
- resolve circular dependency in make db-schema target...
v0.31.1
GoAlert v0.31.1
This point release fixes some regressions present in the v0.31.0 release. Additionally, containers and binaries for this version were built with Go 1.21.1.
Bug Fixes
- Fixed issue with SMTP server when multiple RCPT TO addresses were sent
- Added a missing column for the alerts feature that prevented switchover from working properly
- Fixed an issue that prevented adding webhooks to escalation policies when Slack is disabled
- Fixed search behavior when matching multiple words
4 PRs by @andrewbenington and @mastercactapus
- fix: prefix search by @andrewbenington in #3234
- smtpsrv: return proper errors and limit RCPT TO by @mastercactapus in #3251
- swo: add missing id column to alert_feedback by @mastercactapus in #3256
- ep: fix webhook expansion when slack is disabled by @mastercactapus in #3264
Misc
- The Google Analytics feature was re-introduced and updated
- Dependency and driver updates
- New TypeScript conversion
6 PRs by @mastercactapus, @Forfold, @leyasalazar, and @KatieMSB
- dev: update sqlc to latest version (1.20.0) by @mastercactapus in #3244
- ui/deps: upgrade mui packages to latest by @Forfold in #3253
- dev: update all devtools to use pgx v5 by @mastercactapus in #3255
- ui/components: Convert NewUserSetUp to ts by @leyasalazar in #3242
- feat: add google analytics support by @KatieMSB in #3254
- db: switch driver to pgx5 by @mastercactapus in #3258
Full Changelog: v0.31.0...v0.31.1
v0.31.0
GoAlert v0.31.0
Unveiling the latest GoAlert update with enhanced alert tracking, seamless system migration, and more. Experience greater control and efficiency in your alert management.
Container image: goalert/goalert:v0.31.0
New Features
Alert Noise Tracking
Users may now mark alerts as "noisy" and see the overall counts and escalations on the Alert Metrics page.
2 PRs by @Forfold
Message Logs Frequency Graph
There is now a graph to visualize sent messages:
3 PRs by @Forfold and @mastercactapus
Switchover UI
You can now migrate a live system from one DB server to another without downtime.
More information is available in the Switchover Guide.
3 PRs by @mastercactapus
- switchover: refactor and move SWO toolset to UI by @mastercactapus in #2523
- swo: add guide and in-app documentation by @mastercactapus in #3246
- swo: Polish the guide/documentation rendering by @mastercactapus in #3247
Email Integration Keys via Built-In SMTP
Alerts created by email are now supported by pointing an MX record directly to GoAlert documentation available here.
Set/Update User Password
Users and admins are now able to update passwords from the UI
2 PRs by @allending313
- auth/basic: add
createBasicAuth
andupdateBasicAuth
for managing Basic credentials via GraphQL by @allending313 in #3062 - ui/user: Allow setting/changing basic auth passwords in UI by @allending313 in #2991
Slack DM Contact Method
Users can now add Slack direct messages as a contact method on their profile when Slack is enabled.
9 PRs by @mastercactapus
- slack: add new contact method type for direct messages (experimental) by @mastercactapus in #2805
- slack: add UI for Slack DM contact method type (experimental) by @mastercactapus in #2815
- slack-dm: add compat module by @mastercactapus in #2821
- slack-dm: fix dm message updates by @mastercactapus in #2864
- slack: fix DM display and pending state by @mastercactapus in #2890
- slack: Add smoketest for Slack DM notificaitons by @mastercactapus in #3047
- fix slack dm status updates by @mastercactapus in #3060
- status updates: switch to per-contact-method behavior by @mastercactapus in #2824
- expflag: remove slack-dm flag by @mastercactapus in #3071
Alert Auto-Close
You can now set a global auto-close time for unacknowledged alerts under Maintenance on the Admin -> Config page.
1 PR by @Lakshmi2107
- admin: add alert auto-close feature by @Lakshmi2107 in #2660
Twilio Voice Customization
Configuring the Twilio voice name and language from the admin panel is now possible.
2 PRs by @AlaricWhitney
- feat: Adding more natural sounding voices to phone calls by @AlaricWhitney in #2575
- feat: breaking out voice calls into a testable function by @AlaricWhitney in #2768
Webhook Support
Webhooks can now be set as a destination for scheduled on-call notifications and directly on an escalation policy step! Additionally, the service name is now included for alerts.
8 PRs by @allending313, @andrewbenington, and @nataliekorzh
- feat: adding webhooks as a notification channel type by @nataliekorzh in #2809
- feat: add UI for chanWebhooks escalation policy step option by @nataliekorzh in #2871
- fix: webhook check on edit escalation policy step by @andrewbenington in #3040
- feat: webhook on call notification by @andrewbenington in #3036
- feat: add happy path integration test for on call notification webhook by @allending313 in #3155
- feat: add smoke test for on call notification webhooks by @allending313 in #3162
- feat: remove webhook exp flag by @allending313 in #3168
- feat: add service name/id field to webhook alerts by @allending313 in #3199
Escalate via Voice and SMS
You can now escalate an alert by voice and SMS.
1 PR by @Lakshmi2107
- Feature/escalate via ivr by @Lakshmi2107 in #2818
Update Slack Usergroup
Slack usergroups can now automatically be updated by setting an on-call notification on a schedule!
10 PRs by @allending313, @andrewbenington, @Forfold, and @mastercactapus
- slack: allow saving user group ID to schedule notification rules by @mastercactapus in #2882
- slack: add user group queries to graphql schema by @mastercactapus in #2907
- slack: update user-group membership for configured schedules by @mastercactapus in #2926
- ui: add slack user groups to on call notifications by @Forfold in #2932
- migrate: move user group migration to latest by @mastercactapus in #3012
- slack: use usergroup handle instead of name by @mastercactapus in #3037
- feat: on call notification channel separation by @andrewbenington in #3046
- feat: add integration test for slack usergroup feat by @allending313 in #3129
- feat: add happy path smoke test for slack user groups by @allending313 in #3137
- chore: remove slack usergroup exp flag by @allending313 in #3144
Generic Alert API
It is now possible to get the alert and service ID when creating an alert via a Generic API key by setting the Accept
header to application/json
1 PR by @sudhabindu-apm
- sending alert object as create alert response body by @sudhabindu-apm in #3124
Backend & API
We hardened security, expanded maintenance mode, and fixed some cleanup issues.
6 PRs by @cmarquis, @mastercactapus, and @theautoroboto
- user/cm: cleanup unverified contact methods by @cmarquis in #2764
- auth: set SameSite to strict on session cookie by @mastercactapus in #3111
- auth: Validate redir on return from auth by @mastercactapus in #3114
- auth: use samesite=lax for oauth cookies by @mastercactapus in #3158
- feat: extending maintenance allowance through API by @theautoroboto in #3160
- twilio: always use messaging SID if set by @mastercactapus in #3165
Improvements
We moved the add buttons on wide-screen devices from a floating-action button to a named button at the top to reduce confusion for new users.
7 PRs by @Forfold
- ui: move profile add buttons ...
v0.30.1
GoAlert v0.30.1
Minor release with bug and stability fixes for peak season.
Notable Changes
- This release is built with Go 1.19.3
- You can now search by integration key on the Services list page (by @KatieMSB in #2587)
- The admin Message Log is now paginated, fixing a long-standing issue where it was unusable with large numbers of recent messages (by @Forfold in #2644)
Misc Fixes
- ui: fix drag and drop in FlatList while in strict mode by @Forfold in #2413
- admin: fix breadcrumb and page title formatting by @mastercactapus in #2632
- GraphQL: serviceID should be optional by @theautoroboto in #2640
- heartbeat-ui: force refetch of service info (incl. hb list) on create by @mastercactapus in #2642
- ui/wizard: fix wizard character limit by @tony-tvu in #2515
- testing: add Fuzz tests by @mastercactapus in #2664
- admin: add pagination to message logs query by @Forfold in #2644
Dev Improvements
- dev: playwright mvp by @mastercactapus in #2608
- dev: use podman manifest for container build by @mastercactapus in #2624
- feat: Added help and cleaned up makefile by @AlaricWhitney in #2648
- dev: generate outgoing messages by @mastercactapus in #2649
- ui/lists: use component type for create dialogs by @tony-tvu in #2467
- ui/services: convert ServiceDetails to ts by @tony-tvu in #2572
- ui/services: convert ServiceDeleteDialog to ts by @tony-tvu in #2566
- ui/services: convert IntegrationKeyDeleteDialog to ts by @tony-tvu in #2569
- ui/services: convert IntegrationKeyCreateDialog & IntegrationKeyList to ts by @tony-tvu in #2568
New Contributors
- @theautoroboto made their first contribution in #2640
Full Changelog: v0.30.0...v0.30.1
v0.30.0
GoAlert v0.30.0
This version has many improvements and features that have been in the works for a while for users, admins, and developers!
In addition to the binary release below, this release is also available in container image form: goalert/goalert:v0.30.0
Note to Admins: Public URL Configuration is Changing
First and foremost, no breaking changes. Without configuration updates, the new version should behave like the old. However, the global Public URL config is now deprecated.
We added a new --public-url
flag (or GOALERT_PUBLIC_URL
env var), which is now the preferred way to configure the public address for things like auth, Twilio/Slack callbacks, SMS URLs, and redirects. You should test and update your environments accordingly. Most users can simply start GoAlert with --public-url
set to their current Public URL config value; additional notes are below under "Migration Notes"
Things of note:
- GoAlert will start without the new flag set and fall back to the old behavior. Upgrading to
0.30.0
should be as safe as all other versions with no breaking/behavioral change without explicit opt-in. - The new flag replaces all uses of Public URL (in config under General), Referrer URLs (in config under Auth), and the
--http-prefix
flag. Using it will cause said deprecated settings to be ignored.
This was done to simplify fragile code that caused problems, particularly with various reverse-proxy setups and confusion around deployments behind a route prefix. Redirects and validation no longer use the host header to guess the environment and will always assume it is available at the configured URL.
Migration Notes
- If you have multiple required Auth Referrer URLs, run separate instances connected to the same DB, one for each URL.
- If you are using
--http-prefix
, just ensure the same prefix is set as the path of your--public-url
value
New Paint!
A long time coming, we finally added some color to the application and dark-mode support! Changing the color for yourself from the new settings popover is now possible (can be useful for those that use multiple environments).
- Adds a Current User Avatar to the top app bar. (#2212)
- Adds a button for dark-mode to the user profile. (#2174)
- Adds a color picker to the Theme Mode (now renamed to Appearance) ButtonGroup in the Settings Popover. (#2393)
Slack Account Linking
Slack account linking is finally supported without running the goalert-slack-email-sync
tool. Linking allows a user to close or acknowledge an alert from Slack that previously needed to be maintained by an admin.
When a user attempts to interact with an alert for the first time in Slack, a private message will prompt them to link their account. After confirming in GoAlert, their initial action will be taken (e.g., close or ack), and their account will remain linked for future interactions.
Note: in response to feedback, we've updated the Slack notifier to only include the summary in messages, reducing channel noise.
- Updates the Slack notification sender to only include the summary in the message payload. (#2478)
- Adds the ability to link accounts directly from Slack in response to user interaction (#2564)
Maintenance Mode
We've made it possible to put a service in a temporary maintenance mode, which will still allow alerts to be created/acknowledged/closed but prevents escalations (including the first) so your phone isn't going off while you're working to fix an issue :)
- Adds maintenance mode option to snooze alert notifications (#2512)
Alert Metrics for Services
We've added a metrics page for services so you can visualize alert counts, escalations, and time to acknowledge and close. It also allows you to export up to one year of alert data (including timing information) as a CSV.
You can find Alert Metrics under Quick Links on your service details page.
- Adds Alert Metrics dashboard feature accessible from a Service Details quick link. (#2085)
- Introduces a new engine module for creating and populating a new
alert_metrics
table. (#2177) - Styles the alert metrics graph using our MUI theme and MUI Paper, Typography elements for the graph's tooltip. (#2323)
- Adds a new chart for visualizing time to acknowledge and time to close averages for daily alerts. (#2347)
- Moves graph and CSV processing to a web worker when supported. (#2465)
- Adds escalated alert count to the metrics graph and the information to the table and CSV export. (#2430)
- Adds new
daily_alert_metrics
table that aggregates metrics fromalert_metrics
. (#2272) - Use
alerts
query as the source of truth. Additionally,closedAt
is added to the table and CSV export. (#2448) - Use autosizer for rechart graphs (#2529)
- Adds loading status to web worker (#2542)
Grafana Integration
Grafana Alerting is now supported, along with support for images!
- Adds
ImageURL
to alert details, when available, for Grafana-generated alerts. (#2468) - Adds support for Grafana 8.x webhooks. (#2087)
Admin: Message Logs
A new Message Logs page allows admins to view metadata about recently sent notifications.
- Adds
Outgoing Logs
view from the Admin page. (#2061) - Adds
debugMessages
query that an admin can use to retrieve a list of recent messages from theoutgoing_messages
table. (#2052)
Admin: Alert Counts Visualization
The new Alert Counts page will help admins find "busy" services and correlate high-alert events when necessary.
- Adds records to the
alert_logs
table when runningmake regendb
. (#2150) - Updates
resetdb
to include randomly generated escalation logs. (#2430) - Adds admin Alert Counts page (#2509)
Admin: Twilio Key Rotation
It is now possible to do a smooth key rotation with Twilio:
- Generate secondary auth token
- Set secondary as auth token
- Set primary as alt. auth token
- promote secondary to primary
- clear alt auth token
- Add alternate auth token for use during key rotation (#2588)
Developer Experience Improvements
There is now a Dev link in the main navigation menu when starting in development mode (i.e., make start
), giving quick access to tools and configuration for local development. In addition, there were several process improvements and paid tech debt with this release, such as a huge speed improvement with the switch to esbuild
.
Some of these tools have been available and running with make start
but the new dashboard will hopefully make it a lot easier to discover and use the bundled tools!
- Adds "Dev" page in dev mode (#2555)
- Adds
runproc
tool, a simpler alternative torunjson
. (#2080) - Fixes some noise issues in the
make start
log output. (#2172) - Adds the ability to manipulate time within the confines of a Postgres database. (#2438)
- Updates
build-env
image to have the necessary dependencies to run Cypress tests, allowing all build steps to be run in the same container. (#2400) - Adds a new tool,
slowproxy
that can simulate network latency, jitter, and throughput constraints for testing. (#2307) - Replaces webpack with esbuild for building app.js. (#2314)
- Replaces the use of
webpack-dev-server
and the required proxy with a method that will serve files from the local filesystem or in memory. (#2246) - Removes old GraphQL code that has been deprecated/unmaintained for the past few releases. (#2051)
- Allow setting PUBLIC_URL in dev (#2553)
- Add testing section and move smoketests to
test/smoke
(#2590)
Bug Fixes/Misc
- Fixes an issue where invalid int. keys returned 400 instead of 401 (#2546)
- Add
--public-url
flag and strictly validate URLs (#2421) - Many accessibility improvements & javascript conversions to typescript. (#2318)
- Some deadlock issues around rotations were fixed by introducing rather aggressive locks. (#2491)
- Fix for user deletion causing rotation advancement. (#2375)
- Increase maximum alert summary length to
1 KiB
. (#2073) - Adds alert summary to status update messages. (#2074)
- Increase the calendar subscription window of calculated shifts from 1 month to 1 year. (#2388)
- Removes unmaintained tracing code and dependencies. (#2420)
- Replaces the use of
react-router-dom
withwouter
. (#2415) - Adds support for
application/json
in incoming webhook. (#2161) - Fixes an issue preventing switchover (#2552)
- Fix/cleanup for Go 1.19 (#2563)
- Fix
make start
issue when restarting postgres (#2580) - Allow setting
SIZE=
withmake regendb
to test various data sizes (#2580) - Fixed first-startup race conditions, as well as quick shutdown ones (#2580)
- Add
speedbump
as a devtool to replaceslowproxy
(#2580) - Fixed a display bug with contact method verification when using message SIDs (#2580)
- Update voice code to use
encoding/xml
(#2582) - Update SMS country-c...
v0.29.0
GoAlert v0.29.0
This release includes several new features in addition to general maintenance and bug fixes.
UI/UX Enhancements
- The Application Name (configured in GoAlert admin dashboard) now appears in notifications where applicable. (#1881)
- Text fields now use the Material UI
OutlinedInput
style in anticipation of MUIv5. - Schedule calendars now display events for overrides. (#1901)
- If an alert has been in a pending state for more than 15 seconds, a notice is displayed on the Alert Details page. (#1779)
- Users can favorite other users such that they appear first in lists, much like Schedules or Services. (#1864)
Temporary Schedules
- A general "OVERRIDE" button has replaced the "TEMP SCHED" button located in the Schedule calendar toolbar. To create a Temporary Schedule, click this and select the Temporary Schedule option. (#1857)
- The Temporary Schedules dialog has been consolidated into a single step. (#1912)
- An error is now rendered when trying to create a Temporary Schedule that has gaps in coverage. This error may be bypassed by checking a confirmation checkbox. (#1891)
- Solved an issue in which coverage gap warning notices were rendered erroneously.
Twilio Integration
- Outgoing messages can now be sent using a Messaging Service SID. To enable, set the Twilio Messaging Service SID field in the GoAlert admin dashboard. (#1899)
- The voice menu experience has been improved to have better phrasing, slower speaking, and other minor fixes. (#1918)
Slack Integration
- Alert messages render a colored status bar to indicate whether the alert is unacknowledged, acknowledged, or closed. (#2004)
- Enable "Interactive Messages" from the GoAlert admin dashboard to have alert messages include a button for acknowledging, escalating, or closing the alert. (#2014)
- The Slack App manifest has been updated to include a
users:read.email
permission scope. See the instructions on the Getting Started page for how to configure a Slack App using the generated manifest. (#2025) - Slack users and GoAlert users can now be linked by inserting records into the
auth_subjects
table. This allows for Slack mentions e.g. in On-Call Notifications and interactive messages.
GraphQL API
- A new
debugMessageStatus
query provides the state of a message for a given provider message ID. (#1917)
Bug Fixes/Misc
- An issue with searching for non-English characters was fixed. (#1951)
- Message bundling is enabled by default. (#1942)
- Fixed a UI navigation issue when using an HTTP path prefix. (#1976)
Version Updates:
v0.28.0
GoAlert v0.28.0
This release includes several new features in addition to general maintenance and bug fixes.
Many thanks to our new contributors!
@voromahery
@Voninkazo
@NateBigStone
@ganamavo
@wesley-dean-flexion
Slack Improvements
On-Call notifications
You can now have GoAlert notify Slack channels of on-call changes on a schedule. Notifications can be configured for any change, or at specific times of the day.
Other Improvements
- The config page now has a "Create New Slack App" button that will generate a Slack app manifest pre-filled with GoAlert config
- Alert notifications after the first will be broadcast to the channel from a thread reply (#1566)
- Alerts will now have status updates posted in-thread to the original notification message (#1785)
UI/UX Enhancements
-
Search behavior has changed to use a root-word-based search. For user name searching, a word prefix algorithm was implemented more information is available in the PRs (#1860, #1872)
-
Actions have been moved from the top bar to MUI card actions
-
Calendar toolbar has been updated and loading status added to the calendar
Webhook as a Contact Method
Users may now add webhooks as contact methods. They can be used similarly to email, SMS, and voice. More information can be found under "Using Webhooks" under /docs
within the GoAlert application.
Must be enabled in the Admin -> Config page.
User Management UI
Based on feedback in our community slack channel, we implemented some in-app user management solutions:
- Admins can create a user from the user list (#1536)
- Admins can edit a user's role from the user profile (#1506)
- Admins can delete a user from the user profile (#1493)
gRPC SysAPI
A new experimental gRPC API server is now included (disabled by default).
--listen-sysapi string (Experimental) Listen address:port for the system API (gRPC).
--sysapi-ca-file string (Experimental) Specifies a path to a PEM-encoded certificate(s) to authorize connections from plugin services.
--sysapi-cert-file string (Experimental) Specifies a path to a PEM-encoded certificate to use when connecting to plugin services.
--sysapi-key-file string (Experimental) Specifies a path to a PEM-encoded private key file use when connecting to plugin services.
Currently supported API methods are AuthSubjects
and DeleteUser
allowing an external tool to enumerate and delete/cleanup users. (e.g., compare OIDC users with an Active Directory server).
Protobuf definition and certificate information can be found under pkg/sysapi
Bug Fixes/Misc
- Application Name can now be set to change the page title, in the future this will be applied to messaging as well (like SMS) (#1803)
- Escalation policies can now be favorited (#1567)
- Rotations in which a user participates more than once can now be re-ordered safely (#1478)
- GraphQL v1 endpoint is now disabled by default (#1584)
- Removed a race condition that allowed for duplicate overrides (#1594)
- Accessibility: screen reader will no longer stutter on "Quick Links" (#1618)
- Safari: fixed an issue rendering a user's contact method list (#1500)
- Fixed an issue where searching by phone number could return duplicate user results (#1646)
- Fixed an issue with the service label dialog form validation (#1635)
- Querying for an integration key that doesn't exist would return an "unexpected error". It now returns null (#1640)
- Many React class components converted to hooks
- Began removing Material UI v4 deprecated props in anticipation of v5
Version Updates:
- React 16 -> 17 (#1503)
- Migrated from https://github.com/satori/go.uuid -> https://github.com/google/uuid (#1654)
v0.27.0
GoAlert v0.27.0
This release has a lot of long-anticipated awesome new features and improvements! Most of the work of this release was done under the covers to enable these as well as new features currently in the pipeline.
Thanks to our new contributors @kanish671 and @phoenix6561 for help with the React Hooks conversions Issue #923
Temporary Schedules
Temporary schedules allow replacing the entire on-call schedule for a fixed timeframe. It should help situations where a team requires fine-grained control of on-call responsibility for a few days (e.g. peak week).
To get started using this feature, click the "Temp Sched" button from the schedule details page calendar:
A dialog will open allowing you to configure the time span of the schedule and associated shifts:
Temporary schedules will appear green on the calendar:
Email (SMTP) as an User Contact Method
A new user contact method type EMAIL has been introduced. This allows an additional avenue for users to receive alert notifications.
The SMTP server details can be configured from the Admin page.
Prioritize Schedules on Escalation Policies
Schedules now appear at the top of the Edit Step dialog. Many users had trouble with overrides before realizing a rotation was used instead of schedule. This change was found to encourage users to use schedules (instead of rotations) when configuring a policy.
Prometheus Metrics
You can now enable Prometheus metrics at startup. This allows for monitoring some of the internals and health of GoAlert.
To enable, set the --listen-prometheus
flag or the GOALERT_LISTEN_PROMETHEUS
environment variable.
A new endpoint at <listen_address>/metrics
will include:
- Total number of created alerts
- Number of in-flight HTTP server requests
- Total number of requests by status code
- Duration of outgoing HTTP requests
- Number of active outgoing HTTP requests
- Number of engine cycles
- Engine cycle duration by module
- GraphQL resolver method statistics
- Sent notifications by contact method type and message type
- Received response count by destination and response (e.g. ack, close, stop, start)
Contact Method Throttling
GoAlert now implements bucketed throttling of notifications, per contact method. This is to avoid spamming devices due to misconfiguration or a noisy/broken healthcheck.
For reference, new rules are:
Message Type | Contact Method Type | Rules |
---|---|---|
All | All | 1 per minute |
Status | All | 1 per 3 minutes 3 per 20 minutes (burst) 8 per 2 hours |
Alert | SMS | 5 per 15 minutes (burst) 11 per 1 hour 21 per 3 hours |
Alert | Voice | 3 per 15 minutes (burst) 7 per 1 hour 15 per 3 hours |
Bug Fixes/Misc
- Updated GoAlert in-app documentation at
/docs
: Now supports rendering multiple markdown documents. - ui/schedules: monthly views are fixed to include the correct out-of-bounds shifts when viewing the schedule calendar.
- ui/forms: fixed an issue where the schedule rule weekday filter couldn't be edited
Version Updates:
- Golang 1.15.3 -> 1.16.4
- Postgres 11 -> 13
- Typescript 3.9.7 -> 4.0.3
- Apollo 3.1.5 -> 3.3.15
- Webpack 4.44.2 to 5.13.0
v0.26.0
GoAlert v0.26.0
This release has a lot of bug fixes, cool new features, and hardening in prep for the peak season!
New Version Toast
A version check has now been added to GoAlert's UI that will display a persistent snackbar notification when a new version is detected.
Prometheus Alertmanager Support
A new integration key type for Prometheus Alertmanager has been added.
Config Enhancements
The config page has a new condensed/summary view to make finding items easier:
User Session Management
Users may now manage active login sessions from the profile page, including the ability to easily end/cleanup ones no longer used.
(Admin note: Initial last access time will start as the time of your deployment when introducing this feature.)
Full timestamps on Alerts List Page
A toggle was added to the alerts list filter to switch between displaying the duration since created or the full timestamp when created.
Phone Number in Use Enhancement
When adding a new contact method with a number that is already in-use, users will now have more helpful messaging with a link to the existing users' profile.
Alert Log Message Status
The alert log status entries will now indicate failures for things like provider "Twilio" is disabled.
Support for Warnings/Notices
A new notices API has been added within the GraphQL schema for a Notice. Currently, a notice will be displayed if an escalation policy is unused, in the future, this will be expanded to other common issues.
Test Message Delivery Status
A new status dialog has been added that displays real-time delivery details and the status of test notifications.
Other Improvements/ Bug Fixes:
- Updated to Go 1.15.3, which adds the ability to embed TZ information as well as new vet rules
- Updated Cypress to 5.5.0, which adds built-in test retries
- User session cleanup - user sessions greater than 30 days are removed from the database
- Arm Support was added, making it possible to build and publish multi-platform docker images for GoAlert.
- Fix for an issue with RequireConfig where integration keys using Mailgun were always display as disabled, even if Mailgun is enabled.
- Address validation fix for mailgun invalid recipient address would cause a 500 response instead of expected 406.
- Updated gqlgen to 0.13.0 and error handling (e.g. validation error responses fixed)
- Fixed
goimports
command in Makefile so that using go run ... will automatically pull the tool, as well as using the correct version, rather than requiring the user to install it manually. - Updated Makefile and Dockerfile to use embedded TZ data instead of relying on the system package. This was to resolve an issue where DST values were no longer calculated properly in TZ versions 2020b onwards (e.g. latest in the alpine build). This should help to ensure that binaries and container images are more consistent with regard to calculated times.
- Added a section of recommended tools for development to the docs.
- Updated the admin config page to use accordions for the individual sections.
- Extended the alerts query by adding fields to AlertSearchOptions that allows for querying alerts by date.
- Bug fix for Schedules > Shifts > Filter > Time Limit > Specify, now has the capability to backspace numerical values along with a conditional check defaulting users input values between 1-30 appropriately.