Comments (5)
I had to publish the RFC since it had expired, but happy to hear suggestion for the better naming of "details".
Regarding your other feedback: it is totally fine if you want to just return a boolean for a downstream dependency and not provide more details. This is how your example outputs would look like per RFC:
Original from github status
{"status":"good","last_updated":"2018-10-08T22:39:11Z"}
RFC version of Github status
{"status" : "pass"}
(and caching/freshness negotiation is achieved using standard HTTP headers)
Original from Gitlab status
{
"queues_check" : {
"status" : "ok"
},
"redis_check" : {
"status" : "ok"
},
"shared_state_check" : {
"status" : "ok"
},
"db_check" : {
"status" : "ok"
},
"cache_check" : {
"status" : "ok"
}
}
RFC version of the equivalent for Gitlab status
{
"status": "pass",
"details": {
"queues_check": {"status": "pass"},
"redis_check": {"status": "pass"},
"shared_state_check": {"status": "pass"},
"db_check": {"status": "pass"},
"cache_check": {"status": "pass"}
}
}
from rfc-healthcheck.
Thank you, Martin. You make an interesting point about objection to details
. In reality what the section informs about is health of downstream dependencies
. A field name "downstream-dependencies" feels too long, however...
from rfc-healthcheck.
As for the spec pushing metric everywhere - I will have to disagree with it. Main reason:
Metrics are optional. You can absolutely use this spec to get the level of detail that stops as "can I use or not". However, there are cases when this simple "pass" or "fail" approach isn't sufficient. Such approach, while simple and often enough, is very reactive - you will only know things are bad once things start to "fail". There are plenty of cases when you may want to start noticing thing deteriorating before "fail" so appropriate measures can be taken. The spec merely allows such operation, without mandating it or making it necessary, so in that regard I think it hits a good middle ground.
from rfc-healthcheck.
Will any of this be included in new version of RFC version (regarding details
)? Should I try to find a good replacement for details
?
Regarding metrics; I am still convinced that health-check should return boolean only instead of array of metrics; example https://status.github.com/api/status.json https://docs.gitlab.com/ee/user/admin_area/monitoring/health_check.html; I guess it depends who is going to use the service. Maybe I am mistaking it for status
, and sure health-check should also show some more info.
Perhaps include an example without the use of metrics (in the RFC)? (Maybe I just do not know how to properly read RFCs, and do not discard optional things.)
Thank you for the time!
from rfc-healthcheck.
from rfc-healthcheck.
Related Issues (20)
- Fix text describing the checks object key
- AffectedEndpoints should be optional
- output in checks should also be omitted for healthy status HOT 1
- Is links a JSON object or an array?
- cassandra:connections[0] uses 'type' instead of 'componentType' HOT 1
- Do statuses have a 1:1 relationship to HTTP response codes? HOT 13
- Explicitly allow or disallow extra keys in "component details" objects
- Add structured "impacts" field for graceful degradation
- Add node to "known" check fields
- Guarantee structure of health/check object relationship
- Fix "notes" and "output" fields in example
- "affectedEndpoints" field should be optional HOT 2
- Rename additional-keys additional-properties
- Should additional-properties be allowed in the health object?
- Introduce componentType that refers a health check service for recursive health checking HOT 7
- Must links also return application/health responses? HOT 3
- Ability to provide HTTP verb for affectedEndpoints HOT 5
- "Additional Keys" instead of `details` is difficult for Java
- Git commit hash and service build time information
- Status code definition HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from rfc-healthcheck.