Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/slok/sloth-common-sli-plugins

Sloth common SLI plugins collection
https://github.com/slok/sloth-common-sli-plugins

Last synced: 12 days ago
JSON representation

Sloth common SLI plugins collection

Host: GitHub
URL: https://github.com/slok/sloth-common-sli-plugins
Owner: slok
Created: 2021-06-04T05:34:17.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-02-13T20:20:26.000Z (9 months ago)
Last Synced: 2024-06-19T01:57:57.279Z (5 months ago)
Language: Go
Size: 141 KB
Stars: 35
Watchers: 6
Forks: 12
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # Sloth common sli plugins

[![CI](https://github.com/slok/sloth-common-sli-plugins/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/slok/sloth-common-sli-plugins/actions/workflows/ci.yaml)

[![Go Report Card](https://goreportcard.com/badge/github.com/slok/sloth-common-sli-plugins)](https://goreportcard.com/report/github.com/slok/sloth-common-sli-plugins)

[![Apache 2 licensed](https://img.shields.io/badge/license-Apache2-blue.svg)](https://raw.githubusercontent.com/slok/sloth-common-sli-plugins/master/LICENSE)

## Introduction

A collection of common [Sloth][sloth] [sli plugins][sli-plugins] ready to be used on Sloth manifests, or used as examples to create your own.

## Getting started

One of the [Sloth] features are the [SLI plugins][sli-plugins]. These can be loaded dynamically when Sloth is executed and the SLO manifests can reference these plugins and pass some options to set an SLI, instead of writing the SLI query.

To use these plugins you could do:

```bash

# Get the plugins.

git clone https://github.com/slok/sloth-common-sli-plugins.git

# Load the plugins and use them (Sloth can load plugins from multiple dirs).

sloth generate -p ./sloth-common-sli-plugins -i {MY_SLO_MANIFEST}

```

## Plugins

- [CoreDNS]

  - [🔌 Availability](./plugins/coredns/availability): Availability for CoreDNS responses.

  - [🔌 Latency](./plugins/coredns/latency): Latency for CoreDNS responses.

- [🔌 Fake](./plugins/fake): Fakes burn rates with burn rate options.

- HTTP:

  - [slok/go-http-metrics]

    - [🔌 Availability](./plugins/slok-go-http-metrics/availability): Availability SLI based on [slok/go-http-metrics] HTTP requests.

    - [🔌 Latency](./plugins/slok-go-http-metrics/latency): Latency SLI based on [slok/go-http-metrics] HTTP requests.

- Kubernetes

  - Apiserver

    - [🔌 Availability](./plugins/kubernetes/apiserver/availability): Availability SLI based on API HTTP requests.

    - [🔌 Latency](./plugins/kubernetes/apiserver/latency): Latency SLI based on API HTTP requests.

  - [Kooper]

    - [🔌 Availability](./plugins/kubernetes/kooper/availability): Availability event handling.

    - [🔌 Latency](./plugins/kubernetes/kooper/latency): Latency event handling.

    - [🔌 Queue congestion](./plugins/kubernetes/kooper/queuecongestion): Event queue congestion.

- [Noop](./plugins/noop): Example/placeholder that doesn't do anything.

- Prometheus

  - Targets

    - [🔌 Availability](./plugins/prometheus/targets/availability): Availability of Prometheus registered targets.

  - Rules

    - [🔌 Eval availability](./plugins/prometheus/rules/evalavailability): Availability of Prometheus rules evaluation.

- [Traefik]

  - v1

    - [🔌 Availability](./plugins/traefik/v1/availability): Availability for Traefik V1 serving backends.

    - [🔌 Latency](./plugins/traefik/v1/latency): Latency for Traefik V1 serving backends.

  - v2

    - [🔌 Availability](./plugins/traefik/v2/availability): Availability for Traefik V2 serving services.

    - [🔌 Latency](./plugins/traefik/v2/latency): Latency for Traefik V2 serving services.

- [Istio]

  - v1

    - [🔌 Availability](./plugins/istio/v1/availability): Availability plugin for Istio V1 services.

    - [🔌 Latency](./plugins/istio/v1/latency): Latency plugin for Istio V1 services.

## Contributing

You can contribute with new plugins the same way the ones in [plugins](./plugins), the process would be this:

- Create a directory (or/and subdirectories) group in [plugins](./plugins), only if the group would have more than one SLI plugin (e.g `app-x`, `protocol-y`, `library-z`...).

- Create a directory for each plugin: (e.g `availability`, `latency`...).

- Create a `plugin.go` file with the plugin and a `plugin_test.go` for the unit tests.

- Create an sloth manifest in [`test/integration`](./test/integration) to test that sloth can load and use this plugin correctly.

- Add a `README.md` on the group and/or the plugin dir and reference the plugin in this readme in [plugins](#plugins) section. the readme should have for each plugin at least ([example](./plugins/noop/README.md)):

  - Introduction.

  - Options.

  - Metric requirements.

  - Usage examples.

You can execute these to test it while developing:

- `make check`

- `make test`

- `make integration-test`

[sloth]: https://github.com/slok/sloth

[sli-plugins]: https://github.com/slok/sloth#sli-plugins

[slok/go-http-metrics]: https://github.com/slok/go-http-metrics

[kooper]: https://github.com/spotahome/kooper

[coredns]: https://coredns.io

[traefik]: https://traefik.io

[istio]: https://istio.io