Add ability for data-plane services to surface diagnostics to the control-plane #236
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why
This PR defines new traits that enable collection of diagnostics from various services within the data-plane.
By implementing the
Diagnosable
trait, a service can report aribtary JSON diagnostics to the control-plane which are then logged.These diagnostics are surfaced by the data-plane to the control-plane, when the control-plane requests a healthcheck. Although they are surfaced alongside the healthcheck, they are not considered part of the healthcheck itself.
The
is_healthy
method which is used to describe the health of the enclave to ECS, currently only considers the status of the user process.In the future more services can surface diagnostics using this implementation, at that point it may be useful to consider certain diagnostics as part of the healthcheck.
How
Diagnostics will be surface to the control-plane as serialized JSON.