docs: update cli call syntax and output format

Author: HabibMAALEM

README.md

@@ -81,6 +81,7 @@ Available Commands:
 
 Flags:
       --auth-basic-token string       authentication token used to fetch remote repositories
+      --concurrent int                concurrent worker used to run analysus
   -c, --config string                 path to watchdog configuration file
       --docs-link string              link to documentation
   -h, --help                          help for watchdog
@@ -90,7 +91,6 @@ Flags:
       --logs-format string            logging level (default "json")
       --logs-level string             logging level (default "info")
       --logs-path string              path to logs (default "/var/log/watchdog/watchdog.log")
-      --max-workers int               coccurent worker used to run analysus
       --output string                 path to output file
       --output-format string          report format (default "text")
       --plugins-directory string      path to plugins directory (default "plugins")

cmd/root.go

@@ -27,7 +27,7 @@ func Execute(ctx context.Context) error {
 func init() {
 	cobra.OnInitialize(initConfig)
 	rootCommand.PersistentFlags().Bool("profile", false, "collect the profile to hercules.pprof.")
-	rootCommand.PersistentFlags().Int("max-workers", 0, "coccurent worker used to run analysus")
+	rootCommand.PersistentFlags().Int("concurrent", 0, "concurrent worker used to run analysus")
 	rootCommand.PersistentFlags().Int("security.reveal-secrets", 0, "full or partial reveal of secrets in report and logs")
 	rootCommand.PersistentFlags().String("auth-basic-token", "", "authentication token used to fetch remote repositories")
 	rootCommand.PersistentFlags().String("hook-input", "", "standard input <old-value> SP <new-value> SP <ref-name> LF")

config/config.yml

@@ -36,8 +36,8 @@ logs_level: info
 logs_format: json
 # logs path
 logs_path: /var/log/watchdog/watchdog.log
-# number of cocurrent worker user to run analysis
-max_workers: 8
+# number of cocurrent worker used to run analysis
+concurrent: 4
 # output file for analysis report
 output:
 # report format

docs/assets/scss/_variables_project.scss

@@ -0,0 +1,2 @@
+$primary: #024BB0;
+$secondary: #FA5716;

docs/content/en/docs/configuration/_index.md

@@ -0,0 +1,21 @@
+---
+title: "Configuration"
+linkTitle: "Configuration"
+weight: 2
+description: >
+  Learn how to configure Watchdog.
+---
+
+Watchdog configuration uses the [YAML](https://yaml.org/) format.
+
+The file to be edited can be found in:
+1. `/etc/watchdog/config.yaml` on \*nix systems when Watchdog is executed as root
+2. `~/.watchdog/config.yaml` on \*nix systems when Watchdog is executed as non-root
+2. `./config.yaml` on other systems
+
+Configuration example:
+
+```yaml
+concurrent: 4
+logs_level: "warning"
+```

docs/content/en/docs/deployment/gitlab.md

@@ -24,7 +24,7 @@ For a global deployment, you must create one of the `pre-receive.d`,` post-recei
 HOOKS=("pre-receive" "post-receive" "update")
 HOOK_TYPE=$(cd $(dirname "${BASH_SOURCE[0]}") >/dev/null 2>&1 && echo ${PWD##*/})
 while read -r OLDREV NEWREV REFNAME; do
-  /usr/local/bin/watchdog \
+  /usr/local/bin/watchdog analyze \
     --docs-link="https://groupe-edf.github.io/watchdog/docs/" \
     --hook-type="pre-receive" \
     --hook-input="$OLDREV $NEWREV $REFNAME" \

docs/content/en/docs/quickstart/output.md

@@ -43,6 +43,8 @@ remote: Operation took 43.319478ms
 Format
 --------------------
 
+### logfmt
+
 The default output format of the messages is [logfmt] (https://brandur.org/logfmt) prefixed by `GL-HOOK-ERR:` to have the possibility of uploading these messages on the Gitlab graphical interface in the case of a direct modification of the code on Gitlab.
 
 ```bash
@@ -55,4 +57,30 @@ severity=high handler=file condition=extension commit=eda373cc message="'*.exe'
 * **commit** The current hash of the commit (On 8 characters)
 * **message** Issue description
 
-Only high severity issues block commits from being persisted in the Git repository.
+Only high severity issues block commits from being persisted in the Git repository.
+
+### json
+```bash
+[
+  {
+    "author": "Habib MAALEM",
+    "commit": "9560bbeb3b93d9a6d545133dea3e26e0f1fd7a66",
+    "condition": "secret",
+    "email": "[email protected]",
+    "handler": "security",
+    "leaks": [
+      {
+        "file": "src/main/resources/rsa_server.key",
+        "line_number": 1,
+        "rule": "ASYMMETRIC_PRIVATE_KEY",
+        "severity": "MAJOR",
+        "tags": [
+          "key"
+        ]
+      }
+    ],
+    "message": "Secrets, token and passwords are forbidden, `src/main/resources/rsa_server.key:----***********************`",
+    "severity": "low"
+  }
+]
+```

docs/content/en/docs/quickstart/usage.md

@@ -12,11 +12,11 @@ On the developer side, to invoke customs hooks, the user must add a configuratio
 
 ``` bash
 $ ll /workspaces/project-name
-  |--docs/
-  |--src/
-  |--tests/
-  |--.gitignore
-  |--.githooks.yml
+  |__ docs/
+  |__ src/
+  |__ tests/
+  |__ .gitignore
+  |__ .githooks.yml
 ```
 
 .githooks.yml

internal/config/config.go

@@ -30,8 +30,8 @@ type Options struct {
 	LogsPath           string               `mapstructure:"logs-path"`
 	MaxFileSize        uint
 	MaxRepositorySize  uint
-	// MaxWorkers max workers running at the same time
-	MaxWorkers       int    `mapstructure:"max-workers"`
+	// Concurrent max workers running at the same time
+	Concurrent       int    `mapstructure:"concurrent"`
 	Output           string `mapstructure:"output"`
 	OutputFormat     string `mapstructure:"output-format"`
 	PluginsDirectory string `mapstructure:"plugins-directory"`
@@ -62,8 +62,8 @@ func (options *Options) Validate() error {
 	if options.LogsPath == "" {
 		options.LogsPath = LogsPath
 	}
-	if options.MaxWorkers == 0 {
-		options.MaxWorkers = runtime.NumCPU()
+	if options.Concurrent == 0 {
+		options.Concurrent = runtime.NumCPU()
 	}
 	return nil
 }

internal/core/analyzer.go

@@ -39,7 +39,7 @@ func (analyzer *Analyzer) Analyze(ctx context.Context, commitIter object.CommitI
 	ctx, cancel := context.WithCancel(ctx)
 	defer cancel()
 	defer commitIter.Close()
-	maxWorkers := make(chan struct{}, analyzer.Options.MaxWorkers)
+	maxWorkers := make(chan struct{}, analyzer.Options.Concurrent)
 	if len(analyzer.GitHooks.Hooks) > 0 {
 		analyzer.Logger.WithFields(logging.Fields{
 			"correlation_id": util.GetRequestID(ctx),