summaryrefslogtreecommitdiff
path: root/internal/api/health.go
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2024-03-25 18:05:14 +0100
committerLibravatar GitHub <noreply@github.com>2024-03-25 17:05:14 +0000
commitb7b42e832ad711ebb5af5c03e1c8e8a471c6bde0 (patch)
tree2fbc4188fd3104f141abe590ac7b586d73772e74 /internal/api/health.go
parent[bugfix] Avoid empty public/local timeline queries (#2784) (diff)
downloadgotosocial-b7b42e832ad711ebb5af5c03e1c8e8a471c6bde0.tar.xz
[feature] Add healthcheck endpoints `/livez` and `/readyz` (#2783)
* [feature] Add healthcheck endpoints `/livez` and `/readyz` * use select that returns no data
Diffstat (limited to 'internal/api/health.go')
-rw-r--r--internal/api/health.go51
1 files changed, 51 insertions, 0 deletions
diff --git a/internal/api/health.go b/internal/api/health.go
new file mode 100644
index 000000000..e1dfd1924
--- /dev/null
+++ b/internal/api/health.go
@@ -0,0 +1,51 @@
+// GoToSocial
+// Copyright (C) GoToSocial Authors admin@gotosocial.org
+// SPDX-License-Identifier: AGPL-3.0-or-later
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+package api
+
+import (
+ "context"
+
+ "github.com/gin-gonic/gin"
+ "github.com/superseriousbusiness/gotosocial/internal/api/health"
+ "github.com/superseriousbusiness/gotosocial/internal/middleware"
+ "github.com/superseriousbusiness/gotosocial/internal/router"
+)
+
+type Health struct {
+ health *health.Module
+}
+
+func (mt *Health) Route(r *router.Router, m ...gin.HandlerFunc) {
+ // Create new group on top level prefix.
+ healthGroup := r.AttachGroup("")
+ healthGroup.Use(m...)
+ healthGroup.Use(
+ middleware.CacheControl(middleware.CacheControlConfig{
+ // Never cache health responses.
+ Directives: []string{"no-store"},
+ }),
+ )
+
+ mt.health.Route(healthGroup.Handle)
+}
+
+func NewHealth(readyF func(context.Context) error) *Health {
+ return &Health{
+ health: health.New(readyF),
+ }
+}