-
Notifications
You must be signed in to change notification settings - Fork 552
docs: outputs: add ZeroBus output plugin documentation #2537
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.
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
base: master
Are you sure you want to change the base?
Changes from all commits
5dac612
1c4b72f
8fd9703
d8b8c37
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| --- | ||
| description: Send logs to Databricks through Zerobus | ||
|
Check warning on line 2 in pipeline/outputs/zerobus.md
|
||
| --- | ||
|
|
||
| # Zerobus | ||
|
Check warning on line 5 in pipeline/outputs/zerobus.md
|
||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @mats16 same here, back-ticks is the fix. |
||
|
|
||
| {% hint style="info" %} | ||
| **Supported event types:** `logs` | ||
| {% endhint %} | ||
|
|
||
| The _Zerobus_ output plugin lets you ingest log records into a [Databricks](https://www.databricks.com/) table through the Zerobus streaming ingestion interface. Records are converted to JSON and sent by using the Zerobus SDK using gRPC. | ||
|
Check warning on line 11 in pipeline/outputs/zerobus.md
|
||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @mats16 more back-ticks needed. |
||
|
|
||
| Before you begin, you need a Databricks workspace with a Unity Catalog table configured for Zerobus ingestion, and an OAuth 2.0 service principal (client ID and client secret) with appropriate permissions. | ||
|
Check warning on line 13 in pipeline/outputs/zerobus.md
|
||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @mats16 most of this is back-tick solvable. |
||
|
|
||
| ## Build requirements | ||
|
|
||
| If you are compiling Fluent Bit from source, the `zerobus-ffi` shared library and header must be installed on your build environment before building. Pre-built binaries are available from the [zerobus-sdk releases](https://github.com/databricks/zerobus-sdk/releases). | ||
|
|
||
| Download `zerobus-ffi-1.1.0.tar.gz` and place the files for your platform (`linux-x86_64` or `linux-aarch64`) into the following directories: | ||
|
|
||
| | File | Destination | | ||
| | :--- | :--- | | ||
| | `libzerobus_ffi.so` | `/usr/local/lib/` | | ||
| | `libzerobus_ffi.a` | `/usr/local/lib/` | | ||
| | `zerobus.h` | `/usr/local/include/` | | ||
|
|
||
| After placing the files, run `sudo ldconfig` to update the shared library cache. | ||
|
|
||
| ## Configuration parameters | ||
|
|
||
| | Key | Description | Default | | ||
| | :--- | :--- | :--- | | ||
| | `endpoint` | Zerobus gRPC endpoint URL. If no scheme is provided, `https://` is automatically prepended. | _none_ | | ||
|
Check warning on line 33 in pipeline/outputs/zerobus.md
|
||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @mats16 more back-ticks needed. |
||
| | `workspace_url` | Databricks workspace URL. If no scheme is provided, `https://` is automatically prepended. | _none_ | | ||
| | `table_name` | Fully qualified Unity Catalog table name in `catalog.schema.table` format. | _none_ | | ||
| | `client_id` | OAuth 2.0 client ID for authentication. | _none_ | | ||
| | `client_secret` | OAuth 2.0 client secret for authentication. | _none_ | | ||
| | `add_tag` | If enabled, the Fluent Bit tag is added as a `_tag` field in each record. | `true` | | ||
| | `time_key` | Key name for the injected timestamp. The timestamp is formatted as RFC 3339 with nanosecond precision. Set to an empty string to disable timestamp injection. | `_time` | | ||
| | `log_key` | Comma-separated list of record keys to include in the output. When unset, all keys are included. | _none_ | | ||
| | `raw_log_key` | If set, the full original record (before filtering by `log_key`) is stored as a JSON string under this key name. | _none_ | | ||
|
|
||
| ## Get started | ||
|
|
||
| To send log records to Databricks through Zerobus, configure the plugin with your Zerobus endpoint, workspace URL, table name, and OAuth 2.0 credentials. | ||
|
|
||
| ### Configuration file | ||
|
|
||
| {% tabs %} | ||
| {% tab title="fluent-bit.yaml" %} | ||
|
|
||
| ```yaml | ||
| pipeline: | ||
| inputs: | ||
| - name: tail | ||
| tag: app.logs | ||
| path: /var/log/app/*.log | ||
|
|
||
| outputs: | ||
| - name: zerobus | ||
| match: '*' | ||
| endpoint: https://<workspace-id>.zerobus.<region>.cloud.databricks.com | ||
| workspace_url: https://<instance-name>.cloud.databricks.com | ||
| table_name: catalog.schema.logs | ||
| client_id: <your-client-id> | ||
| client_secret: <your-client-secret> | ||
| ``` | ||
|
|
||
| {% endtab %} | ||
| {% tab title="fluent-bit.conf" %} | ||
|
|
||
| ```text | ||
| [INPUT] | ||
| Name tail | ||
| Tag app.logs | ||
| Path /var/log/app/*.log | ||
|
|
||
| [OUTPUT] | ||
| Name zerobus | ||
| Match * | ||
| Endpoint https://<workspace-id>.zerobus.<region>.cloud.databricks.com | ||
| Workspace_Url https://<instance-name>.cloud.databricks.com | ||
| Table_Name catalog.schema.logs | ||
| Client_Id <your-client-id> | ||
| Client_Secret <your-client-secret> | ||
| ``` | ||
|
|
||
| {% endtab %} | ||
| {% endtabs %} | ||
|
|
||
| ### Record format | ||
|
|
||
| Each log record is converted to a JSON object before ingestion. The plugin applies the following transformations in order: | ||
|
|
||
| 1. If `raw_log_key` is set, the full original record is captured as a JSON string before any filtering. | ||
| 2. If `log_key` is set, only the specified keys are included in the output record. | ||
| 3. If `raw_log_key` is set, the captured JSON string is injected under the configured key (unless a key with that name already exists). | ||
| 4. If `time_key` is set, a timestamp in RFC 3339 format with nanosecond precision (for example, `2024-01-15T10:30:00.123456789Z`) is injected (unless a key with that name already exists). | ||
| 5. If `add_tag` is enabled, the Fluent Bit tag is injected as `_tag` (unless a key with that name already exists). | ||
|
eschabell marked this conversation as resolved.
|
||
|
|
||
| For example, given the following input record: | ||
|
|
||
| ```json | ||
| {"level": "info", "message": "request completed", "status": 200} | ||
| ``` | ||
|
|
||
| The default configuration produces: | ||
|
|
||
| ```json | ||
| { | ||
| "level": "info", | ||
| "message": "request completed", | ||
| "status": 200, | ||
| "_time": "2024-01-15T10:30:00.123456789Z", | ||
| "_tag": "app.logs" | ||
| } | ||
| ``` | ||
|
|
||
| ### Filtering keys | ||
|
|
||
| Use `log_key` to select specific fields from the record. Combined with `raw_log_key`, you can send a filtered record while preserving the original data: | ||
|
|
||
| {% tabs %} | ||
| {% tab title="fluent-bit.yaml" %} | ||
|
|
||
| ```yaml | ||
| pipeline: | ||
| outputs: | ||
| - name: zerobus | ||
| match: '*' | ||
| endpoint: https://<workspace-id>.zerobus.<region>.cloud.databricks.com | ||
| workspace_url: https://<instance-name>.cloud.databricks.com | ||
| table_name: catalog.schema.logs | ||
| client_id: <your-client-id> | ||
| client_secret: <your-client-secret> | ||
| log_key: level,message | ||
| raw_log_key: _raw | ||
| ``` | ||
|
|
||
| {% endtab %} | ||
| {% tab title="fluent-bit.conf" %} | ||
|
|
||
| ```text | ||
| [OUTPUT] | ||
| Name zerobus | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @mats16 all indentation in example code is 2 spaced, looks like 4 here? |
||
| Match * | ||
| Endpoint https://<workspace-id>.zerobus.<region>.cloud.databricks.com | ||
| Workspace_Url https://<instance-name>.cloud.databricks.com | ||
| Table_Name catalog.schema.logs | ||
| Client_Id <your-client-id> | ||
| Client_Secret <your-client-secret> | ||
| Log_Key level,message | ||
| Raw_Log_Key _raw | ||
| ``` | ||
|
|
||
| {% endtab %} | ||
| {% endtabs %} | ||
|
|
||
| This produces: | ||
|
|
||
| ```json | ||
| { | ||
| "level": "info", | ||
| "message": "request completed", | ||
| "_raw": "{\"level\":\"info\",\"message\":\"request completed\",\"status\":200}", | ||
| "_time": "2024-01-15T10:30:00.123456789Z", | ||
| "_tag": "app.logs" | ||
| } | ||
| ``` | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mats16 for names like this to pass listing you need to use back-ticks around them.