-
-
Notifications
You must be signed in to change notification settings - Fork 468
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Implement push-based external endpoints (#724)
* refactor: Move SSH outside of endpoint.go * refactor: Use pointers for Alert receivers * feat: Implement push-based external endpoints * Fix failing tests * Validate external endpoints on start * Add tests for external endpoints * refactor some error equality checks * Improve docs and refactor some code * Fix UI-related issues with external endpoints
- Loading branch information
Showing
28 changed files
with
808 additions
and
189 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| package api | ||
|
|
||
| import ( | ||
| "errors" | ||
| "log" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/TwiN/gatus/v5/config" | ||
| "github.com/TwiN/gatus/v5/core" | ||
| "github.com/TwiN/gatus/v5/storage/store" | ||
| "github.com/TwiN/gatus/v5/storage/store/common" | ||
| "github.com/TwiN/gatus/v5/watchdog" | ||
| "github.com/gofiber/fiber/v2" | ||
| ) | ||
|
|
||
| func CreateExternalEndpointResult(cfg *config.Config) fiber.Handler { | ||
| return func(c *fiber.Ctx) error { | ||
| // Check if the success query parameter is present | ||
| success, exists := c.Queries()["success"] | ||
| if !exists || (success != "true" && success != "false") { | ||
| return c.Status(400).SendString("missing or invalid success query parameter") | ||
| } | ||
| // Check if the authorization bearer token header is correct | ||
| authorizationHeader := string(c.Request().Header.Peek("Authorization")) | ||
| if !strings.HasPrefix(authorizationHeader, "Bearer ") { | ||
| return c.Status(401).SendString("invalid Authorization header") | ||
| } | ||
| token := strings.TrimSpace(strings.TrimPrefix(authorizationHeader, "Bearer ")) | ||
| if len(token) == 0 { | ||
| return c.Status(401).SendString("bearer token must not be empty") | ||
| } | ||
| key := c.Params("key") | ||
| externalEndpoint := cfg.GetExternalEndpointByKey(key) | ||
| if externalEndpoint == nil { | ||
| log.Printf("[api.CreateExternalEndpointResult] External endpoint with key=%s not found", key) | ||
| return c.Status(404).SendString("not found") | ||
| } | ||
| if externalEndpoint.Token != token { | ||
| log.Printf("[api.CreateExternalEndpointResult] Invalid token for external endpoint with key=%s", key) | ||
| return c.Status(401).SendString("invalid token") | ||
| } | ||
| // Persist the result in the storage | ||
| result := &core.Result{ | ||
| Timestamp: time.Now(), | ||
| Success: c.QueryBool("success"), | ||
| Errors: []string{}, | ||
| } | ||
| convertedEndpoint := externalEndpoint.ToEndpoint() | ||
| if err := store.Get().Insert(convertedEndpoint, result); err != nil { | ||
| if errors.Is(err, common.ErrEndpointNotFound) { | ||
| return c.Status(404).SendString(err.Error()) | ||
| } | ||
| log.Printf("[api.CreateExternalEndpointResult] Failed to insert result in storage: %s", err.Error()) | ||
| return c.Status(500).SendString(err.Error()) | ||
| } | ||
| log.Printf("[api.CreateExternalEndpointResult] Successfully inserted result for external endpoint with key=%s and success=%s", c.Params("key"), success) | ||
| // Check if an alert should be triggered or resolved | ||
| if !cfg.Maintenance.IsUnderMaintenance() { | ||
| watchdog.HandleAlerting(convertedEndpoint, result, cfg.Alerting, cfg.Debug) | ||
| externalEndpoint.NumberOfSuccessesInARow = convertedEndpoint.NumberOfSuccessesInARow | ||
| externalEndpoint.NumberOfFailuresInARow = convertedEndpoint.NumberOfFailuresInARow | ||
| } | ||
| // Return the result | ||
| return c.Status(200).SendString("") | ||
| } | ||
| } |
Oops, something went wrong.