Skip to content

stream-processing: getting-started: README: general cleanup #1630

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 2, 2025
Merged

stream-processing: getting-started: README: general cleanup #1630

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d4c138
stream-processing: getting-started: README: general cleanup
alexakreizinger May 2, 2025
c628413
Update stream-processing/getting-started/README.md
alexakreizinger May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 6 additions & 18 deletions stream-processing/getting-started/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,9 @@
# Getting Started

The following guide assumes that you are familiar with [Fluent Bit](https://fluentbit.io), if that is not the case we suggest you review the official manual first:

* [Fluent Bit Manual](https://docs.fluentbit.io/manual/)

## Requirements

* [Fluent Bit](https://fluentbit.io) >= v1.1.0 or Fluent Bit from [GIT Master](https://github.com/fluent/fluent-bit)
* Basic understanding of Structured Query Language \(SQL\)

## Technical Concepts
# Get started

| Concept | Description |
| :--- | :--- |
| Stream | A Stream represents an unique flow of data being ingested by an Input plugin. By default Streams get a name using the plugin name plus an internal numerical identification, e.g: tail.0 . Stream name can be changed setting the _alias_ property. |
| Task | Stream Processor configuration have the notion of Tasks that represents an execution unit, for short: SQL queries are configured in a Task. |
| Results | When Stream Processor runs a SQL query, results are generated. These results can be re-ingested back into the main Fluent Bit pipeline or simply redirected to the standard output interfaces for debugging purposes. |
| Tag | Fluent Bit group records and associate a Tag to them. Tags are used to define routing rules or in the case of the stream processor to attach to specific Tag that matches a pattern. |
| Match | Matching rule that can use a wildcard to match specific records associated to a Tag. |

| Stream | A stream is a single flow of data being ingested by an input plugin. By default, each stream name is the name of its input plugin plus a number (for example, `tail.0`). You can use the `alias` property to change this name. |
| Task | A single execution unit. For example, a SQL query. |
| Results | After a stream processor runs a SQL query, results are generated. You can re-ingest these results back into the main Fluent Bit pipeline or redirect them to the standard output interface for debugging purposes. |
| Tag | Fluent Bit groups records and assigns tags to them. These tags define routing rules and can be used to apply stream processors to specific tags that match a pattern. |
| Match | Matching rules can use a wildcard to match specific records associated with a tag. |