ubuntu/sloth repository overview

ubuntu/sloth is a rock for sloth maintained by Canonical⁠.

Sloth is an easy and simple Prometheus SLO (service level objectives) generator. It generates understandable, uniform and reliable Prometheus SLOs for any kind of service using a simple SLO spec.

[Learn more about sloth⁠]

⁠Tags and Architectures

NOTE: These tags follow a specific naming convention that respects the concept of channels⁠.

⁠Get started

This rock's entrypoint is Pebble, a container-optimized init process that enables the orchestration of a collection of local service processes as an organized set.

[Learn more about Pebble⁠]

⁠Inspect

To view the Pebble services⁠ and checks⁠ defined in this rock:

docker run --rm ubuntu/sloth:0.15-24.04_stable plan

⁠Run

To run this rock, use any of the usual container runtimes, for example, docker:

docker run --name sloth-container \
    -v ./input.yaml:/input.yaml -v ./output.yaml:/output.yaml \
    ubuntu/sloth:0.15-24.04_stable \
    --args sloth generate -i ./input.yaml -o ./output.yaml

Sloth generates Prometheus rules from the given SLO spec file (input.yaml) and writes them to output.yaml.

An example SLO spec file is available in the upstream examples/ folder⁠.

⁠Get logs

To view the logs of the running container, run:

docker exec sloth-container pebble logs

Or, for a specific service:

docker exec sloth-container pebble logs <service>

⁠Monitor health checks

Rocks may have predefined health checks that you can list by running:

docker exec sloth-container pebble checks

The overall health of your container can be inspected via:

docker exec sloth-container pebble health

⁠Configuration

⁠Volumes

[Report a bug⁠] [Contribute⁠]

Canonical is the provider of this container image. It is the user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within, as well as with Canonical’s IP Policy⁠.