ideal-co/ogre

Handle Health Status Container Event

Open

#12 opened on May 14, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Go (2 forks)auto 404
dockerenhancementgood first issue

Repository metrics

Stars
 (4 stars)
PR merge metrics
 (PR metrics pending)

Description

Description:

Docker provides the HEALTHCHECK configuration in a Dockerfile. This will report some information to the events API when the status changes, not on a regular interval. Ogre should support this type of container event by default and make use of the data passed.

Notes:

The data passed in the event:

"State": {
... truncated ...
    "Health": {
        "Status": "unhealthy",
        "FailingStreak": 9,
        "Log": [
            {
                "Start": "2020-05-06T16:36:26.960121047Z",
                "End": "2020-05-06T16:36:27.16199565Z",
                "ExitCode": 1,
                "Output": ""
            }
        ]
    }
}

Approach:

This information should be parsed into a health.HealthCheck type (maybe reuse the DockerHealthCheck) and sent to the daemon as a msg.Message of type types.BackendMessage

Contributor guide

Research direction
Examine Ogre's existing health check types (e.g., DockerHealthCheck) and event handling code. Then, parse the Docker event's health status into a health.HealthCheck struct and send it as a msg.Message of type types.BackendMessage.
Tech stack
go
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoDocker
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75