Add frequency-based emission options to summarize operator #153
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Documents the new `options` argument for the summarize operator that enables periodic emission of aggregation results at fixed intervals. Covers: - `frequency` parameter for setting emission interval - `mode` parameter with reset, cumulative, and update modes - Usage examples for each mode Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Contributor
|
🚀 Preview deployed! Visit the preview at: https://tenzir-docs-preview-153.surge.sh This preview will be updated automatically on new commits. |
mavam
force-pushed
the
main
branch
2 times, most recently
from
52a0bca to
429deec
Compare
tobim
added a commit
to tenzir/tenzir
that referenced
this pull request
Jan 25, 2026
This PR adds frequency-based emission to the summarize operator,
enabling periodic output of aggregation results at fixed intervals
instead of only at the end of input. This enables streaming use cases
where you want real-time updates on aggregations.
The feature is controlled via the `options` named argument:
```tql
summarize count(this), src_ip, options={frequency: 5s, mode: "reset"}
```
Three emission modes are supported:
- **reset** (default): Reset aggregations after each emission, providing
per-interval metrics
- **cumulative**: Accumulate values across emissions, providing running
totals
- **update**: Accumulate values but only emit when they change from the
previous emission, reducing noise in monitoring scenarios
The operator always emits final results when the input stream ends,
regardless of the frequency setting.
## Related PRs
- Documentation: tenzir/docs#153
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new
optionsargument for thesummarizeoperator that enablesperiodic emission of aggregation results at fixed intervals:
frequencyparameter documentation for setting emission intervalsmodeparameter documentation (reset, cumulative, update modes)Related PRs