Prepare repository for Tenzir v4.0.0-rc9 (#3395)

This commit is was created with /scripts/prepare-release.

Here is a high-level summary of the changes:

* Updated `/version.json` to v4.0.0-rc9 and the expected rev-count of
the merge commit to 17625.
* Generated a new entry in the docs version selector list.
* Removed the docs for the previous release candidate.
* Moved all changelog entries from `/changelog/next` to
`/changelog/v4.0.0-rc9`.
* Moved all changelog entries from `/changelog/v4.0.0-rc8` to
`/changelog/v4.0.0-rc9`.
* Updated the python bindings version in `/python/pyproject.toml` to
v4.0.0-rc9.

This also contains a single commit that fixes some leftover renaming
artifacts that sneaked in. The rev-count was adjusted accordingly.

plugins/web/src/specification_command.cpp

@@ -136,12 +136,12 @@ on the command-line using the `tenzir rest generate-token` command.)_"},
       record{{"url", "https://tenzir.example.com/api/v0"}},
     }}},
     {"security", list {{
-      record {{"VastToken", list{}}},
+      record {{"TenzirToken", list{}}},
     }}},
     {"components", record{
       {"schemas", std::move(*schemas)},
       {"securitySchemes",
-        record{{"VastToken", record {
+        record{{"TenzirToken", record {
             {"type", "apiKey"},
             {"in", "header"},
             {"name", "X-Tenzir-Token"}

python/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pytenzir"
-version = "4.0.0-rc8"
+version = "4.0.0-rc9"
 description = "A security telemetry engine for detection and response"
 authors = ["Tenzir <engineering@tenzir.com>"]
 maintainers = ["Tenzir <engineering@tenzir.com>"]

version.json

@@ -4,14 +4,14 @@
     "annotated git tag without the leading 'v'.",
     "This value gets updated automatically by `scripts/prepare-release`."
   ],
-  "tenzir-version-fallback": "4.0.0-rc8",
+  "tenzir-version-fallback": "4.0.0-rc9",
   "tenzir-version-rev-count_COMMENT": [
     "This value stores the ancestor count of the tagged commit, calculated",
     "with `git rev-list --count HEAD`, then incremented by 1. This operates",
     "under the assumption that the release-preparing PR contains exactly one",
     "commit and is rebased before merging."
   ],
-  "tenzir-version-rev-count": 17446,
+  "tenzir-version-rev-count": 17626,
   "tenzir-partition-version_COMMENT": [
     "The partition version. This number must be bumped alongside the release",
     "version for releases that contain major format changes to the on-disk",

web/openapi/openapi.yaml

@@ -7,7 +7,7 @@ info:
 servers:
   - url: https://tenzir.example.com/api/v0
 security:
-  - VastToken:
+  - TenzirToken:
       []
 components:
   schemas:
@@ -113,7 +113,7 @@ components:
         diagnostics:
           $ref: "#/components/schemas/Diagnostics"
   securitySchemes:
-    VastToken:
+    TenzirToken:
       type: apiKey
       in: header
       name: X-Tenzir-Token

web/versioned_docs/version-Tenzir v4.0-rc8/connectors/directory.md → web/versioned_docs/version-Tenzir v4.0-rc9/connectors/directory.md

@@ -5,7 +5,7 @@ Saves bytes to one file per schema into a directory.
 ## Synopsis
 
 ```
-directory <path>
+directory [-a|--append] [-r|--real-time] <path>
 ```
 
 ## Description
@@ -14,6 +14,15 @@ The `directory` saver writes one file per schema into the provided directory.
 
 The default printer for the `directory` saver is [`json`](../formats/json.md).
 
+### `-a|--append`
+
+Append to files in `path` instead of overwriting them with a new file.
+
+### `-r|--real-time`
+
+Immediately synchronize files in `path` with every chunk of bytes instead of
+buffering bytes to batch filesystem write operations.
+
 ### `<path>`
 
 The path to the directory. If `<path>` does not point to an existing directory,
@@ -24,5 +33,5 @@ the saver creates a new directory, including potential intermediate directories.
 Write one JSON file per unique schema to `/tmp/dir`:
 
 ```
-write json to directory /tmp/dir
+to directory /tmp/dir write json
 ```

web/versioned_docs/version-Tenzir v4.0-rc8/connectors/file.md → web/versioned_docs/version-Tenzir v4.0-rc9/connectors/file.md

@@ -87,7 +87,7 @@ Read JSON from stdin via [`from`](../operators/sources/from.md) and convert
 it to CSV:
 
 ```
-from - read json | write csv to stdout
+from - read json | to stdout | write csv
 ```
 
 Read 1 MiB from a file `/tmp/data` and write the bytes another file `/tmp/1mb`,

web/versioned_docs/version-Tenzir v4.0-rc9/contribute/github.md

@@ -0,0 +1,26 @@
+# GitHub
+
+This page documents workflows concerning developer-facing GitHub infrastructure.
+
+## Synchronize issue labels
+
+To ensure that [issue and pull request
+labels](https://github.com/tenzir/tenzir/labels) are consistent within and
+across several of our repositories, we use [GitHub Label
+Sync](https://github.com/Financial-Times/github-label-sync).
+
+To synchronize the labels, run:
+
+```bash
+github-label-sync --access-token TOKEN --labels labels.yml REPO
+```
+
+`TOKEN` is a personal GitHub Access Token and `REPO` the GitHub repository,
+e.g., `tenzir/tenzir`. The labels configuration
+[`labels.yml`](https://github.com/tenzir/tenzir/blob/main/.github/labels.yml) is
+part of this repository and has the following contents:
+
+import CodeBlock from '@theme/CodeBlock';
+import Configuration from '!!raw-loader!@site/../.github/labels.yml';
+
+<CodeBlock language="yaml">{Configuration}</CodeBlock>

web/versioned_docs/version-Tenzir v4.0-rc8/formats/json.md → web/versioned_docs/version-Tenzir v4.0-rc9/formats/json.md

@@ -14,8 +14,8 @@ json [--schema=<schema>] [--selector=<field[:prefix]>] [--unnest-separator=<stri
 Printer:
 
 ```
-json [--pretty] [--omit-nulls] [--omit-empty-records] [--omit-empty-lists]
-     [--omit-empty]
+json [-c|--compact-output] [-C|--color-output] [-M|--monochrome-output] 
+     [--omit-nulls] [--omit-empty-objects] [--omit-empty-lists] [--omit-empty]
 ```
 
 ## Description
@@ -98,14 +98,34 @@ Popular examples of NDJSON include the Suricat Eve JSON and the Zeek Streaming
 JSON formats. Tenzir supports [`suricata`][suricata.md] and
 [`zeek-json`][zeek-json.md] parsers out of the box that utilize this mechanism.
 
-### `--pretty` (Printer)
+### `--c|--compact-output` (Printer)
 
-Tenzir defaults to line-delimited JSON output (JSONL or NDJSON). The `--pretty`
-flag switches to a tree-structured representation.
+Switch to line-delimited JSON output (JSONL/NDJSON).
+
+### `--C|--color-output` (Printer)
+
+Colorize the output.
+
+The option enables colorizing the output similar to `jq` by emitting terminal
+escape sequences that represent colors.
+
+Unlike `jq`, coloring is currently opt-in. In the future, we will perform TTY
+detection and colorize the output when write to stdout.
+
+Tenzir honors the [`NO_COLOR`](https://no-color.org/) environment variable and
+won't colorize the output when the variable is present.
+
+### `--M|--monochrome-output` (Printer)
+
+Disables colored output.
+
+This is currently the default. In the future, we will perform TTY detection and
+colorize the output when write to stdout. Use this option today if you want to
+avoid an implicit upgrade to colors in the future.
 
 ### `--omit-nulls` (Printer)
 
-Strips `null` fields from the input.
+Strips `null` fields from the output.
 
 Example:
 
@@ -131,9 +151,9 @@ With `--omit-nulls`, this example becomes:
 }
 ```
 
-### `--omit-empty-records` (Printer)
+### `--omit-empty-objects` (Printer)
 
-Strips empty records from the input.
+Strips empty objects from the output.
 
 Example:
 
@@ -147,7 +167,7 @@ Example:
 }
 ```
 
-With `--omit-empty-records`, this example becomes:
+With `--omit-empty-objects`, this example becomes:
 
 ```json
 {
@@ -157,7 +177,7 @@ With `--omit-empty-records`, this example becomes:
 
 ### `--omit-empty-lists` (Printer)
 
-Strips empty lists from the input.
+Strips empty lists from the output.
 
 Example:
 
@@ -192,14 +212,14 @@ Read JSON from stdin, either NDJSON or tree-structured:
 read json
 ```
 
-Write compact JSON without empty fields to a file:
+Write JSON without empty fields to a file:
 
 ```
 write json --omit-empty to file /tmp/result.json
 ```
 
-Pretty-print JSON in tree-structured form to stdout:
+Print NDJSON to stdout:
 
 ```
-write json --pretty
+write json -c
 ```

web/versioned_docs/version-Tenzir v4.0-rc8/formats/xsv.md → web/versioned_docs/version-Tenzir v4.0-rc9/formats/xsv.md

@@ -68,12 +68,12 @@ Specifies the string that denotes an absent value.
 Read CSV from stdin:
 
 ```
-read csv from stdin
+from stdin read csv
 ```
 
 Write a multi-schema stream of events to a directory in TSV format, with one
 file per unique schema:
 
 ```
-write tsv to directory /tmp/result
+to directory /tmp/result write tsv
 ```

web/versioned_docs/version-Tenzir v4.0-rc8/formats/zeek-tsv.md → web/versioned_docs/version-Tenzir v4.0-rc9/formats/zeek-tsv.md

@@ -98,5 +98,5 @@ gunzip -c *.gz | tenzir 'read zeek-tsv | ...'
 Write Zeek TSV into a directory, one file per schema:
 
 ```
-write zeek-tsv to directory /tmp/results
+to directory /tmp/results write zeek-tsv
 ```