Skip to content

Conversation

amanycodes
Copy link
Contributor

No description provided.

Signed-off-by: amanycodes <[email protected]>
Signed-off-by: amanycodes <[email protected]>
@Lyndon-prequel Lyndon-prequel self-requested a review September 17, 2025 18:03
Signed-off-by: amanycodes <[email protected]>
Signed-off-by: amanycodes <[email protected]>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Initial comments

  • Why are the command in steps 1 and 2 the same?

Step 1: Install and run the demo service
Step 2: Trigger a problem

  • since this is a linux example, we should probably note that.

  • I think most people would likely run from their mac desktop, let's use the mac example instead.

  • in the text, let's stylized preq as preq whenever we use it. just a style thing we like to do. Can you do this throughout the readme?

  • Architecture Overview

The image is missing.

  • "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)."

Let's make it clearer. We can't guarantee that an event does not occur - we want to ensure it doesn't fire if so. perhaps

“This rule detects a specific sequence of events from one log source within a set time period. It also checks that a certain event doesn’t occur during that period — if it does, the rule will not trigger.”

  • "Automated Actions using preq" - let's add an intro sentence.

You can connect detections to automated runbooks that take action when a CRE fires — for example, restarting a service or notifying your on-call team.

  • Typo: We’re building an open reliability detection community nd we’d love you to join!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants