google / google/slo-generator

💡 [REQUEST] - Add sample output(s) to `README.md`

Open
#307 1 comment 0 reactions 1 assignee Claimed by @lvaylet View on GitHub
docs documentation
Dominant language
Python
Stars
564
Forks
88
PR merge metrics
No merged PRs in 30d

Description

### Summary

New users and prospects can have a hard time understanding what the SLO Generator actually does. Adding a sample output near the top of `README.md` might help them with a visual example.

### Basic Example

Add the output of a simple `slo-generator compute` command, like:

```sh
$ slo-generator compute --slo-config=samples/cloud_monitoring_mql/slo_run_service_availability.yaml --config=samples/config.yaml
INFO - cloudrun-service-availability | 1 hour | SLI: 78.3333 % | SLO: 95.0 % | Gap: -16.67% | BR: 4.3 / 9.0 | Alert: 0 | Good: 47 | Bad: 13
INFO - cloudrun-service-availability | 12 hours | SLI: 76.3889 % | SLO: 95.0 % | Gap: -18.61% | BR: 4.7 / 3.0 | Alert: 1 | Good: 550 | Bad: 170
INFO - cloudrun-service-availability | 7 days | SLI: 75.4087 % | SLO: 95.0 % | Gap: -19.59% | BR: 4.9 / 1.5 | Alert: 1 | Good: 7611 | Bad: 2482
INFO - cloudrun-service-availability | 28 days | SLI: 75.019 % | SLO: 95.0 % | Gap: -19.98% | BR: 5.0 / 1.0 | Alert: 1 | Good: 23694 | Bad: 7890
INFO - Run finished successfully in 7.6s.
INFO - Run summary | SLO Configs: 1 | Duration: 7.6s
```

Ideally with `COLORED_OUTPUT` set to `1` for a visual feedback on alerting.

Then include the same output with `--export`?

### Screenshots

```bash
![DESCRIPTION](LINK.png)
```

### Drawbacks

None identified.

### Unresolved questions

_No response_

### Code of Conduct

- [X] I agree to follow this project's Code of Conduct

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.