Add Health Check Guide

[brosenberg42]

Issues:

• Add documentation for health checks openmpf#1743

Related PRs:

• Hf/health check openmpf#1742

---

This change is 

[jrobble]

Reviewed 34 of 34 files at r1, all commit messages.
Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @brosenberg42)

---

docs/docs/Health-Check-Guide.md line 17 at r1 (raw file):

received or a job is already running, the health check will not run until the next job is received.

If the health check job completes successfully, then component executor runs the job received from

"the" component executor

---

docs/docs/Health-Check-Guide.md line 19 at r1 (raw file):

If the health check job completes successfully, then component executor runs the job received from
ActiveMQ. If the health check fails, the job will be returned to ActiveMQ. If the maximum number of
consecutive health failures has been met, the component executor will exit with exit code 39.

I think we should add, at a minimum:

"If the component is running as a Docker container, the container will terminate."

Also, consider:

"If you're using Docker swarm, you may want to configure your services to automatically restart. This may or may not resolve the reason why the health check failed."

---

docs/docs/Health-Check-Guide.md line 61 at r1 (raw file):

    "IMAGE", "VIDEO", "AUDIO", or "GENERIC".
- `job_properties`: (Optional) Job properties that will set on the health check job.
- `media_properties`: (Optional) Media properties that will set on the health check job.

We should mention that all of the log lines pertaining to the health check will be prefixed with [Health check] - instead of [Job #: media] -.

[brosenberg42]

Reviewable status: 29 of 34 files reviewed, 3 unresolved discussions (waiting on @jrobble)

---

docs/docs/Health-Check-Guide.md line 17 at r1 (raw file):

Previously, jrobble (Jeff Robble) wrote…

"the" component executor

Done.

---

docs/docs/Health-Check-Guide.md line 19 at r1 (raw file):

Previously, jrobble (Jeff Robble) wrote…

I think we should add, at a minimum:

"If the component is running as a Docker container, the container will terminate."

Also, consider:

"If you're using Docker swarm, you may want to configure your services to automatically restart. This may or may not resolve the reason why the health check failed."

Done.

---

docs/docs/Health-Check-Guide.md line 61 at r1 (raw file):

Previously, jrobble (Jeff Robble) wrote…

We should mention that all of the log lines pertaining to the health check will be prefixed with [Health check] - instead of [Job #: media] -.

Done.

[jrobble]

Reviewed 5 of 5 files at r2, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @brosenberg42)