|
4 | 4 | [](https://github.com/prequel-dev/preq/actions/workflows/build.yml) |
5 | 5 | [](https://github.com/prequel-dev/prequel-compiler/actions/workflows/build.yml) |
6 | 6 |
|
7 | | -`preq` (prounounced "preek") is a free and open community-driven reliability problem detector |
| 7 | +preq (prounounced "preek") is a free and open community-driven reliability problem detector |
8 | 8 |
|
9 | 9 | [Documentation](https://docs.prequel.dev) | [Slack](https://inviter.co/prequel) | [Playground](https://play.prequel.dev/) | [Mailing List](https://www.detect.sh) |
10 | 10 |
|
11 | 11 | --- |
12 | 12 |
|
13 | | -Use `preq` to: |
| 13 | +Use preq to: |
14 | 14 |
|
15 | 15 | - detect the latest bugs, misconfigurations, anti-patterns, and known issues from a community of practitioners |
16 | 16 | - provide engineers, on-call support, and SRE agents with impact and community recommended mitigations |
17 | 17 | - hunt for new problems in distributed systems |
18 | 18 |
|
19 | | -`preq` is powered by [Common Reliability Enumerations (CREs)](https://github.com/prequel-dev/cre) that are contributed by the community and Prequel's Reliability Research Team. Reliability intelligence helps teams see a broad range of problems earlier, so they can prioritize, pinpoint, and reduce the risk of outages. |
| 19 | +preq is powered by [Common Reliability Enumerations (CREs)](https://github.com/prequel-dev/cre) that are contributed by the community and Prequel's Reliability Research Team. Reliability intelligence helps teams see a broad range of problems earlier, so they can prioritize, pinpoint, and reduce the risk of outages. |
20 | 20 |
|
21 | | -## Install |
| 21 | +## Download and Install |
22 | 22 |
|
23 | | -Download the [latest release](https://github.com/prequel-dev/preq/releases) for Linux (amd64), macOS (amd64 and arm64), and Windows (amd64). No configuration is necessary to start using preq. |
| 23 | +### Binary Distributions |
| 24 | + |
| 25 | +Official binary distributions are available at [latest release](https://github.com/prequel-dev/preq/releases) for Linux (amd64), macOS (amd64 and arm64), and Windows (amd64). All macOS binaries are signed and notarized. No configuration is necessary to start using preq. |
| 26 | + |
| 27 | +### Kubernetes |
| 28 | + |
| 29 | +You can also install preq as a Krew plugin: |
| 30 | + |
| 31 | +```bash |
| 32 | +kubectl krew install preq |
| 33 | +``` |
24 | 34 |
|
25 | 35 | See https://docs.prequel.dev/install for more information. |
26 | 36 |
|
27 | 37 | ## Overview |
28 | 38 |
|
29 | | -`preq` is powered by a rules engine that performs distributed matching and correlation of sequences of events across logs, metrics, traces, and other data sources to detect reliability problems. CREs provides accurate and timely context for a human or SRE agent to take action on problems. |
| 39 | +preq is powered by a rules engine that performs distributed matching and correlation of sequences of events across logs, metrics, traces, and other data sources to detect reliability problems. CREs provides accurate and timely context for a human or SRE agent to take action on problems. |
30 | 40 |
|
31 | 41 | Below is simple rule that looks for a sequence of events in a single log source over a window of time along with a negative condition (an event that should not occur during the window). |
32 | 42 |
|
|
75 | 85 | ``` |
76 | 86 |
|
77 | 87 | ## Running |
| 88 | +
|
| 89 | +* See https://docs.prequel.dev/running for examples of how to run preq |
| 90 | +* See https://docs.prequel.dev/running#automated-runbooks for examples of how to setup automated runbooks when a CRE is detected |
| 91 | +
|
| 92 | +## Contributing |
| 93 | +
|
| 94 | +Open a PR and let's go! |
0 commit comments