From 66886e2c9760fdc4b212ae5ef68bf0b9373ac790 Mon Sep 17 00:00:00 2001 From: Martin Redolatti Date: Fri, 6 Dec 2024 14:18:24 -0300 Subject: [PATCH] healthcheck proposal --- CHANGES | 3 ++ cmd/splitd/main.go | 15 +++++++ go.mod | 30 ++++++++++++- go.sum | 74 ++++++++++++++++++++++++++++++- infra/entrypoint.sh | 4 ++ splitd.yaml.tpl | 4 ++ splitio/api/api.go | 37 ++++++++++++++++ splitio/api/controllers/health.go | 58 ++++++++++++++++++++++++ splitio/commitsha.go | 2 +- splitio/conf/splitd.go | 16 ++++++- splitio/version.go | 2 +- 11 files changed, 237 insertions(+), 8 deletions(-) create mode 100644 splitio/api/api.go create mode 100644 splitio/api/controllers/health.go diff --git a/CHANGES b/CHANGES index 93d2579..2303fb3 100644 --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,6 @@ +1.5.0 (TBD) +- Health & Readiness endpoints + 1.4.0 (May 14, 2024): - Updated go-split-commons to v6 - Added support for targeting rules based on semantic versions (https://semver.org/). diff --git a/cmd/splitd/main.go b/cmd/splitd/main.go index 82a991b..925b8d2 100644 --- a/cmd/splitd/main.go +++ b/cmd/splitd/main.go @@ -7,6 +7,7 @@ import ( "github.com/splitio/go-toolkit/v5/logging" "github.com/splitio/splitd/splitio" + "github.com/splitio/splitd/splitio/api" "github.com/splitio/splitd/splitio/conf" "github.com/splitio/splitd/splitio/link" "github.com/splitio/splitd/splitio/sdk" @@ -58,6 +59,9 @@ func main() { }() } + // launch api in BG (errors will be logged but won't abort execution of app) + go startAPI(logger, cfg.API, *linkCFG) + // Wait for connection to end (either gracefully of because of an error) err = <-errc exitOnErr("shutdown: ", err) @@ -84,3 +88,14 @@ func exitOnErr(ctxStr string, err error) { } } + +func startAPI(logger logging.LoggerInterface, apiCFG conf.API, linkCFG link.ListenerOptions) { + server, err := api.Setup(apiCFG.Host, apiCFG.Port, logger, linkCFG) + if err != nil { + logger.Error("error creating HTTP server:", err.Error()) + } + + if err = server.ListenAndServe(); err != nil { + logger.Error("error starting http server:", err.Error()) + } +} diff --git a/go.mod b/go.mod index 0286943..644082a 100644 --- a/go.mod +++ b/go.mod @@ -3,18 +3,44 @@ module github.com/splitio/splitd go 1.21 require ( + github.com/gin-gonic/gin v1.10.0 github.com/splitio/go-split-commons/v6 v6.0.0 github.com/splitio/go-toolkit/v5 v5.4.0 - github.com/stretchr/testify v1.8.1 + github.com/stretchr/testify v1.9.0 github.com/vmihailenco/msgpack/v5 v5.3.5 golang.org/x/sync v0.3.0 gopkg.in/yaml.v3 v3.0.1 ) require ( + github.com/bytedance/sonic v1.11.6 // indirect + github.com/bytedance/sonic/loader v0.1.1 // indirect + github.com/cloudwego/base64x v0.1.4 // indirect + github.com/cloudwego/iasm v0.2.0 // indirect github.com/davecgh/go-spew v1.1.1 // indirect + github.com/gabriel-vasile/mimetype v1.4.3 // indirect + github.com/gin-contrib/sse v0.1.0 // indirect + github.com/go-playground/locales v0.14.1 // indirect + github.com/go-playground/universal-translator v0.18.1 // indirect + github.com/go-playground/validator/v10 v10.20.0 // indirect + github.com/goccy/go-json v0.10.2 // indirect + github.com/json-iterator/go v1.1.12 // indirect + github.com/klauspost/cpuid/v2 v2.2.7 // indirect + github.com/leodido/go-urn v1.4.0 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect + github.com/modern-go/reflect2 v1.0.2 // indirect + github.com/pelletier/go-toml/v2 v2.2.2 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect - github.com/stretchr/objx v0.5.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/twitchyliquid64/golang-asm v0.15.1 // indirect + github.com/ugorji/go/codec v1.2.12 // indirect github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect + golang.org/x/arch v0.8.0 // indirect + golang.org/x/crypto v0.23.0 // indirect golang.org/x/exp v0.0.0-20231006140011-7918f672742d // indirect + golang.org/x/net v0.25.0 // indirect + golang.org/x/sys v0.20.0 // indirect + golang.org/x/text v0.15.0 // indirect + google.golang.org/protobuf v1.34.1 // indirect ) diff --git a/go.sum b/go.sum index 05c7b22..c3b3dd7 100644 --- a/go.sum +++ b/go.sum @@ -2,9 +2,53 @@ github.com/bits-and-blooms/bitset v1.3.1 h1:y+qrlmq3XsWi+xZqSaueaE8ry8Y127iMxlMf github.com/bits-and-blooms/bitset v1.3.1/go.mod h1:gIdJ4wp64HaoK2YrL1Q5/N7Y16edYb8uY+O0FJTyyDA= github.com/bits-and-blooms/bloom/v3 v3.3.1 h1:K2+A19bXT8gJR5mU7y+1yW6hsKfNCjcP2uNfLFKncjQ= github.com/bits-and-blooms/bloom/v3 v3.3.1/go.mod h1:bhUUknWd5khVbTe4UgMCSiOOVJzr3tMoijSK3WwvW90= +github.com/bytedance/sonic v1.11.6 h1:oUp34TzMlL+OY1OUWxHqsdkgC/Zfc85zGqw9siXjrc0= +github.com/bytedance/sonic v1.11.6/go.mod h1:LysEHSvpvDySVdC2f87zGWf6CIKJcAvqab1ZaiQtds4= +github.com/bytedance/sonic/loader v0.1.1 h1:c+e5Pt1k/cy5wMveRDyk2X4B9hF4g7an8N3zCYjJFNM= +github.com/bytedance/sonic/loader v0.1.1/go.mod h1:ncP89zfokxS5LZrJxl5z0UJcsk4M4yY2JpfqGeCtNLU= +github.com/cloudwego/base64x v0.1.4 h1:jwCgWpFanWmN8xoIUHa2rtzmkd5J2plF/dnLS6Xd/0Y= +github.com/cloudwego/base64x v0.1.4/go.mod h1:0zlkT4Wn5C6NdauXdJRhSKRlJvmclQ1hhJgA0rcu/8w= +github.com/cloudwego/iasm v0.2.0 h1:1KNIy1I1H9hNNFEEH3DVnI4UujN+1zjpuk6gwHLTssg= +github.com/cloudwego/iasm v0.2.0/go.mod h1:8rXZaNYT2n95jn+zTI1sDr+IgcD2GVs0nlbbQPiEFhY= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/gabriel-vasile/mimetype v1.4.3 h1:in2uUcidCuFcDKtdcBxlR0rJ1+fsokWf+uqxgUFjbI0= +github.com/gabriel-vasile/mimetype v1.4.3/go.mod h1:d8uq/6HKRL6CGdk+aubisF/M5GcPfT7nKyLpA0lbSSk= +github.com/gin-contrib/sse v0.1.0 h1:Y/yl/+YNO8GZSjAhjMsSuLt29uWRFHdHYUb5lYOV9qE= +github.com/gin-contrib/sse v0.1.0/go.mod h1:RHrZQHXnP2xjPF+u1gW/2HnVO7nvIa9PG3Gm+fLHvGI= +github.com/gin-gonic/gin v1.10.0 h1:nTuyha1TYqgedzytsKYqna+DfLos46nTv2ygFy86HFU= +github.com/gin-gonic/gin v1.10.0/go.mod h1:4PMNQiOhvDRa013RKVbsiNwoyezlm2rm0uX/T7kzp5Y= +github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s= +github.com/go-playground/assert/v2 v2.2.0/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4= +github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA= +github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY= +github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY= +github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY= +github.com/go-playground/validator/v10 v10.20.0 h1:K9ISHbSaI0lyB2eWMPJo+kOS/FBExVwjEviJTixqxL8= +github.com/go-playground/validator/v10 v10.20.0/go.mod h1:dbuPbCMFw/DrkbEynArYaCwl3amGuJotoKCe95atGMM= +github.com/goccy/go-json v0.10.2 h1:CrxCmQqYDkv1z7lO7Wbh2HN93uovUHgrECaO5ZrCXAU= +github.com/goccy/go-json v0.10.2/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I= +github.com/google/go-cmp v0.5.8 h1:e6P7q2lk1O+qJJb4BtCQXlK8vWEO8V1ZeuEdJNOqZyg= +github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM= +github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo= +github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg= +github.com/klauspost/cpuid/v2 v2.2.7 h1:ZWSB3igEs+d0qvnxR/ZBzXVmxkgt8DdzP6m9pfuVLDM= +github.com/klauspost/cpuid/v2 v2.2.7/go.mod h1:Lcz8mBdAVJIBVzewtcLocK12l3Y+JytZYpaMropDUws= +github.com/knz/go-libedit v1.10.1/go.mod h1:MZTVkCWyz0oBc7JOWP3wNAzd002ZbM/5hgShxwh4x8M= +github.com/leodido/go-urn v1.4.0 h1:WT9HwE9SGECu3lg4d/dIA+jxlljEa1/ffXKmRjqdmIQ= +github.com/leodido/go-urn v1.4.0/go.mod h1:bvxc+MVxLKB4z00jd1z+Dvzr47oO32F/QSNjSBOlFxI= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M= +github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= +github.com/pelletier/go-toml/v2 v2.2.2 h1:aYUidT7k73Pcl9nb2gScu7NSrKCSHIDE89b3+6Wq+LM= +github.com/pelletier/go-toml/v2 v2.2.2/go.mod h1:1t835xjRzz80PqgE6HHgN2JOsmgYu/h4qDAS4n929Rs= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/splitio/go-split-commons/v6 v6.0.0 h1:qenr5qbXafjvM832C64CVpjtlShuQiWCwtR5I2h4ogM= @@ -13,23 +57,49 @@ github.com/splitio/go-toolkit/v5 v5.4.0 h1:g5WFpRhQomnXCmvfsNOWV4s5AuUrWIZ+amM68 github.com/splitio/go-toolkit/v5 v5.4.0/go.mod h1:xYhUvV1gga9/1029Wbp5pjnR6Cy8nvBpjw99wAbsMko= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= -github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c= github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= -github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk= github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= +github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI= +github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08= +github.com/ugorji/go/codec v1.2.12 h1:9LC83zGrHhuUA9l16C9AHXAqEV/2wBQ4nkvumAE65EE= +github.com/ugorji/go/codec v1.2.12/go.mod h1:UNopzCgEMSXjBc6AOMqYvWC1ktqTAfzJZUZgYf6w6lg= github.com/vmihailenco/msgpack/v5 v5.3.5 h1:5gO0H1iULLWGhs2H5tbAHIZTV8/cYafcFOr9znI5mJU= github.com/vmihailenco/msgpack/v5 v5.3.5/go.mod h1:7xyJ9e+0+9SaZT0Wt1RGleJXzli6Q/V5KbhBonMG9jc= github.com/vmihailenco/tagparser/v2 v2.0.0 h1:y09buUbR+b5aycVFQs/g70pqKVZNBmxwAhO7/IwNM9g= github.com/vmihailenco/tagparser/v2 v2.0.0/go.mod h1:Wri+At7QHww0WTrCBeu4J6bNtoV6mEfg5OIWRZA9qds= +golang.org/x/arch v0.0.0-20210923205945-b76863e36670/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8= +golang.org/x/arch v0.8.0 h1:3wRIsP3pM4yUptoR96otTUOXI367OS0+c9eeRi9doIc= +golang.org/x/arch v0.8.0/go.mod h1:FEVrYAQjsQXMVJ1nsMoVVXPZg6p2JE2mx8psSWTDQys= +golang.org/x/crypto v0.23.0 h1:dIJU/v2J8Mdglj/8rJ6UUOM3Zc9zLZxVZwwxMooUSAI= +golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8= golang.org/x/exp v0.0.0-20231006140011-7918f672742d h1:jtJma62tbqLibJ5sFQz8bKtEM8rJBtfilJ2qTU199MI= golang.org/x/exp v0.0.0-20231006140011-7918f672742d/go.mod h1:ldy0pHrwJyGW56pPQzzkH36rKxoZW1tw7ZJpeKx+hdo= +golang.org/x/net v0.25.0 h1:d/OCCoBEUq33pjydKrGQhw7IlUPI2Oylr+8qLx49kac= +golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= golang.org/x/sync v0.3.0 h1:ftCYgMx6zT/asHUrPw8BLLscYtGznsLAnjq5RH9P66E= golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y= +golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.20.0 h1:Od9JTbYCk261bKm4M/mw7AklTlFYIa0bIp9BgSm1S8Y= +golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/text v0.15.0 h1:h1V/4gjBv8v9cjcR6+AR5+/cIYK5N/WAgiv4xlsEtAk= +golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +google.golang.org/protobuf v1.34.1 h1:9ddQBjfCyZPOHPUiPxpYESBLc+T8P3E+Vo4IbKZgFWg= +google.golang.org/protobuf v1.34.1/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +nullprogram.com/x/optparse v1.0.0/go.mod h1:KdyPE+Igbe0jQUrVfMqDMeJQIJZEuyV7pjYmp6pbG50= +rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4= diff --git a/infra/entrypoint.sh b/infra/entrypoint.sh index f01517d..289af17 100755 --- a/infra/entrypoint.sh +++ b/infra/entrypoint.sh @@ -73,6 +73,10 @@ fi [ ! -z ${SPLITD_LOG_LEVEL+x} ] && accum=$(echo "${accum}" | yq '.logging.level = env(SPLITD_LOG_LEVEL)') [ ! -z ${SPLITD_LOG_OUTPUT+x} ] && accum=$(echo "${accum}" | yq '.logging.output = env(SPLITD_LOG_OUTPUT)') +# API configs +[ ! -z ${SPLITD_API_HOST+x} ] && accum=$(echo "${accum}" | yq '.api.host = env(SPLITD_API_HOST)') +[ ! -z ${SPLITD_API_PORT+x} ] && accum=$(echo "${accum}" | yq '.api.port = env(SPLITD_API_PORT)') + # profiling configs [ ! -z ${SPLITD_PROFILING_ENABLE+x} ] && accum=$(echo "${accum}" | yq '.debug.profiling.enable = env(SPLITD_PROFILING_ENABLE)') [ ! -z ${SPLITD_PROFILING_HOST+x} ] && accum=$(echo "${accum}" | yq '.debug.profiling.host = env(SPLITD_PROFILING_HOST)') diff --git a/splitd.yaml.tpl b/splitd.yaml.tpl index 490a010..2158359 100644 --- a/splitd.yaml.tpl +++ b/splitd.yaml.tpl @@ -30,6 +30,7 @@ sdk: events: refreshRateSeconds: 60 queueSize: 8192 + flagSetsFilter: [] link: type: unix-seqpacket address: /var/run/splitd.sock @@ -45,4 +46,7 @@ debug: enable: false host: localhost port: 8888 +api: + host: 0.0.0.0 + port: 8887 diff --git a/splitio/api/api.go b/splitio/api/api.go new file mode 100644 index 0000000..3cb6ea8 --- /dev/null +++ b/splitio/api/api.go @@ -0,0 +1,37 @@ +package api + +import ( + "fmt" + "net/http" + "os" + "strconv" + + "github.com/gin-gonic/gin" + "github.com/splitio/go-toolkit/v5/logging" + "github.com/splitio/splitd/splitio/api/controllers" + "github.com/splitio/splitd/splitio/link" + "github.com/splitio/splitd/splitio/link/client" +) + +func Setup(host string, port int, logger logging.LoggerInterface, listenerCfG link.ListenerOptions) (*http.Server, error) { + + router := gin.Default() + mainAPI := router.Group("/api") + + healthCtrl := controllers.NewHealthController(logger, link.ConsumerOptions{ + Transfer: listenerCfG.Transfer, + Consumer: client.Options{ + ID: strconv.Itoa(os.Getpid()), + Protocol: listenerCfG.Protocol, + ImpressionsFeedback: false, + }, + Serialization: listenerCfG.Serialization, + }) + + healthCtrl.Register(mainAPI) + + return &http.Server{ + Addr: fmt.Sprintf("%s:%d", host, port), + Handler: router, + }, nil +} diff --git a/splitio/api/controllers/health.go b/splitio/api/controllers/health.go new file mode 100644 index 0000000..78a63c2 --- /dev/null +++ b/splitio/api/controllers/health.go @@ -0,0 +1,58 @@ +package controllers + +import ( + "fmt" + + "github.com/gin-gonic/gin" + "github.com/splitio/go-toolkit/v5/logging" + "github.com/splitio/splitd/splitio/link" + "github.com/splitio/splitd/splitio/link/client" + "github.com/splitio/splitd/splitio/link/serializer" + "github.com/splitio/splitd/splitio/link/transfer" +) + +type HealthCheckController struct { + connParams link.ConsumerOptions + logger logging.LoggerInterface +} + +func (c *HealthCheckController) Register(router gin.IRouter) { + router.GET("/health", c.isHealthy) + router.GET("/ready", c.isReady) +} + +func (c *HealthCheckController) isHealthy(ctx *gin.Context) { + ctx.Status(200) +} + +func (c *HealthCheckController) isReady(ctx *gin.Context) { + conn, err := transfer.NewClientConn(c.logger, &c.connParams.Transfer) + if conn != nil { + defer conn.Shutdown() + } + if err != nil { + ctx.AbortWithError(500, fmt.Errorf("error creating raw connection: %w", err)) + return + } + + serial, err := serializer.Setup(c.connParams.Serialization) + if err != nil { + ctx.AbortWithError(500, fmt.Errorf("error setting up serializer: %w", err)) + return + } + + _, err = client.New(c.logger, conn, serial, c.connParams.Consumer) + if err != nil { + ctx.AbortWithError(500, fmt.Errorf("error setting up client: %w", err)) + return + } + + ctx.Status(200) +} + +func NewHealthController(logger logging.LoggerInterface, connParams link.ConsumerOptions) *HealthCheckController { + return &HealthCheckController{ + connParams: connParams, + logger: logger, + } +} diff --git a/splitio/commitsha.go b/splitio/commitsha.go index 9589ceb..4e8b61c 100644 --- a/splitio/commitsha.go +++ b/splitio/commitsha.go @@ -1,3 +1,3 @@ package splitio -const CommitSHA = "3f5eb7e" +const CommitSHA = "d46a130" diff --git a/splitio/conf/splitd.go b/splitio/conf/splitd.go index 7ef227d..893564b 100644 --- a/splitio/conf/splitd.go +++ b/splitio/conf/splitd.go @@ -3,7 +3,6 @@ package conf import ( "encoding/json" "fmt" - "io/ioutil" "log" "os" "strings" @@ -29,6 +28,7 @@ type Config struct { SDK SDK `yaml:"sdk"` Link Link `yaml:"link"` Debug Debug `yaml:"debug"` + API API `yaml:"api"` } func (c Config) String() string { @@ -42,7 +42,7 @@ func (c Config) String() string { func (c *Config) parse(fn string) error { - raw, err := ioutil.ReadFile(fn) + raw, err := os.ReadFile(fn) if err != nil { return fmt.Errorf("error reading yaml file: %w", err) } @@ -60,6 +60,7 @@ func (c *Config) PopulateWithDefaults() { c.Link.PopulateWithDefaults() c.Logger.PopulateWithDefaults() c.Debug.PopulateWithDefaults() + c.API.PopulateWithDefaults() } type Link struct { @@ -278,6 +279,16 @@ func (l *Logger) ToLoggerOptions() (*logging.LoggerOptions, error) { return opts, nil } +type API struct { + Host string `yaml:"host"` + Port int `yaml:"port"` +} + +func (a *API) PopulateWithDefaults() { + a.Host = "0.0.0.0" + a.Port = 8887 +} + type Debug struct { Profiling Profiling `yaml:"profiling"` } @@ -305,5 +316,6 @@ func ReadConfig() (*Config, error) { } var c Config + c.PopulateWithDefaults() return &c, c.parse(cfgFN) } diff --git a/splitio/version.go b/splitio/version.go index 91214b4..3988c20 100644 --- a/splitio/version.go +++ b/splitio/version.go @@ -1,3 +1,3 @@ package splitio -const Version = "1.4.0" +const Version = "1.5.0"