Skip to content

Commit

Permalink
Prepare repository for Tenzir v4.0.0-rc10 (#3400)
Browse files Browse the repository at this point in the history
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-rc10 and the expected rev-count of
the merge commit to 17702.
* 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-rc10`.
* Moved all changelog entries from `/changelog/v4.0.0-rc9` to
`/changelog/v4.0.0-rc10`.
* Updated the python bindings version in `/python/pyproject.toml` to
v4.0.0-rc10.
  • Loading branch information
tobim committed Jul 25, 2023
2 parents 8d41a8e + dd122a8 commit 74b52b5
Show file tree
Hide file tree
Showing 227 changed files with 77 additions and 11 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion python/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "pytenzir"
version = "4.0.0-rc9"
version = "4.0.0-rc10"
description = "A security telemetry engine for detection and response"
authors = ["Tenzir <engineering@tenzir.com>"]
maintainers = ["Tenzir <engineering@tenzir.com>"]
Expand Down
4 changes: 2 additions & 2 deletions version.json
Original file line number Diff line number Diff line change
Expand Up @@ -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-rc9",
"tenzir-version-fallback": "4.0.0-rc10",
"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": 17626,
"tenzir-version-rev-count": 17702,
"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",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# discard

Discards all incoming events.

:::note
This operator is mainly used to test or benchmark pipelines.
:::

## Synopsis

```
discard
```

## Description

The `discard` operator has a similar effect as `to file /dev/null write json`,
but it immediately discards all events without rendering them as JSON first.

## Examples

We can benchmark the following pipeline to see how long it takes to export
everything.

```
export | discard
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# batch

The `batch` operator controls the batch size of events.

:::warning Expert Operator
The `batch` operator is a lower-level building block that lets users explicitly
control batching, which otherwise is controlled automatically by Tenzir's
underlying pipeline execution engine. Use with caution!
:::

## Synopsis

```
batch [<limit>]
```

## Description

The `batch` operator takes its input and rewrites it into batches of up to the
desired size.

### `<limit>`

An unsigned integer denoting how many events to put into one batch at most.

Defaults to 65536.

## Examples

Write exactly one NDJSON object at a time to a Kafka topic.

```
batch 1 | to kafka -t topic write json -c
```
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Sorts events.
## Synopsis

```
sort <field> [<asc>|<desc>] [<nulls-first>|<nulls-last>]
sort [--stable] <field> [<asc>|<desc>] [<nulls-first>|<nulls-last>]
```

## Description
Expand All @@ -15,10 +15,14 @@ Sorts events by a provided field.
:::caution Work in Progress
The implementation of the `sort` operator currently only works with field names.
We plan to support sorting by meta data, and more generally, entire expressions.
To date, the operator also lacks support for all data types. Unsupported are
currently compound and extension types (`ip`, `subnet`, `enum`).
To date, the operator also lacks support sorting `subnet` fields.
:::

### `--stable`

Preserve the relative order of events that cannot be sorted because the provided
fields resolve to the same value.

### `<field>`

The name of the field to sort by.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# taste

Limits the input to the first *N* events per unique schema.
Limits the input to *N* events per unique schema.

## Synopsis

Expand All @@ -12,7 +12,8 @@ taste [<limit>]

The `taste` operator provides an exemplary overview of the "shape" of the data
described by the pipeline. This helps to understand the diversity of the
result, especially when interactively exploring data.
result, especially when interactively exploring data. Usually, the first *N*
events are returned, but this is not guaranteed.

### `<limit>`

Expand All @@ -22,13 +23,13 @@ Defaults to 10.

## Examples

Get the first 10 results of each unique schema:
Get 10 results of each unique schema:

```
taste
```

Get the one sample for every unique event type:
Get one sample for every unique event type:

```
taste 1
Expand Down
2 changes: 1 addition & 1 deletion web/versions.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[
"Tenzir v4.0-rc9",
"Tenzir v4.0-rc10",
"VAST v3.1",
"VAST v3.0"
]

0 comments on commit 74b52b5

Please sign in to comment.