Add garbage collection max pause check

[alexliesenfeld]

It would be useful to have a small library of commonly used health checks. In the scope of this issue, a garbage collection max pause check should be implemented (e.g. calling runtime.ReadMemStats and see if the PauseNs returns a value that is above a certain threshold.

A few constraints to keep things clean and simple:

• The check should be added to the checks module that you can find in the development branch.
• As with all health check functions of this library, the check implementation should support accepting and forwarding context.Context that is being passed to each health check function.
• If the health check requires external external modules or other dependencies, the check should be implemented as a separate Go module(similarly how it is done for the tests, that require dependencies to other packages as well). This is required to avoid that when people import the base library, they also need to import all dependencies of all provided checks.
• The check should have a README.md in its root directory that describes how to use it and maybe what to look out for.
• You should provide a test that checks at least the happy path. If a docker container is required to properly test the check, the docker container can be added to the docker-compose.yaml file in the checks base package.

Should you have questions or require help, please join our discord chat room.

[parambath92]

@alexliesenfeld Can I work on this one ?

[alexliesenfeld]

Yes, sure!

[github-actions[bot]]

This issue is stale because it has been open for 30 days with no activity.

[github-actions[bot]]

This issue was closed because it has been inactive for 14 days since being marked as stale.