Compare commits
No commits in common. "devel" and "v1.0.1-rc.1" have entirely different histories.
devel
...
v1.0.1-rc.
@ -1,38 +0,0 @@
|
||||
{
|
||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||
"extends": [
|
||||
"local>renovate/renovate"
|
||||
],
|
||||
"packageRules": [
|
||||
{
|
||||
"groupName": "all non-major dependencies",
|
||||
"groupSlug": "all-minor-patch",
|
||||
"matchPackagePatterns": [
|
||||
"*"
|
||||
],
|
||||
"matchUpdateTypes": [
|
||||
"minor",
|
||||
"patch",
|
||||
"pin",
|
||||
"digest"
|
||||
],
|
||||
"automerge": false
|
||||
},
|
||||
{
|
||||
"groupName": "all major dependencies",
|
||||
"groupSlug": "all-major",
|
||||
"matchPackagePatterns": [
|
||||
"*"
|
||||
],
|
||||
"matchUpdateTypes": [
|
||||
"major"
|
||||
],
|
||||
"automerge": false
|
||||
}
|
||||
],
|
||||
"ignoreDeps": [],
|
||||
"postUpdateOptions": [
|
||||
"gomodTidy",
|
||||
"gomodUpdateImportPaths"
|
||||
]
|
||||
}
|
||||
@ -5,6 +5,7 @@ when:
|
||||
|
||||
steps:
|
||||
test:
|
||||
image: golang:1.23-alpine
|
||||
group: test
|
||||
image: golang:1.21-alpine
|
||||
commands:
|
||||
- go test -v ./...
|
||||
|
||||
243
CHANGELOG.md
243
CHANGELOG.md
@ -1,246 +1,3 @@
|
||||
## [1.3.2-rc.3](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.2-rc.2...v1.3.2-rc.3) (2024-08-20)
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update all non-major dependencies ([65f30a6](https://git.ext.icikowski.pl/go/kubeprobes/commit/65f30a6b09628b6e58f40318279e2034f92790ba))
|
||||
|
||||
## [1.3.2-rc.2](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.2-rc.1...v1.3.2-rc.2) (2024-08-20)
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update golang docker tag to v1.23 ([0ad5148](https://git.ext.icikowski.pl/go/kubeprobes/commit/0ad514865ca927f9f87747b2710f6be9f8b43590))
|
||||
|
||||
## [1.3.2-rc.1](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.1...v1.3.2-rc.1) (2024-08-20)
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update all major dependencies ([48aa72b](https://git.ext.icikowski.pl/go/kubeprobes/commit/48aa72b3757830fb05ed136765cb7389ba1d7285))
|
||||
|
||||
## [1.3.1](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.0...v1.3.1) (2024-05-27)
|
||||
|
||||
|
||||
### Refactoring
|
||||
|
||||
* **formatting:** change line terminators from CRLF to LF ([ec44d7f](https://git.ext.icikowski.pl/go/kubeprobes/commit/ec44d7f643e78cfb1e9724b36416458782a6c775))
|
||||
* **probes:** rename `ProbeFunction` to `Probe` ([8dc7f27](https://git.ext.icikowski.pl/go/kubeprobes/commit/8dc7f27400075fabca9525f42eb20404736fb1cb))
|
||||
|
||||
|
||||
### Continuous Integrations
|
||||
|
||||
* **deps:** pin `conventional-changelog-conventionalcommits` to version 7.x ([b15846a](https://git.ext.icikowski.pl/go/kubeprobes/commit/b15846aa58864f5809e2226cad9c52770f84aae9))
|
||||
* **test:** remove `group` directive ([a1bab99](https://git.ext.icikowski.pl/go/kubeprobes/commit/a1bab99cbdbf903256be3172036fc9b8c44f9992))
|
||||
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update all non-major dependencies ([a68663c](https://git.ext.icikowski.pl/go/kubeprobes/commit/a68663cff022fa135d48fae6f00e39ea684983f1))
|
||||
* **deps:** update dependency @semantic-release/commit-analyzer to v12 ([2a79a68](https://git.ext.icikowski.pl/go/kubeprobes/commit/2a79a6878f647049ca2f01711d74561f6c4974c6))
|
||||
* **deps:** update dependency @semantic-release/npm to v12 ([fdee33a](https://git.ext.icikowski.pl/go/kubeprobes/commit/fdee33a1e7c05bd19f0f5d675df434ad4d844911))
|
||||
* **deps:** update dependency @semantic-release/release-notes-generator to v13 ([0cba4d2](https://git.ext.icikowski.pl/go/kubeprobes/commit/0cba4d2a50319cc0250dc3cb14e32dee813b4fc0))
|
||||
* **deps:** update dependency conventional-changelog-conventionalcommits to v8 ([8918072](https://git.ext.icikowski.pl/go/kubeprobes/commit/8918072d5c818bad10542957b93440730d50baf1))
|
||||
* **deps:** update dependency semantic-release to v23.0.3 ([cea539f](https://git.ext.icikowski.pl/go/kubeprobes/commit/cea539fd6d68608635ec19ae8840da749695bfac))
|
||||
* **deps:** update dependency semantic-release to v23.0.4 ([2d5b101](https://git.ext.icikowski.pl/go/kubeprobes/commit/2d5b101b8d38d7af7c6b4ba570f1045fe9e9dc7b))
|
||||
* **deps:** update dependency semantic-release to v23.0.5 ([061100e](https://git.ext.icikowski.pl/go/kubeprobes/commit/061100e432a61ed6bcb310de297880db369e2f24))
|
||||
* **deps:** update dependency semantic-release to v23.0.8 ([b98f6ef](https://git.ext.icikowski.pl/go/kubeprobes/commit/b98f6ef609c278bfbd25c25316ad166fba75f255))
|
||||
|
||||
## [1.3.1-rc.11](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.1-rc.10...v1.3.1-rc.11) (2024-05-27)
|
||||
|
||||
|
||||
### Refactoring
|
||||
|
||||
* **formatting:** change line terminators from CRLF to LF ([ec44d7f](https://git.ext.icikowski.pl/go/kubeprobes/commit/ec44d7f643e78cfb1e9724b36416458782a6c775))
|
||||
|
||||
## [1.3.1-rc.10](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.1-rc.9...v1.3.1-rc.10) (2024-05-27)
|
||||
|
||||
|
||||
### Continuous Integrations
|
||||
|
||||
* **test:** remove `group` directive ([a1bab99](https://git.ext.icikowski.pl/go/kubeprobes/commit/a1bab99cbdbf903256be3172036fc9b8c44f9992))
|
||||
|
||||
## [1.3.1-rc.9](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.1-rc.8...v1.3.1-rc.9) (2024-05-21)
|
||||
|
||||
|
||||
### Continuous Integrations
|
||||
|
||||
* **deps:** pin `conventional-changelog-conventionalcommits` to version 7.x ([b15846a](https://git.ext.icikowski.pl/go/kubeprobes/commit/b15846aa58864f5809e2226cad9c52770f84aae9))
|
||||
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update all non-major dependencies ([a68663c](https://git.ext.icikowski.pl/go/kubeprobes/commit/a68663cff022fa135d48fae6f00e39ea684983f1))
|
||||
* **deps:** update dependency conventional-changelog-conventionalcommits to v8 ([8918072](https://git.ext.icikowski.pl/go/kubeprobes/commit/8918072d5c818bad10542957b93440730d50baf1))
|
||||
|
||||
## [1.3.1-rc.8](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.1-rc.7...v1.3.1-rc.8) (2024-04-12)
|
||||
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update dependency semantic-release to v23.0.8 ([b98f6ef](https://git.ext.icikowski.pl/go/kubeprobes/commit/b98f6ef609c278bfbd25c25316ad166fba75f255))
|
||||
|
||||
## [1.3.1-rc.7](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.1-rc.6...v1.3.1-rc.7) (2024-04-12)
|
||||
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update dependency @semantic-release/release-notes-generator to v13 ([0cba4d2](https://git.ext.icikowski.pl/go/kubeprobes/commit/0cba4d2a50319cc0250dc3cb14e32dee813b4fc0))
|
||||
|
||||
## [1.3.1-rc.6](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.1-rc.5...v1.3.1-rc.6) (2024-03-23)
|
||||
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update dependency semantic-release to v23.0.5 ([061100e](https://git.ext.icikowski.pl/go/kubeprobes/commit/061100e432a61ed6bcb310de297880db369e2f24))
|
||||
|
||||
## [1.3.1-rc.5](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.1-rc.4...v1.3.1-rc.5) (2024-03-23)
|
||||
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update dependency @semantic-release/commit-analyzer to v12 ([2a79a68](https://git.ext.icikowski.pl/go/kubeprobes/commit/2a79a6878f647049ca2f01711d74561f6c4974c6))
|
||||
|
||||
## [1.3.1-rc.4](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.1-rc.3...v1.3.1-rc.4) (2024-03-17)
|
||||
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update dependency @semantic-release/npm to v12 ([fdee33a](https://git.ext.icikowski.pl/go/kubeprobes/commit/fdee33a1e7c05bd19f0f5d675df434ad4d844911))
|
||||
|
||||
## [1.3.1-rc.3](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.1-rc.2...v1.3.1-rc.3) (2024-03-17)
|
||||
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update dependency semantic-release to v23.0.4 ([2d5b101](https://git.ext.icikowski.pl/go/kubeprobes/commit/2d5b101b8d38d7af7c6b4ba570f1045fe9e9dc7b))
|
||||
|
||||
## [1.3.1-rc.2](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.1-rc.1...v1.3.1-rc.2) (2024-03-16)
|
||||
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update dependency semantic-release to v23.0.3 ([cea539f](https://git.ext.icikowski.pl/go/kubeprobes/commit/cea539fd6d68608635ec19ae8840da749695bfac))
|
||||
|
||||
## [1.3.1-rc.1](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.0...v1.3.1-rc.1) (2024-03-03)
|
||||
|
||||
|
||||
### Refactoring
|
||||
|
||||
* **probes:** rename `ProbeFunction` to `Probe` ([8dc7f27](https://git.ext.icikowski.pl/go/kubeprobes/commit/8dc7f27400075fabca9525f42eb20404736fb1cb))
|
||||
|
||||
## [1.3.0](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.2.0...v1.3.0) (2024-03-02)
|
||||
|
||||
|
||||
### ⚠ BREAKING CHANGES
|
||||
|
||||
* **probes:** type definitions were replaced with more robust implementation.
|
||||
|
||||
### Features
|
||||
|
||||
* **probes:** rewrite probes logic with named probes ([9dd25ff](https://git.ext.icikowski.pl/go/kubeprobes/commit/9dd25ff02437490dca537ac1d3c3baf71c4b6208))
|
||||
* **validation:** add empty probe lists validation ([82b6034](https://git.ext.icikowski.pl/go/kubeprobes/commit/82b6034625089450d3de734edd8eb95ea35aff2f))
|
||||
|
||||
|
||||
### Refactoring
|
||||
|
||||
* **names:** refactor handler fetching methods' names ([373c803](https://git.ext.icikowski.pl/go/kubeprobes/commit/373c803c00499a7e607cdd0ad99315dcd6e2919d))
|
||||
* **validation:** improve errors joining ([ea92b29](https://git.ext.icikowski.pl/go/kubeprobes/commit/ea92b2979cbdb67507d934725434f21b0456be03))
|
||||
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update dependency @semantic-release/npm to v11.0.3 ([203180c](https://git.ext.icikowski.pl/go/kubeprobes/commit/203180c3329ff6a5d19258d425f40b60a79429dd))
|
||||
|
||||
## [1.3.0-rc.2](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.3.0-rc.1...v1.3.0-rc.2) (2024-03-02)
|
||||
|
||||
|
||||
### ⚠ BREAKING CHANGES
|
||||
|
||||
* **probes:** type definitions were replaced with more robust implementation.
|
||||
|
||||
### Features
|
||||
|
||||
* **probes:** rewrite probes logic with named probes ([9dd25ff](https://git.ext.icikowski.pl/go/kubeprobes/commit/9dd25ff02437490dca537ac1d3c3baf71c4b6208))
|
||||
|
||||
## [1.3.0-rc.1](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.2.1-rc.1...v1.3.0-rc.1) (2024-03-02)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **validation:** add empty probe lists validation ([82b6034](https://git.ext.icikowski.pl/go/kubeprobes/commit/82b6034625089450d3de734edd8eb95ea35aff2f))
|
||||
|
||||
|
||||
### Refactoring
|
||||
|
||||
* **names:** refactor handler fetching methods' names ([373c803](https://git.ext.icikowski.pl/go/kubeprobes/commit/373c803c00499a7e607cdd0ad99315dcd6e2919d))
|
||||
* **validation:** improve errors joining ([ea92b29](https://git.ext.icikowski.pl/go/kubeprobes/commit/ea92b2979cbdb67507d934725434f21b0456be03))
|
||||
|
||||
## [1.2.1-rc.1](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.2.0...v1.2.1-rc.1) (2024-03-02)
|
||||
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update dependency @semantic-release/npm to v11.0.3 ([203180c](https://git.ext.icikowski.pl/go/kubeprobes/commit/203180c3329ff6a5d19258d425f40b60a79429dd))
|
||||
|
||||
## [1.2.0](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.1.0...v1.2.0) (2024-03-01)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **handlers:** add individual handlers fetching ([bb108ad](https://git.ext.icikowski.pl/go/kubeprobes/commit/bb108ad9baf7a14c7e39709a58987706a713d4ce))
|
||||
|
||||
|
||||
### Refactoring
|
||||
|
||||
* **kubeprobes:** refactor code ([d33e9f1](https://git.ext.icikowski.pl/go/kubeprobes/commit/d33e9f19ea353cd320d584ad093c311f66eb1b28))
|
||||
|
||||
## [1.2.0-rc.1](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.1.0...v1.2.0-rc.1) (2024-03-01)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **handlers:** add individual handlers fetching ([bb108ad](https://git.ext.icikowski.pl/go/kubeprobes/commit/bb108ad9baf7a14c7e39709a58987706a713d4ce))
|
||||
|
||||
|
||||
### Refactoring
|
||||
|
||||
* **kubeprobes:** refactor code ([d33e9f1](https://git.ext.icikowski.pl/go/kubeprobes/commit/d33e9f19ea353cd320d584ad093c311f66eb1b28))
|
||||
|
||||
## [1.1.0](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.0.0...v1.1.0) (2024-02-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **handler:** change path resolver logic ([40bad6b](https://git.ext.icikowski.pl/go/kubeprobes/commit/40bad6b3456afaf9a7d04fb0af3911f47ffd601b))
|
||||
|
||||
|
||||
### Continuous Integrations
|
||||
|
||||
* **init:** add initial CI configuration ([0db0e61](https://git.ext.icikowski.pl/go/kubeprobes/commit/0db0e614d6e6ae31b12b8629e5adaa3230bdbc45))
|
||||
* **renovate:** add Renovate bot configuration ([f5303b8](https://git.ext.icikowski.pl/go/kubeprobes/commit/f5303b85fce436d9d8114b72dee8f4b44f332c55))
|
||||
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update all non-major dependencies ([288033e](https://git.ext.icikowski.pl/go/kubeprobes/commit/288033efd050b13e877e26682c1bef8e269b2988))
|
||||
* **deps:** update dependency semantic-release to v23 ([213039e](https://git.ext.icikowski.pl/go/kubeprobes/commit/213039eaae78fce6734455ef379d492e799bc07f))
|
||||
|
||||
## [1.1.0-rc.1](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.0.1-rc.1...v1.1.0-rc.1) (2024-02-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **handler:** change path resolver logic ([40bad6b](https://git.ext.icikowski.pl/go/kubeprobes/commit/40bad6b3456afaf9a7d04fb0af3911f47ffd601b))
|
||||
|
||||
|
||||
### Continuous Integrations
|
||||
|
||||
* **renovate:** add Renovate bot configuration ([f5303b8](https://git.ext.icikowski.pl/go/kubeprobes/commit/f5303b85fce436d9d8114b72dee8f4b44f332c55))
|
||||
|
||||
|
||||
### Build system and dependencies
|
||||
|
||||
* **deps:** update all non-major dependencies ([288033e](https://git.ext.icikowski.pl/go/kubeprobes/commit/288033efd050b13e877e26682c1bef8e269b2988))
|
||||
* **deps:** update dependency semantic-release to v23 ([213039e](https://git.ext.icikowski.pl/go/kubeprobes/commit/213039eaae78fce6734455ef379d492e799bc07f))
|
||||
|
||||
## [1.0.1-rc.1](https://git.ext.icikowski.pl/go/kubeprobes/compare/v1.0.0...v1.0.1-rc.1) (2023-11-04)
|
||||
|
||||
|
||||
|
||||
106
README.md
106
README.md
@ -1,7 +1,5 @@
|
||||
# kubeprobes
|
||||
|
||||
[](https://goreportcard.com/report/pkg.icikowski.pl/kubeprobes)
|
||||
|
||||
Simple and effective package for implementing [Kubernetes liveness and readiness probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/)' handler.
|
||||
|
||||
## Installation
|
||||
@ -12,119 +10,77 @@ go get -u pkg.icikowski.pl/kubeprobes
|
||||
|
||||
## Usage
|
||||
|
||||
The package provides `kubeprobes.New` function which returns a probes handler of type `kubeprobes.Kubeprobes`, which is compliant with `http.Handler` interface.
|
||||
The package provides `kubeprobes.New` function which returns a probes handler compliant with `http.Handler` interface.
|
||||
|
||||
The handler serves two endpoints, which are used to implement liveness and readiness probes by returning either `200` (healthy) or `503` (unhealthy) status and JSON response with probes results:
|
||||
The handler serves two endpoints, which are used to implement liveness and readiness probes by returning either `200` (healthy) or `503` (unhealthy) status:
|
||||
|
||||
- `/live` - endpoint for liveness probe;
|
||||
- `/ready` - endpoint for readiness probe.
|
||||
|
||||
Default paths can be overriden with options described below. Accessing any other endpoint will return `404` status. By default, response body only contains a list of failed probes, but this behavior can be changed with provided option or by adding `?v` query parameter.
|
||||
Accessing any other endpoint will return `404` status. In order to provide maximum performance, no body is ever returned.
|
||||
|
||||
The `kubeprobes.New` function accepts following options as arguments:
|
||||
The `kubeprobes.New` function accepts following options-applying functions as arguments:
|
||||
|
||||
- `kubeprobes.WithLivenessProbes(...)` - adds particular [probes](#probes) to the list of liveness probes;
|
||||
- `kubeprobes.WithLivenessPath("/some/liveness/path")` - sets liveness probe path to given path (default is `/live`);
|
||||
- `kubeprobes.WithReadinessProbes(...)` - adds particular [probes](#probes) to the list of readiness probes;
|
||||
- `kubeprobes.WithReadinessPath("/some/readiness/path")` - sets readiness probe path to given path (default is `/ready`);
|
||||
- `kubeprobes.WithVerboseOutput()` - enables verbose output by default (returns both failed and passed probes).
|
||||
- `kubeprobes.WithLivenessProbes(/* ... */)` - adds particular [probes](#probes) to the list of liveness probes;
|
||||
- `kubeprobes.WithReadinessProbes(/* ... */)` - adds particular [probes](#probes) to the list of readiness probes.
|
||||
|
||||
## Probes
|
||||
|
||||
In order to determine the state of particular element of application, probes need to be implemented either by creating [probes from functions](#standard-probes) or by using simple and thread-safe [manual probes](#manual-probes).
|
||||
In order to determine the state of particular element of application, probes need to be implemented either by creating [status determining function](#probe-functions) or by using simple and thread-safe [stateful probes](#stateful-probes).
|
||||
|
||||
### Standard probes
|
||||
### Probe functions
|
||||
|
||||
Probes (instances of `Probe` interface) are wrappers for functions that performs user defined logic with given interval of updates in order to determine whether the probe should be marked as healthy or not. Those functions should take no arguments and return error (if no error is returned, the probe is considered to be healthy; if error is returned, the probe is considered to be unhealthy). If given interval is less or equal zero, then function is only checked on probe creation and remains in determined state forever.
|
||||
Probe functions (objects of type `ProbeFunction`) are functions that performs user defined logic in order to determine whether the probe should be marked as healthy or not. Those functions should take no arguments and return error (if no error is returned, the probe is considered to be healthy; if error is returned, the probe is considered to be unhealthy).
|
||||
|
||||
```go
|
||||
someProbe := kubeprobes.NewProbe("live", func() error {
|
||||
someProbe := func() error {
|
||||
// Some logic here
|
||||
if time.Now().Weekday() == time.Wednesday {
|
||||
// Fail only on wednesday!
|
||||
return errors.New("It's wednesday, my dudes!")
|
||||
if somethingIsWrong {
|
||||
return errors.New("something is wrong")
|
||||
}
|
||||
return nil
|
||||
}, 1 * time.Hour)
|
||||
}
|
||||
|
||||
someOtherProbe := kubeprobes.NewProbe("ready", func() error {
|
||||
someOtherProbe := func() error {
|
||||
// Always healthy
|
||||
return nil
|
||||
}, 0) // This probe is checked once
|
||||
}
|
||||
|
||||
// Use functions in probes handler
|
||||
kp, _ := kubeprobes.New(
|
||||
kp := kubeprobes.New(
|
||||
kubeprobes.WithLivenessProbes(someOtherProbe),
|
||||
kubeprobes.WithReadinessProbes(someProbe),
|
||||
)
|
||||
```
|
||||
|
||||
### Manual probes
|
||||
### Stateful probes
|
||||
|
||||
Manual probes (instances of `ManualProbe` interface) are objects that can be marked either as healthy or unhealthy and implement `Probe` for easy integration. Those objects utilize `sync.RMutex` mechanism to ensure thread-safety.
|
||||
|
||||
Those probes can be changed by user with provided methods:
|
||||
|
||||
- `Pass()` marks probe as healthy;
|
||||
- `Fail()` marks probe as unhealthy with generic cause;
|
||||
- `FailWithCause(someError)` marks probe as unhealthy with given error as cause.
|
||||
Stateful probes (objects of type `StatefulProbe`) are objects that can be marked either as "up" (healthy) or "down" (unhealthy) and provide a `ProbeFunction` for easy integration. Those objects utilize `sync.Mutex` mechanism to provide thread-safety.
|
||||
|
||||
```go
|
||||
// Unhealthy by default
|
||||
someProbe := kubeprobes.NewManualProbe("live")
|
||||
someOtherProbe := kubeprobes.NewManualProbe("ready")
|
||||
someProbe := kubeprobes.NewStatefulProbe()
|
||||
someOtherProbe := kubeprobes.NewStatefulProbe()
|
||||
|
||||
// Use it in probes handler
|
||||
kp, _ := kubeprobes.New(
|
||||
kubeprobes.WithLivenessProbes(someProbe),
|
||||
kubeprobes.WithReadinessProbes(someOtherProbe),
|
||||
kp := kubeprobes.New(
|
||||
kubeprobes.WithLivenessProbes(someProbe.GetProbeFunction()),
|
||||
kubeprobes.WithReadinessProbes(someOtherProbe.GetProbeFunction()),
|
||||
)
|
||||
|
||||
// Can be later marked according to needs
|
||||
someProbe.Pass()
|
||||
someOtherProbe.FailWithCause(errors.New("I'm not doing anything!"))
|
||||
```
|
||||
|
||||
## Direct handler access
|
||||
|
||||
It is possible to fetch `http.Handler`s for liveness & readiness probes from `kubeprobes.Kubeprobes` instance as follows:
|
||||
|
||||
```go
|
||||
kp, _ := kubeprobes.New(
|
||||
// ...
|
||||
)
|
||||
|
||||
livenessHandler := kp.LivenessHandler()
|
||||
readinessHandler := kp.ReadinessHandler()
|
||||
```
|
||||
|
||||
Those handler can be used for manually mounting them on other servers/routers/muxes (eg. `go-chi/chi`, `gorilla/mux`, `http`'s `ServeMux` etc.).
|
||||
|
||||
## Example usage
|
||||
|
||||
```go
|
||||
// Create probe functions
|
||||
appProbe := func() error {
|
||||
// Some logic for checking app status
|
||||
return nil
|
||||
}
|
||||
|
||||
// Create manual probes
|
||||
live := kubeprobes.NewManualProbe("liveness")
|
||||
ready := kubeprobes.NewManualProbe("readiness")
|
||||
// Create stateful probes
|
||||
live := kubeprobes.NewStatefulProbe()
|
||||
ready := kubeprobes.NewStatefulProbe()
|
||||
|
||||
// Prepare handler
|
||||
kp, err := kubeprobes.New(
|
||||
kubeprobes.WithLivenessProbes(live),
|
||||
kubeprobes.WithReadinessProbes(ready, appProbe),
|
||||
kubeprobes.WithLivenessPath("/livez"),
|
||||
kubeprobes.WithReadinessPath("/readyz"),
|
||||
kubeprobes.WithVerboseOutput(),
|
||||
kp := kubeprobes.New(
|
||||
kubeprobes.WithLivenessProbes(live.GetProbeFunction()),
|
||||
kubeprobes.WithReadinessProbes(ready.GetProbeFunction()),
|
||||
)
|
||||
if err != nil {
|
||||
// Kubeprobes object is validated for invalid or conflicting paths! ;)
|
||||
panic(err)
|
||||
}
|
||||
|
||||
// Start the probes server
|
||||
probes := &http.Server{
|
||||
@ -134,6 +90,6 @@ probes := &http.Server{
|
||||
go probes.ListenAndServe()
|
||||
|
||||
// Mark probes as healthy
|
||||
live.Pass()
|
||||
ready.Pass()
|
||||
live.MarkAsUp()
|
||||
ready.MarkAsUp()
|
||||
```
|
||||
|
||||
44
commons.go
Normal file
44
commons.go
Normal file
@ -0,0 +1,44 @@
|
||||
package kubeprobes
|
||||
|
||||
import "sync"
|
||||
|
||||
// ProbeFunction is a function that determines whether
|
||||
// the given metric may be marked as correctly functioning.
|
||||
// It not, the error should be returned.
|
||||
type ProbeFunction func() error
|
||||
|
||||
type statusQuery struct {
|
||||
allGreen bool
|
||||
mux sync.Mutex
|
||||
wg sync.WaitGroup
|
||||
}
|
||||
|
||||
func (sq *statusQuery) isAllGreen() bool {
|
||||
sq.wg.Wait()
|
||||
sq.mux.Lock()
|
||||
defer sq.mux.Unlock()
|
||||
return sq.allGreen
|
||||
}
|
||||
|
||||
func newStatusQuery(probes []ProbeFunction) *statusQuery {
|
||||
sq := &statusQuery{
|
||||
allGreen: true,
|
||||
mux: sync.Mutex{},
|
||||
wg: sync.WaitGroup{},
|
||||
}
|
||||
|
||||
sq.wg.Add(len(probes))
|
||||
for _, probe := range probes {
|
||||
probe := probe
|
||||
go func() {
|
||||
defer sq.wg.Done()
|
||||
if err := probe(); err != nil {
|
||||
sq.mux.Lock()
|
||||
sq.allGreen = false
|
||||
sq.mux.Unlock()
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
return sq
|
||||
}
|
||||
45
commons_test.go
Normal file
45
commons_test.go
Normal file
@ -0,0 +1,45 @@
|
||||
package kubeprobes
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func TestStatusQueryIsAllGreen(t *testing.T) {
|
||||
tests := map[string]struct {
|
||||
probes []ProbeFunction
|
||||
expectedStatus bool
|
||||
}{
|
||||
"all green": {
|
||||
probes: []ProbeFunction{
|
||||
func() error { return nil },
|
||||
func() error { time.Sleep(2 * time.Second); return nil },
|
||||
},
|
||||
expectedStatus: true,
|
||||
},
|
||||
"some failed": {
|
||||
probes: []ProbeFunction{
|
||||
func() error { return nil },
|
||||
func() error { time.Sleep(2 * time.Second); return errors.New("failed") },
|
||||
},
|
||||
expectedStatus: false,
|
||||
},
|
||||
"all failed": {
|
||||
probes: []ProbeFunction{
|
||||
func() error { return errors.New("failed") },
|
||||
func() error { time.Sleep(2 * time.Second); return errors.New("failed") },
|
||||
},
|
||||
expectedStatus: false,
|
||||
},
|
||||
}
|
||||
|
||||
for name, test := range tests {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
sq := newStatusQuery(test.probes)
|
||||
if sq.isAllGreen() != test.expectedStatus {
|
||||
t.Errorf("expected status %v, got %v", test.expectedStatus, sq.isAllGreen())
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
21
costants.go
21
costants.go
@ -1,21 +0,0 @@
|
||||
package kubeprobes
|
||||
|
||||
import (
|
||||
"errors"
|
||||
)
|
||||
|
||||
const (
|
||||
defaultLivenessPath string = "/live"
|
||||
defaultReadinessPath string = "/ready"
|
||||
verboseOutputFlag string = "v"
|
||||
)
|
||||
|
||||
const (
|
||||
headerContentType string = "Content-Type"
|
||||
contentTypeJSON string = "application/json"
|
||||
)
|
||||
|
||||
var (
|
||||
errProbeNameEmpty error = errors.New("probe name must not be empty")
|
||||
errProbeFailed error = errors.New("probe marked as failed")
|
||||
)
|
||||
147
kubeprobes.go
147
kubeprobes.go
@ -1,147 +0,0 @@
|
||||
package kubeprobes
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// Kubeprobes represents liveness & readiness probes handler.
|
||||
type Kubeprobes interface {
|
||||
http.Handler
|
||||
|
||||
// LivenessHandler returns [http.Handler] for liveness probes.
|
||||
LivenessHandler() http.Handler
|
||||
// ReadinessHandler returns [http.Handler] for readiness probes.
|
||||
ReadinessHandler() http.Handler
|
||||
}
|
||||
|
||||
type kubeprobes struct {
|
||||
livenessProbes []Probe
|
||||
readinessProbes []Probe
|
||||
|
||||
verbose bool
|
||||
|
||||
pathLive string
|
||||
pathReady string
|
||||
}
|
||||
|
||||
// New returns a new instance of a Kubernetes probes with given options.
|
||||
func New(options ...Option) (Kubeprobes, error) {
|
||||
kp := &kubeprobes{
|
||||
livenessProbes: []Probe{},
|
||||
readinessProbes: []Probe{},
|
||||
pathLive: defaultLivenessPath,
|
||||
pathReady: defaultReadinessPath,
|
||||
}
|
||||
|
||||
for _, option := range options {
|
||||
option.apply(kp)
|
||||
}
|
||||
|
||||
if err := kp.validate(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return kp, nil
|
||||
}
|
||||
|
||||
func (kp *kubeprobes) validate() error {
|
||||
var err error
|
||||
|
||||
if kp.pathLive == "" {
|
||||
err = errors.Join(err, fmt.Errorf("liveness probe path must not be empty"))
|
||||
}
|
||||
|
||||
if kp.pathReady == "" {
|
||||
err = errors.Join(err, fmt.Errorf("readiness probe path must not be empty"))
|
||||
}
|
||||
|
||||
if !strings.HasPrefix(kp.pathLive, "/") {
|
||||
err = errors.Join(err, fmt.Errorf("liveness probe path must start with slash (current: %q)", kp.pathLive))
|
||||
}
|
||||
|
||||
if !strings.HasPrefix(kp.pathReady, "/") {
|
||||
err = errors.Join(err, fmt.Errorf("readiness probe path must start with slash (current: %q)", kp.pathReady))
|
||||
}
|
||||
|
||||
if kp.pathLive == kp.pathReady {
|
||||
err = errors.Join(err, fmt.Errorf("liveness and readiness probes have the same values (both %q)", kp.pathLive))
|
||||
}
|
||||
|
||||
if len(kp.livenessProbes) == 0 {
|
||||
err = errors.Join(err, fmt.Errorf("no liveness probes defined"))
|
||||
}
|
||||
|
||||
if len(kp.readinessProbes) == 0 {
|
||||
err = errors.Join(err, fmt.Errorf("no readiness probes defined"))
|
||||
}
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
type probesResponse struct {
|
||||
Passed []statusEntry `json:"passed,omitempty"`
|
||||
Failed []statusEntry `json:"failed,omitempty"`
|
||||
}
|
||||
|
||||
func (kp *kubeprobes) handleLiveness(w http.ResponseWriter, r *http.Request) {
|
||||
sq := newStatusQuery(kp.livenessProbes)
|
||||
output := probesResponse{}
|
||||
|
||||
sq.wait()
|
||||
output.Failed = sq.failed
|
||||
if r.URL.Query().Has(verboseOutputFlag) || kp.verbose {
|
||||
output.Passed = sq.passed
|
||||
}
|
||||
|
||||
w.Header().Add(headerContentType, contentTypeJSON)
|
||||
if sq.ok {
|
||||
w.WriteHeader(http.StatusOK)
|
||||
} else {
|
||||
w.WriteHeader(http.StatusServiceUnavailable)
|
||||
}
|
||||
_ = json.NewEncoder(w).Encode(output)
|
||||
}
|
||||
|
||||
func (kp *kubeprobes) handleReadiness(w http.ResponseWriter, r *http.Request) {
|
||||
sq := newStatusQuery(append(kp.livenessProbes, kp.readinessProbes...))
|
||||
output := probesResponse{}
|
||||
|
||||
sq.wait()
|
||||
output.Failed = sq.failed
|
||||
if r.URL.Query().Has(verboseOutputFlag) || kp.verbose {
|
||||
output.Passed = sq.passed
|
||||
}
|
||||
|
||||
w.Header().Add(headerContentType, contentTypeJSON)
|
||||
if sq.ok {
|
||||
w.WriteHeader(http.StatusOK)
|
||||
} else {
|
||||
w.WriteHeader(http.StatusServiceUnavailable)
|
||||
}
|
||||
_ = json.NewEncoder(w).Encode(output)
|
||||
}
|
||||
|
||||
// LivenessHandler implements Kubeprobes.
|
||||
func (kp *kubeprobes) LivenessHandler() http.Handler {
|
||||
return http.HandlerFunc(kp.handleLiveness)
|
||||
}
|
||||
|
||||
// ReadinessHandler implements Kubeprobes.
|
||||
func (kp *kubeprobes) ReadinessHandler() http.Handler {
|
||||
return http.HandlerFunc(kp.handleReadiness)
|
||||
}
|
||||
|
||||
// ServeHTTP implements Kubeprobes.
|
||||
func (kp *kubeprobes) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||
switch r.URL.Path {
|
||||
case kp.pathLive:
|
||||
kp.handleLiveness(w, r)
|
||||
case kp.pathReady:
|
||||
kp.handleReadiness(w, r)
|
||||
default:
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
}
|
||||
}
|
||||
@ -1,47 +0,0 @@
|
||||
package kubeprobes
|
||||
|
||||
// Option represents a [Kubeprobes] constructor option.
|
||||
type Option interface {
|
||||
apply(kp *kubeprobes)
|
||||
}
|
||||
|
||||
type option func(*kubeprobes)
|
||||
|
||||
func (o option) apply(kp *kubeprobes) {
|
||||
o(kp)
|
||||
}
|
||||
|
||||
// WithLivenessProbes adds given probe functions to the set of liveness probes.
|
||||
func WithLivenessProbes(probes ...Probe) Option {
|
||||
return option(func(kp *kubeprobes) {
|
||||
kp.livenessProbes = append(kp.livenessProbes, probes...)
|
||||
})
|
||||
}
|
||||
|
||||
// WithLivenessPath sets custom path for liveness probe (default is "/live").
|
||||
func WithLivenessPath(path string) Option {
|
||||
return option(func(kp *kubeprobes) {
|
||||
kp.pathLive = path
|
||||
})
|
||||
}
|
||||
|
||||
// WithReadinessProbes adds given probe functions to the set of readiness probes.
|
||||
func WithReadinessProbes(probes ...Probe) Option {
|
||||
return option(func(kp *kubeprobes) {
|
||||
kp.readinessProbes = append(kp.readinessProbes, probes...)
|
||||
})
|
||||
}
|
||||
|
||||
// WithReadinessPath sets custom path for readiness probe (default is "/ready").
|
||||
func WithReadinessPath(path string) Option {
|
||||
return option(func(kp *kubeprobes) {
|
||||
kp.pathReady = path
|
||||
})
|
||||
}
|
||||
|
||||
// WithVerboseOutput enables verbose output for every request.
|
||||
func WithVerboseOutput() Option {
|
||||
return option(func(kp *kubeprobes) {
|
||||
kp.verbose = true
|
||||
})
|
||||
}
|
||||
@ -1,182 +0,0 @@
|
||||
package kubeprobes
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func getStatusFromEndpoint(t *testing.T, client *http.Client, endpoint string) int {
|
||||
t.Helper()
|
||||
resp, err := client.Get(endpoint)
|
||||
if err != nil {
|
||||
t.Errorf("error getting status from endpoint: %s", err)
|
||||
}
|
||||
return resp.StatusCode
|
||||
}
|
||||
|
||||
func TestValidation(t *testing.T) {
|
||||
var (
|
||||
live, _ = NewManualProbe("live")
|
||||
ready, _ = NewManualProbe("ready")
|
||||
)
|
||||
|
||||
tests := map[string]struct {
|
||||
opts []Option
|
||||
expectedError bool
|
||||
}{
|
||||
"no modifications and no error": {
|
||||
opts: []Option{
|
||||
WithLivenessProbes(live),
|
||||
WithReadinessProbes(ready),
|
||||
},
|
||||
},
|
||||
"modifications and no error": {
|
||||
opts: []Option{
|
||||
WithLivenessProbes(live),
|
||||
WithReadinessProbes(ready),
|
||||
WithLivenessPath("/livez"),
|
||||
WithReadinessPath("/readyz"),
|
||||
},
|
||||
},
|
||||
"missing liveness probes": {
|
||||
opts: []Option{
|
||||
WithReadinessProbes(ready),
|
||||
},
|
||||
expectedError: true,
|
||||
},
|
||||
"missing readiness probes": {
|
||||
opts: []Option{
|
||||
WithLivenessProbes(live),
|
||||
},
|
||||
expectedError: true,
|
||||
},
|
||||
"liveness probe path empty": {
|
||||
opts: []Option{
|
||||
WithLivenessProbes(live),
|
||||
WithReadinessProbes(ready),
|
||||
WithLivenessPath(""),
|
||||
},
|
||||
expectedError: true,
|
||||
},
|
||||
"readiness probe path empty": {
|
||||
opts: []Option{
|
||||
WithLivenessProbes(live),
|
||||
WithReadinessProbes(ready),
|
||||
WithReadinessPath(""),
|
||||
},
|
||||
expectedError: true,
|
||||
},
|
||||
"liveness probe path does not start with slash": {
|
||||
opts: []Option{
|
||||
WithLivenessProbes(live),
|
||||
WithReadinessProbes(ready),
|
||||
WithLivenessPath("livez"),
|
||||
},
|
||||
expectedError: true,
|
||||
},
|
||||
"readiness probe path does not start with slash": {
|
||||
opts: []Option{
|
||||
WithLivenessProbes(live),
|
||||
WithReadinessProbes(ready),
|
||||
WithReadinessPath("readyz"),
|
||||
},
|
||||
expectedError: true,
|
||||
},
|
||||
"liveness and readiness probe paths are equal": {
|
||||
opts: []Option{
|
||||
WithLivenessProbes(live),
|
||||
WithReadinessProbes(ready),
|
||||
WithLivenessPath("/check"),
|
||||
WithReadinessPath("/check"),
|
||||
},
|
||||
expectedError: true,
|
||||
},
|
||||
}
|
||||
|
||||
for name, tc := range tests {
|
||||
name, tc := name, tc
|
||||
t.Run(name, func(t *testing.T) {
|
||||
_, err := New(tc.opts...)
|
||||
switch {
|
||||
case err == nil && tc.expectedError:
|
||||
t.Error("expected error, but no error was returned")
|
||||
case err != nil && !tc.expectedError:
|
||||
t.Errorf("expected no error but got %v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandler(t *testing.T) {
|
||||
var (
|
||||
live, _ = NewManualProbe("live")
|
||||
ready, _ = NewManualProbe("ready")
|
||||
)
|
||||
|
||||
tests := map[string]struct {
|
||||
livenessProbeTransformation func(*testing.T, ManualProbe)
|
||||
readinessProbeTransformation func(*testing.T, ManualProbe)
|
||||
expectedLiveStatus int
|
||||
expectedReadyStatus int
|
||||
}{
|
||||
"not live": {
|
||||
livenessProbeTransformation: markAsDown,
|
||||
readinessProbeTransformation: markAsDown,
|
||||
expectedLiveStatus: http.StatusServiceUnavailable,
|
||||
expectedReadyStatus: http.StatusServiceUnavailable,
|
||||
},
|
||||
"live but not ready": {
|
||||
livenessProbeTransformation: markAsUp,
|
||||
readinessProbeTransformation: markAsDown,
|
||||
expectedLiveStatus: http.StatusOK,
|
||||
expectedReadyStatus: http.StatusServiceUnavailable,
|
||||
},
|
||||
"live and ready": {
|
||||
livenessProbeTransformation: markAsUp,
|
||||
readinessProbeTransformation: markAsUp,
|
||||
expectedLiveStatus: http.StatusOK,
|
||||
expectedReadyStatus: http.StatusOK,
|
||||
},
|
||||
"ready but not live - should never happen": {
|
||||
livenessProbeTransformation: markAsDown,
|
||||
readinessProbeTransformation: markAsUp,
|
||||
expectedLiveStatus: http.StatusServiceUnavailable,
|
||||
expectedReadyStatus: http.StatusServiceUnavailable,
|
||||
},
|
||||
}
|
||||
|
||||
kp, err := New(
|
||||
WithLivenessProbes(live),
|
||||
WithReadinessProbes(ready),
|
||||
)
|
||||
if err != nil {
|
||||
t.Errorf("expected no error, got %v", err)
|
||||
}
|
||||
|
||||
srv := httptest.NewServer(kp)
|
||||
defer srv.Close()
|
||||
client := srv.Client()
|
||||
|
||||
for name, test := range tests {
|
||||
name, test := name, test
|
||||
t.Run(name, func(t *testing.T) {
|
||||
test.livenessProbeTransformation(t, live)
|
||||
test.readinessProbeTransformation(t, ready)
|
||||
|
||||
liveStatus := getStatusFromEndpoint(t, client, srv.URL+defaultLivenessPath)
|
||||
readyStatus := getStatusFromEndpoint(t, client, srv.URL+defaultReadinessPath)
|
||||
otherStatus := getStatusFromEndpoint(t, client, srv.URL+"/something")
|
||||
|
||||
if liveStatus != test.expectedLiveStatus {
|
||||
t.Errorf("expected live status %d, got %d", test.expectedLiveStatus, liveStatus)
|
||||
}
|
||||
if readyStatus != test.expectedReadyStatus {
|
||||
t.Errorf("expected ready status %d, got %d", test.expectedReadyStatus, readyStatus)
|
||||
}
|
||||
if otherStatus != http.StatusNotFound {
|
||||
t.Errorf("expected 404 status, got %d", otherStatus)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
3689
package-lock.json
generated
3689
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
12
package.json
12
package.json
@ -1,18 +1,18 @@
|
||||
{
|
||||
"private": true,
|
||||
"name": "kubeprobes",
|
||||
"version": "1.3.2-rc.3",
|
||||
"version": "1.0.1-rc.1",
|
||||
"scripts": {
|
||||
"release": "./node_modules/.bin/semantic-release"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@saithodev/semantic-release-gitea": "^2.1.0",
|
||||
"@semantic-release/changelog": "^6.0.3",
|
||||
"@semantic-release/commit-analyzer": "^13.0.0",
|
||||
"@semantic-release/commit-analyzer": "^11.0.0",
|
||||
"@semantic-release/git": "^10.0.1",
|
||||
"@semantic-release/npm": "^12.0.0",
|
||||
"@semantic-release/release-notes-generator": "^14.0.0",
|
||||
"conventional-changelog-conventionalcommits": "^8.0.0",
|
||||
"semantic-release": "^24.0.0"
|
||||
"@semantic-release/npm": "^11.0.1",
|
||||
"@semantic-release/release-notes-generator": "^12.0.1",
|
||||
"conventional-changelog-conventionalcommits": "^7.0.2",
|
||||
"semantic-release": "^22.0.7"
|
||||
}
|
||||
}
|
||||
|
||||
81
probe.go
81
probe.go
@ -1,81 +0,0 @@
|
||||
package kubeprobes
|
||||
|
||||
import (
|
||||
"sync"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Probe is a wrapper for a function that determines whether
|
||||
// the given metric may be marked as correctly functioning.
|
||||
// It not, the error should be returned.
|
||||
type Probe interface {
|
||||
name() string
|
||||
status() error
|
||||
}
|
||||
|
||||
type probe struct {
|
||||
probeName string
|
||||
probeFunc func() error
|
||||
refreshInterval time.Duration
|
||||
|
||||
mux sync.RWMutex
|
||||
err error
|
||||
}
|
||||
|
||||
// NewProbe returns new instance of [Probe].
|
||||
//
|
||||
// If update interval is less or equal zero then probe is updated only
|
||||
// on its creation and remains in the same state forever.
|
||||
func NewProbe(
|
||||
name string,
|
||||
fn func() error,
|
||||
updateInterval time.Duration,
|
||||
) (Probe, error) {
|
||||
if name == "" {
|
||||
return nil, errProbeNameEmpty
|
||||
}
|
||||
|
||||
pf := &probe{
|
||||
probeName: name,
|
||||
probeFunc: fn,
|
||||
refreshInterval: updateInterval,
|
||||
mux: sync.RWMutex{},
|
||||
}
|
||||
|
||||
defer pf.autoUpdate()
|
||||
return pf, nil
|
||||
}
|
||||
|
||||
// name implements ProbeFunction.
|
||||
func (pf *probe) name() string {
|
||||
return pf.probeName
|
||||
}
|
||||
|
||||
// status implements ProbeFunction.
|
||||
func (pf *probe) status() error {
|
||||
pf.mux.RLock()
|
||||
defer pf.mux.RUnlock()
|
||||
return pf.err
|
||||
}
|
||||
|
||||
func (pf *probe) update() {
|
||||
err := pf.probeFunc()
|
||||
pf.mux.Lock()
|
||||
pf.err = err
|
||||
pf.mux.Unlock()
|
||||
}
|
||||
|
||||
func (pf *probe) autoUpdate() {
|
||||
pf.update()
|
||||
if pf.refreshInterval <= 0 {
|
||||
return
|
||||
}
|
||||
|
||||
go func() {
|
||||
ticker := time.NewTicker(pf.refreshInterval)
|
||||
for {
|
||||
<-ticker.C
|
||||
pf.update()
|
||||
}
|
||||
}()
|
||||
}
|
||||
@ -1,71 +0,0 @@
|
||||
package kubeprobes
|
||||
|
||||
import (
|
||||
"sync"
|
||||
)
|
||||
|
||||
// ManualProbe represents the simple probe that can be either
|
||||
// marked as "up" (healthy) or "down" (unhealthy).
|
||||
type ManualProbe interface {
|
||||
Probe
|
||||
|
||||
// Pass marks the probe as healthy.
|
||||
Pass()
|
||||
// Fail marks the probe as unhealthy.
|
||||
Fail()
|
||||
// FailWitCause marks the probe as unhealthy with given cause.
|
||||
FailWithCause(err error)
|
||||
}
|
||||
|
||||
type manualProbe struct {
|
||||
probeName string
|
||||
err error
|
||||
mux sync.RWMutex
|
||||
}
|
||||
|
||||
// NewManualProbe returns a new instance of a manual probe
|
||||
// which can be either marked as healthy or unhealthy.
|
||||
// The probe is initially marked as unhealthy.
|
||||
func NewManualProbe(name string) (ManualProbe, error) {
|
||||
if name == "" {
|
||||
return nil, errProbeNameEmpty
|
||||
}
|
||||
|
||||
return &manualProbe{
|
||||
probeName: name,
|
||||
mux: sync.RWMutex{},
|
||||
}, nil
|
||||
}
|
||||
|
||||
// name implements ManualProbe.
|
||||
func (mp *manualProbe) name() string {
|
||||
return mp.probeName
|
||||
}
|
||||
|
||||
// status implements ManualProbe.
|
||||
func (mp *manualProbe) status() error {
|
||||
mp.mux.RLock()
|
||||
defer mp.mux.RUnlock()
|
||||
return mp.err
|
||||
}
|
||||
|
||||
// Pass implements ManualProbe.
|
||||
func (mp *manualProbe) Pass() {
|
||||
mp.mux.Lock()
|
||||
defer mp.mux.Unlock()
|
||||
mp.err = nil
|
||||
}
|
||||
|
||||
// Fail implements ManualProbe.
|
||||
func (mp *manualProbe) Fail() {
|
||||
mp.mux.Lock()
|
||||
defer mp.mux.Unlock()
|
||||
mp.err = errProbeFailed
|
||||
}
|
||||
|
||||
// FailWithCause implements ManualProbe.
|
||||
func (mp *manualProbe) FailWithCause(err error) {
|
||||
mp.mux.Lock()
|
||||
defer mp.mux.Unlock()
|
||||
mp.err = err
|
||||
}
|
||||
@ -1,46 +0,0 @@
|
||||
package kubeprobes
|
||||
|
||||
import "testing"
|
||||
|
||||
var (
|
||||
markAsDown func(*testing.T, ManualProbe) = func(t *testing.T, sp ManualProbe) {
|
||||
t.Helper()
|
||||
sp.Fail()
|
||||
}
|
||||
markAsUp func(*testing.T, ManualProbe) = func(t *testing.T, sp ManualProbe) {
|
||||
t.Helper()
|
||||
sp.Pass()
|
||||
}
|
||||
)
|
||||
|
||||
func TestManualProbe(t *testing.T) {
|
||||
tests := map[string]struct {
|
||||
probeTransformation func(*testing.T, ManualProbe)
|
||||
expectedError bool
|
||||
}{
|
||||
"mark as up": {
|
||||
probeTransformation: markAsUp,
|
||||
expectedError: false,
|
||||
},
|
||||
"mark as down": {
|
||||
probeTransformation: markAsDown,
|
||||
expectedError: true,
|
||||
},
|
||||
}
|
||||
|
||||
for name, tc := range tests {
|
||||
name, tc := name, tc
|
||||
t.Run(name, func(t *testing.T) {
|
||||
sp, _ := NewManualProbe("some name")
|
||||
tc.probeTransformation(t, sp)
|
||||
err := sp.status()
|
||||
|
||||
switch {
|
||||
case err == nil && tc.expectedError:
|
||||
t.Error("expected error, but no error was returned")
|
||||
case err != nil && !tc.expectedError:
|
||||
t.Errorf("expected no error but got %v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
62
probes.go
Normal file
62
probes.go
Normal file
@ -0,0 +1,62 @@
|
||||
package kubeprobes
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
)
|
||||
|
||||
type kubeprobes struct {
|
||||
livenessProbes []ProbeFunction
|
||||
readinessProbes []ProbeFunction
|
||||
}
|
||||
|
||||
// ServeHTTP implements http.Handler interface
|
||||
func (kp *kubeprobes) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||
switch r.URL.Path {
|
||||
case "/live":
|
||||
sq := newStatusQuery(kp.livenessProbes)
|
||||
if sq.isAllGreen() {
|
||||
w.WriteHeader(http.StatusOK)
|
||||
} else {
|
||||
w.WriteHeader(http.StatusServiceUnavailable)
|
||||
}
|
||||
case "/ready":
|
||||
sq := newStatusQuery(append(kp.livenessProbes, kp.readinessProbes...))
|
||||
if sq.isAllGreen() {
|
||||
w.WriteHeader(http.StatusOK)
|
||||
} else {
|
||||
w.WriteHeader(http.StatusServiceUnavailable)
|
||||
}
|
||||
default:
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
}
|
||||
}
|
||||
|
||||
type option func(*kubeprobes)
|
||||
|
||||
// New returns a new instance of a Kubernetes probes
|
||||
func New(options ...option) *kubeprobes {
|
||||
kp := &kubeprobes{
|
||||
livenessProbes: []ProbeFunction{},
|
||||
readinessProbes: []ProbeFunction{},
|
||||
}
|
||||
|
||||
for _, option := range options {
|
||||
option(kp)
|
||||
}
|
||||
|
||||
return kp
|
||||
}
|
||||
|
||||
// WithLivenessProbes adds given liveness probes to the set of probes
|
||||
func WithLivenessProbes(probes ...ProbeFunction) option {
|
||||
return func(kp *kubeprobes) {
|
||||
kp.livenessProbes = append(kp.livenessProbes, probes...)
|
||||
}
|
||||
}
|
||||
|
||||
// WithReadinessProbes adds given readiness probes to the set of probes
|
||||
func WithReadinessProbes(probes ...ProbeFunction) option {
|
||||
return func(kp *kubeprobes) {
|
||||
kp.readinessProbes = append(kp.readinessProbes, probes...)
|
||||
}
|
||||
}
|
||||
83
probes_test.go
Normal file
83
probes_test.go
Normal file
@ -0,0 +1,83 @@
|
||||
package kubeprobes
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func getStatusFromEndpoint(t *testing.T, client *http.Client, endpoint string) int {
|
||||
t.Helper()
|
||||
resp, err := client.Get(endpoint)
|
||||
if err != nil {
|
||||
t.Errorf("error getting status from endpoint: %s", err)
|
||||
}
|
||||
return resp.StatusCode
|
||||
}
|
||||
|
||||
func TestKubeprobes(t *testing.T) {
|
||||
live, ready := NewStatefulProbe(), NewStatefulProbe()
|
||||
|
||||
tests := map[string]struct {
|
||||
livenessProbeTransformation func(*testing.T, *StatefulProbe)
|
||||
readinessProbeTransformation func(*testing.T, *StatefulProbe)
|
||||
expectedLiveStatus int
|
||||
expectedReadyStatus int
|
||||
}{
|
||||
"not live": {
|
||||
livenessProbeTransformation: markAsDown,
|
||||
readinessProbeTransformation: markAsDown,
|
||||
expectedLiveStatus: http.StatusServiceUnavailable,
|
||||
expectedReadyStatus: http.StatusServiceUnavailable,
|
||||
},
|
||||
"live but not ready": {
|
||||
livenessProbeTransformation: markAsUp,
|
||||
readinessProbeTransformation: markAsDown,
|
||||
expectedLiveStatus: http.StatusOK,
|
||||
expectedReadyStatus: http.StatusServiceUnavailable,
|
||||
},
|
||||
"live and ready": {
|
||||
livenessProbeTransformation: markAsUp,
|
||||
readinessProbeTransformation: markAsUp,
|
||||
expectedLiveStatus: http.StatusOK,
|
||||
expectedReadyStatus: http.StatusOK,
|
||||
},
|
||||
"ready but not live - should never happen": {
|
||||
livenessProbeTransformation: markAsDown,
|
||||
readinessProbeTransformation: markAsUp,
|
||||
expectedLiveStatus: http.StatusServiceUnavailable,
|
||||
expectedReadyStatus: http.StatusServiceUnavailable,
|
||||
},
|
||||
}
|
||||
|
||||
kp := New(
|
||||
WithLivenessProbes(live.GetProbeFunction()),
|
||||
WithReadinessProbes(ready.GetProbeFunction()),
|
||||
)
|
||||
|
||||
srv := httptest.NewServer(kp)
|
||||
defer srv.Close()
|
||||
client := srv.Client()
|
||||
|
||||
for name, test := range tests {
|
||||
name, test := name, test
|
||||
t.Run(name, func(t *testing.T) {
|
||||
test.livenessProbeTransformation(t, live)
|
||||
test.readinessProbeTransformation(t, ready)
|
||||
|
||||
liveStatus := getStatusFromEndpoint(t, client, srv.URL+"/live")
|
||||
readyStatus := getStatusFromEndpoint(t, client, srv.URL+"/ready")
|
||||
otherStatus := getStatusFromEndpoint(t, client, srv.URL+"/something")
|
||||
|
||||
if liveStatus != test.expectedLiveStatus {
|
||||
t.Errorf("expected live status %d, got %d", test.expectedLiveStatus, liveStatus)
|
||||
}
|
||||
if readyStatus != test.expectedReadyStatus {
|
||||
t.Errorf("expected ready status %d, got %d", test.expectedReadyStatus, readyStatus)
|
||||
}
|
||||
if otherStatus != http.StatusNotFound {
|
||||
t.Errorf("expected 404 status, got %d", otherStatus)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
54
query.go
54
query.go
@ -1,54 +0,0 @@
|
||||
package kubeprobes
|
||||
|
||||
import "sync"
|
||||
|
||||
type statusQuery struct {
|
||||
ok bool
|
||||
passed []statusEntry
|
||||
failed []statusEntry
|
||||
|
||||
mux sync.Mutex
|
||||
wg sync.WaitGroup
|
||||
}
|
||||
|
||||
type statusEntry struct {
|
||||
Probe string `json:"probe"`
|
||||
Status error `json:"status,omitempty"`
|
||||
}
|
||||
|
||||
func (sq *statusQuery) wait() {
|
||||
sq.wg.Wait()
|
||||
}
|
||||
|
||||
func newStatusQuery(probes []Probe) *statusQuery {
|
||||
sq := &statusQuery{
|
||||
ok: true,
|
||||
passed: make([]statusEntry, 0, len(probes)),
|
||||
failed: make([]statusEntry, 0, len(probes)),
|
||||
mux: sync.Mutex{},
|
||||
wg: sync.WaitGroup{},
|
||||
}
|
||||
|
||||
sq.wg.Add(len(probes))
|
||||
for _, probe := range probes {
|
||||
probe := probe
|
||||
go func() {
|
||||
defer sq.wg.Done()
|
||||
sq.mux.Lock()
|
||||
if err := probe.status(); err != nil {
|
||||
sq.ok = false
|
||||
sq.failed = append(sq.failed, statusEntry{
|
||||
Probe: probe.name(),
|
||||
Status: err,
|
||||
})
|
||||
} else {
|
||||
sq.passed = append(sq.passed, statusEntry{
|
||||
Probe: probe.name(),
|
||||
})
|
||||
}
|
||||
sq.mux.Unlock()
|
||||
}()
|
||||
}
|
||||
|
||||
return sq
|
||||
}
|
||||
@ -1,44 +0,0 @@
|
||||
package kubeprobes
|
||||
|
||||
import (
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestStatusQueryIsAllGreen(t *testing.T) {
|
||||
var (
|
||||
probePassing, _ = NewProbe("pass", func() error {
|
||||
return nil
|
||||
}, 0)
|
||||
probeFailing, _ = NewProbe("fail", func() error {
|
||||
return errProbeFailed
|
||||
}, 0)
|
||||
)
|
||||
|
||||
tests := map[string]struct {
|
||||
probes []Probe
|
||||
expectedStatus bool
|
||||
}{
|
||||
"all green": {
|
||||
probes: []Probe{probePassing},
|
||||
expectedStatus: true,
|
||||
},
|
||||
"some failed": {
|
||||
probes: []Probe{probePassing, probeFailing},
|
||||
expectedStatus: false,
|
||||
},
|
||||
"all failed": {
|
||||
probes: []Probe{probeFailing},
|
||||
expectedStatus: false,
|
||||
},
|
||||
}
|
||||
|
||||
for name, test := range tests {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
sq := newStatusQuery(test.probes)
|
||||
sq.wait()
|
||||
if sq.ok != test.expectedStatus {
|
||||
t.Errorf("expected status %v, got %v", test.expectedStatus, sq.ok)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
52
stateful_probe.go
Normal file
52
stateful_probe.go
Normal file
@ -0,0 +1,52 @@
|
||||
package kubeprobes
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"sync"
|
||||
)
|
||||
|
||||
var errProbeDown = errors.New("DOWN")
|
||||
|
||||
// StatefulProbe represents the simple probe that can be either
|
||||
// marked as "up" (healthy) or "down" (unhealthy).
|
||||
type StatefulProbe struct {
|
||||
status bool
|
||||
mux sync.Mutex
|
||||
}
|
||||
|
||||
// NewStatefulProbe returns a new instance of a stateful probe
|
||||
// which can be either marked as "up" (healthy) or "down" (unhealthy).
|
||||
// The probe is initially marked as "down".
|
||||
func NewStatefulProbe() *StatefulProbe {
|
||||
return &StatefulProbe{
|
||||
status: false,
|
||||
mux: sync.Mutex{},
|
||||
}
|
||||
}
|
||||
|
||||
// MarkAsUp marks the probe as healthy
|
||||
func (sp *StatefulProbe) MarkAsUp() {
|
||||
sp.mux.Lock()
|
||||
defer sp.mux.Unlock()
|
||||
sp.status = true
|
||||
}
|
||||
|
||||
// MarkAsDown marks the probe as unhealthy
|
||||
func (sp *StatefulProbe) MarkAsDown() {
|
||||
sp.mux.Lock()
|
||||
defer sp.mux.Unlock()
|
||||
sp.status = false
|
||||
}
|
||||
|
||||
// GetProbeFunction returns a function that can be used to check
|
||||
// whether the probe is healthy or not.
|
||||
func (sp *StatefulProbe) GetProbeFunction() ProbeFunction {
|
||||
return func() error {
|
||||
sp.mux.Lock()
|
||||
defer sp.mux.Unlock()
|
||||
if sp.status {
|
||||
return nil
|
||||
}
|
||||
return errProbeDown
|
||||
}
|
||||
}
|
||||
42
stateful_probe_test.go
Normal file
42
stateful_probe_test.go
Normal file
@ -0,0 +1,42 @@
|
||||
package kubeprobes
|
||||
|
||||
import "testing"
|
||||
|
||||
var (
|
||||
markAsDown func(*testing.T, *StatefulProbe) = func(t *testing.T, sp *StatefulProbe) {
|
||||
t.Helper()
|
||||
sp.MarkAsDown()
|
||||
}
|
||||
markAsUp func(*testing.T, *StatefulProbe) = func(t *testing.T, sp *StatefulProbe) {
|
||||
t.Helper()
|
||||
sp.MarkAsUp()
|
||||
}
|
||||
)
|
||||
|
||||
func TestStatefulProbe(t *testing.T) {
|
||||
tests := map[string]struct {
|
||||
probeTransformation func(*testing.T, *StatefulProbe)
|
||||
expectedError bool
|
||||
}{
|
||||
"mark as up": {
|
||||
probeTransformation: markAsUp,
|
||||
expectedError: false,
|
||||
},
|
||||
"mark as down": {
|
||||
probeTransformation: markAsDown,
|
||||
expectedError: true,
|
||||
},
|
||||
}
|
||||
|
||||
for name, test := range tests {
|
||||
name, test := name, test
|
||||
t.Run(name, func(t *testing.T) {
|
||||
sp := NewStatefulProbe()
|
||||
test.probeTransformation(t, sp)
|
||||
probeFunc := sp.GetProbeFunction()
|
||||
if (probeFunc() != nil) != test.expectedError {
|
||||
t.Error("result not as expected")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user