Update examples. Add data source template generation. (#18)

* Update examples. Add data source template generation.

* Update help

* Add comments to stdout for template generation

* Update comment

* Add timestamp formats for https://metallb.io/

* Update README

---------

Co-authored-by: Tony Meehan <[email protected]>

Author: tonymeehan

README.md

@@ -1,16 +1,20 @@
 # preq
 
-`preq` (prounounced "preek") is a free and open community-driven reliability problem detector. Use `preq` to:
+`preq` (prounounced "preek") is a free and open community-driven reliability problem detector
+
+[Documentation](https://docs.prequel.dev/cres/introduction) | [Slack](https://prequel-dev.slack.com/) | [Playground](https://play.prequel.dev/) | [Mailing List](https://www.detect.sh)
+
+---
+
+Use `preq` to:
 
 - detect the latest bugs, misconfigurations, anti-patterns, and known issues from a community of practitioners
 - provide engineers, on-call support, and SRE agents with impact and community recommended mitigations
-- hunt for new problems in logs, metrics, and traces
-
-Learn more at https://docs.prequel.dev.
+- hunt for new problems in distributed systems
 
 ## Overview
 
-`preq` provides the latest Common Reliability Enumerations (CREs) created by the community and Prequel's Reliability Research Team. Reliability Intelligence from CREs helps teams see the most problems and see them first so they can prioritize, pinpoint, and act to mitigate outages.
+`preq` uses Common Reliability Enumerations (CREs) created by the problem detection community and Prequel's Reliability Research Team to detect reliability problems. Reliability Intelligence from CREs helps teams see the most problems and see them first so they can prioritize, pinpoint, and act to mitigate outages.
 
 `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.
 

cmd/preq/preq.go

@@ -42,10 +42,11 @@ var (
 var cli struct {
 	Disabled      bool   `short:"d" help:"Do not run community CREs"`
 	Stop          string `short:"e" help:"Stop time"`
+	Generate      bool   `short:"g" help:"Generate data sources template"`
 	JsonLogs      bool   `short:"j" help:"Print logs in JSON format to stderr" default:"false"`
-	Skip          int    `short:"k" help:"Skip the first N lines for timestamp detection" default:"20"`
+	Skip          int    `short:"k" help:"Skip the first N lines for timestamp detection" default:"50"`
 	Level         string `short:"l" help:"Print logs at this level to stderr"`
-	ReportFile    string `short:"n" help:"Report filename"`
+	Filename      string `short:"n" help:"Report or data source template output file name"`
 	Quiet         bool   `short:"q" help:"Quiet mode, do not print progress"`
 	Rules         string `short:"r" help:"Path to a CRE file"`
 	Source        string `short:"s" help:"Path to a data source file"`
@@ -225,6 +226,37 @@ func main() {
 		os.Exit(1)
 	}
 
+	if cli.Generate {
+
+		var (
+			currRulesVer *semver.Version
+			template     []byte
+			fn           string
+		)
+
+		if currRulesVer, _, err = rules.GetCurrentRulesVersion(defaultConfigDir); err != nil {
+			log.Error().Err(err).Msg("Failed to get current rules version")
+		}
+
+		if template, err = ruleMatchers.DataSourceTemplate(currRulesVer); err != nil {
+			log.Error().Err(err).Msg("Failed to generate data source template")
+			ux.RulesError(err)
+			os.Exit(1)
+		}
+
+		if fn, err = ux.WriteDataSourceTemplate(cli.Filename, currRulesVer, template); err != nil {
+			log.Error().Err(err).Msg("Failed to write data source template")
+			ux.DataError(err)
+			os.Exit(1)
+		}
+
+		if fn != "" {
+			fmt.Fprintf(os.Stdout, "Wrote data source template to %s\n", fn)
+		}
+
+		os.Exit(0)
+	}
+
 	if len(sources) == 0 {
 		ux.PrintUsage()
 		os.Exit(1)
@@ -267,14 +299,14 @@ LOOP:
 	}
 
 	switch {
-	case cli.ReportFile == stdoutReport:
+	case cli.Filename == stdoutReport:
 		if err = report.PrintReport(); err != nil {
 			log.Error().Err(err).Msg("Failed to print report")
 			ux.RulesError(err)
 			os.Exit(1)
 		}
-	case cli.ReportFile != "":
-		if reportPath, err = report.Write(cli.ReportFile); err != nil {
+	case cli.Filename != "":
+		if reportPath, err = report.Write(cli.Filename); err != nil {
 			log.Error().Err(err).Msg("Failed to write full report")
 			ux.RulesError(err)
 			os.Exit(1)

examples/00-rules-document-example.yaml

@@ -2,7 +2,7 @@ rules:
   - cre:
       id: cre-2025-0
     metadata:
-      id: rule-id=0
+      id: rule-id-0
       hash: rule-hash-0
     rule:
       set:

examples/01-set-single-example.yaml

@@ -1,6 +1,8 @@
 rules:
   - cre:
       id: set-example
+    metadata:
+      id: rule-id
     rule:
       set:
         event:

examples/02-set-multiple-example-bad-window.yaml

@@ -1,6 +1,8 @@
 rules:
   - cre:
       id: set-example-2
+    metadata:
+      id: rule-id
     rule:
       set:
         window: 1s

examples/02-set-multiple-example-good-window.yaml

@@ -1,6 +1,8 @@
 rules:
   - cre:
       id: set-example-2
+    metadata:
+      id: rule-id
     rule:
       set:
         window: 10s

examples/03-set-negative-example.yaml

@@ -1,6 +1,8 @@
 rules:
   - cre:
       id: set-negative
+    metadata:
+      id: rule-id
     rule:
       set:
         window: 10s

examples/04-set-1x1-example.yaml

@@ -1,6 +1,8 @@
 rules:
   - cre:
       id: set-1x1
+    metadata:
+      id: rule-id
     rule:
       set:
         event:

examples/05-bad-set-example.yaml

@@ -1,6 +1,8 @@
 rules:
   - cre:
       id: bad-order
+    metadata:
+      id: rule-id
     rule:
       set:
         event:

examples/06-bad-set-example.yaml

@@ -1,6 +1,8 @@
 rules:
   - cre:
       id: bad-negate
+    metadata:
+      id: rule-id
     rule:
       set:
         event: