Skip to content

Commit 6e16f73

Browse files
tobiasehlerttobiasehlert
authored
feature: adding support for k8s health endpoints (#147)
* adding two endpoints for k8s fix #146 * update readme and go mods * adding test for healtz and readyz updating go mods
1 parent 35a2a1b commit 6e16f73

File tree

7 files changed

+65
-26
lines changed

7 files changed

+65
-26
lines changed

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,9 @@ There is a swagger-generated documentation available for download on the [GitHub
9696
Those are the current existing endpoints.
9797

9898
- GET `/ping`
99-
- GET `/health`
99+
- ~GET `/health`~
100+
- GET `/healthz`
101+
- GET `/readyz`
100102
- GET `/v3/boostablebosses`
101103
- GET `/v3/character/:name`
102104
- GET `/v3/creature/:race`

‎go.mod‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,29 @@ require (
1212
)
1313

1414
require (
15-
github.com/goccy/go-json v0.9.11 // indirect
15+
github.com/goccy/go-json v0.10.0 // indirect
1616
github.com/pelletier/go-toml/v2 v2.0.6 // indirect
17+
github.com/stretchr/objx v0.5.0 // indirect
1718
)
1819

1920
require (
2021
github.com/andybalholm/cascadia v1.3.1 // indirect
2122
github.com/davecgh/go-spew v1.1.1 // indirect
2223
github.com/gin-contrib/gzip v0.0.6
2324
github.com/gin-contrib/sse v0.1.0 // indirect
24-
github.com/go-playground/locales v0.14.0 // indirect
25+
github.com/go-playground/locales v0.14.1 // indirect
2526
github.com/go-playground/universal-translator v0.18.0 // indirect
2627
github.com/go-playground/validator/v10 v10.11.1 // indirect
2728
github.com/json-iterator/go v1.1.12 // indirect
2829
github.com/leodido/go-urn v1.2.1 // indirect
29-
github.com/mattn/go-isatty v0.0.16 // indirect
30+
github.com/mattn/go-isatty v0.0.17 // indirect
3031
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
3132
github.com/modern-go/reflect2 v1.0.2 // indirect
3233
github.com/pmezard/go-difflib v1.0.0 // indirect
33-
github.com/ugorji/go/codec v1.2.7 // indirect
34-
golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa // indirect
35-
golang.org/x/net v0.4.0 // indirect
36-
golang.org/x/sys v0.3.0 // indirect
34+
github.com/ugorji/go/codec v1.2.8 // indirect
35+
golang.org/x/crypto v0.5.0 // indirect
36+
golang.org/x/net v0.5.0 // indirect
37+
golang.org/x/sys v0.4.0 // indirect
3738
google.golang.org/protobuf v1.28.1 // indirect
3839
gopkg.in/yaml.v2 v2.4.0 // indirect
3940
gopkg.in/yaml.v3 v3.0.1 // indirect

‎go.sum‎

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ github.com/gin-gonic/gin v1.8.2 h1:UzKToD9/PoFj/V4rvlKqTRKnQYyz8Sc1MJlv4JHPtvY=
1515
github.com/gin-gonic/gin v1.8.2/go.mod h1:qw5AYuDrzRTnhvusDsrov+fDIxp9Dleuu12h8nfB398=
1616
github.com/go-playground/assert/v2 v2.0.1 h1:MsBgLAaY856+nPRTKrp3/OZK38U/wa0CcBYNjji3q3A=
1717
github.com/go-playground/assert/v2 v2.0.1/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4=
18-
github.com/go-playground/locales v0.14.0 h1:u50s323jtVGugKlcYeyzC0etD1HifMjqmJqb8WugfUU=
1918
github.com/go-playground/locales v0.14.0/go.mod h1:sawfccIbzZTqEDETgFXqTho0QybSa7l++s0DH+LDiLs=
19+
github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA=
20+
github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY=
2021
github.com/go-playground/universal-translator v0.18.0 h1:82dyy6p4OuJq4/CByFNOn/jYrnRPArHwAcmLoJZxyho=
2122
github.com/go-playground/universal-translator v0.18.0/go.mod h1:UvRDBj+xPUEGrFYl+lu/H90nyDXpg0fqeB/AQUGNTVA=
2223
github.com/go-playground/validator/v10 v10.10.0/go.mod h1:74x4gJWsvQexRdW8Pn3dXSGrTK4nAUsbPlLADvpJkos=
@@ -25,8 +26,8 @@ github.com/go-playground/validator/v10 v10.11.1/go.mod h1:i+3WkQ1FvaUjjxh1kSvIA4
2526
github.com/go-resty/resty/v2 v2.7.0 h1:me+K9p3uhSmXtrBZ4k9jcEAfJmuC8IivWHwaLZwPrFY=
2627
github.com/go-resty/resty/v2 v2.7.0/go.mod h1:9PWDzw47qPphMRFfhsyk0NnSgvluHcljSMVIq3w7q0I=
2728
github.com/goccy/go-json v0.9.7/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
28-
github.com/goccy/go-json v0.9.11 h1:/pAaQDLHEoCq/5FFmSKBswWmK6H0e8g4159Kc/X/nqk=
29-
github.com/goccy/go-json v0.9.11/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
29+
github.com/goccy/go-json v0.10.0 h1:mXKd9Qw4NuzShiRlOXKews24ufknHO7gx30lsDyokKA=
30+
github.com/goccy/go-json v0.10.0/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
3031
github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
3132
github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
3233
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
@@ -46,8 +47,8 @@ github.com/leodido/go-urn v1.2.1/go.mod h1:zt4jvISO2HfUBqxjfIshjdMTYS56ZS/qv49ic
4647
github.com/mantyr/go-charset v0.0.0-20160510214718-44d054d82c4a h1:WJXeKt5afI65LpiwNdMo3KzkSQHdQHwjp3Aj1/i/XG4=
4748
github.com/mantyr/go-charset v0.0.0-20160510214718-44d054d82c4a/go.mod h1:lgDGvifiwLKvbOecA+o0c3QMv7kv+xZEQTqm7Q3ouAc=
4849
github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
49-
github.com/mattn/go-isatty v0.0.16 h1:bq3VjFmv/sOjHtdEhmkEV4x1AJtvUvOJ2PFAZ5+peKQ=
50-
github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
50+
github.com/mattn/go-isatty v0.0.17 h1:BTarxUcIeDqL27Mc+vyvdWYSL28zpIhv3RoTdsLMPng=
51+
github.com/mattn/go-isatty v0.0.17/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
5152
github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
5253
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg=
5354
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
@@ -64,6 +65,7 @@ github.com/rogpeppe/go-internal v1.8.0 h1:FCbCCtXNOY3UtUuHUYaghJg4y7Fd14rXifAYUA
6465
github.com/rogpeppe/go-internal v1.8.0/go.mod h1:WmiCO8CzOY8rg0OYDC4/i/2WRWAB6poM+XZ2dLUbcbE=
6566
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
6667
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
68+
github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c=
6769
github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
6870
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
6971
github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
@@ -73,26 +75,27 @@ github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO
7375
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
7476
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
7577
github.com/ugorji/go v1.2.7/go.mod h1:nF9osbDWLy6bDVv/Rtoh6QgnvNDpmCalQV5urGCCS6M=
76-
github.com/ugorji/go/codec v1.2.7 h1:YPXUKf7fYbp/y8xloBqZOw2qaVggbfwMlI8WM3wZUJ0=
7778
github.com/ugorji/go/codec v1.2.7/go.mod h1:WGN1fab3R1fzQlVQTkfxVtIBhWDRqOviHU95kRgeqEY=
79+
github.com/ugorji/go/codec v1.2.8 h1:sgBJS6COt0b/P40VouWKdseidkDgHxYGm0SAglUHfP0=
80+
github.com/ugorji/go/codec v1.2.8/go.mod h1:UNopzCgEMSXjBc6AOMqYvWC1ktqTAfzJZUZgYf6w6lg=
7881
golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
7982
golang.org/x/crypto v0.0.0-20211215153901-e495a2d5b3d3/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
80-
golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa h1:zuSxTR4o9y82ebqCUJYNGJbGPo6sKVl54f/TVDObg1c=
81-
golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
83+
golang.org/x/crypto v0.5.0 h1:U/0M97KRkSFvyD/3FSmdP5W5swImpNgle/EHFhOsQPE=
84+
golang.org/x/crypto v0.5.0/go.mod h1:NK/OQwhpMQP3MwtdjgLlYHnH9ebylxKWv3e0fK+mkQU=
8285
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
8386
golang.org/x/net v0.0.0-20210916014120-12bc252f5db8/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
8487
golang.org/x/net v0.0.0-20211029224645-99673261e6eb/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
8588
golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
86-
golang.org/x/net v0.4.0 h1:Q5QPcMlvfxFTAPV0+07Xz/MpK9NTXu2VDUuy0FeMfaU=
87-
golang.org/x/net v0.4.0/go.mod h1:MBQ8lrhLObU/6UmLb4fmbmk5OcyYmqtbGd/9yIeKjEE=
89+
golang.org/x/net v0.5.0 h1:GyT4nK/YDHSqa1c4753ouYCDajOYKTja9Xb/OHtgvSw=
90+
golang.org/x/net v0.5.0/go.mod h1:DivGGAXEgPSlEBzxGzZI+ZLohi+xUj054jfeKui00ws=
8891
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
8992
golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
9093
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
9194
golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
9295
golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
9396
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
94-
golang.org/x/sys v0.3.0 h1:w8ZOecv6NaNa/zC8944JTU3vz4u6Lagfk4RPQxv92NQ=
95-
golang.org/x/sys v0.3.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
97+
golang.org/x/sys v0.4.0 h1:Zr2JFtRQNX3BCZ8YtxRE9hNJYC8J6I1MVbMg6owUp18=
98+
golang.org/x/sys v0.4.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
9699
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
97100
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
98101
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=

‎src/HousesMapping.go‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ func TibiaDataHousesMappingInitiator() {
5959
TibiaDataHousesMapping = data
6060
}
6161

62+
// setting readyz endpoint to true
63+
isReady.Store(true)
64+
6265
default:
6366
log.Printf("[error] TibiaData API failed to load houses mapping. %s", err)
6467
}

‎src/main.go‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
package main
22

3-
import "log"
3+
import (
4+
"log"
5+
"sync/atomic"
6+
)
47

58
var (
9+
// application readyz endpoint value for k8s
10+
isReady *atomic.Value
11+
612
// TibiaDataDefaultVoc - default vocation when not specified in request
713
TibiaDataDefaultVoc string = "all"
814

@@ -38,6 +44,10 @@ var (
3844
// @BasePath /
3945

4046
func main() {
47+
// setup of readyness endpoint code
48+
isReady = &atomic.Value{}
49+
isReady.Store(false)
50+
4151
// logging start of TibiaData
4252
log.Printf("[info] TibiaData API starting..")
4353

‎src/webserver.go‎

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,10 @@ func runWebServer() {
7373
})
7474
})
7575

76-
router.GET("/health", func(c *gin.Context) {
77-
c.JSON(http.StatusOK, gin.H{
78-
"status": "UP",
79-
})
80-
})
76+
// health endpoints for kubernetes
77+
router.GET("/health", healthz)
78+
router.GET("/healthz", healthz)
79+
router.GET("/readyz", readyz)
8180

8281
// TibiaData API version 3
8382
v3 := router.Group("/v3")
@@ -920,3 +919,18 @@ func TibiaDataRequestTraceLogger(res *resty.Response, err error) {
920919
"\nRemoteAddr :", res.Request.TraceInfo().RemoteAddr.String(),
921920
"\n==============================================================================")
922921
}
922+
923+
// healthz is a k8s liveness probe
924+
func healthz(c *gin.Context) {
925+
c.JSON(http.StatusOK, gin.H{"status": http.StatusText(http.StatusOK)})
926+
}
927+
928+
// readyz is a k8s readiness probe
929+
func readyz(c *gin.Context) {
930+
if isReady == nil || !isReady.Load().(bool) {
931+
c.JSON(http.StatusServiceUnavailable, gin.H{"error": http.StatusText(http.StatusServiceUnavailable)})
932+
return
933+
}
934+
//c.JSON(http.StatusOK, gin.H{"status": http.StatusText(http.StatusOK)})
935+
TibiaDataAPIHandleResponse(c, http.StatusOK, "readyz", gin.H{"status": http.StatusText(http.StatusOK)})
936+
}

‎src/webserver_test.go‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,10 @@ func TestFakeToUpCodeCoverage(t *testing.T) {
7373
assert.Equal(http.StatusOK, w.Code)
7474

7575
assert.Equal("TibiaData-API/v3 (release/unknown; build/manual; commit/-; edition/open-source; unittest.example.com)", TibiaDataUserAgentGenerator(3))
76+
77+
healthz(c)
78+
assert.Equal(http.StatusOK, w.Code)
79+
80+
readyz(c)
81+
assert.Equal(http.StatusOK, w.Code)
7682
}

0 commit comments

Comments
 (0)