Output Processors
The Analytics module makes use of built-in Output processors to write the results of Statistical Functions and KPIs to a topic or database.
The following describes the output processors that are currently available.
- Publish all inputs to a specified DB metric.
Parameters | Details |
|---|---|
Database | If left empty, the default database will be used. |
Measurement | Name of the measurement to publish. |
Typed | Publish typed name. |
Note: The Measurement parameter is a required field.
- Publish events from input to a specified DataHub topic.
Parameters | Details |
|---|---|
Single Topic | |
Topic | Topic name for DataHub publish. |
- Converts input data to specified format, and writes it to a file.
- This can be done by either adding to the end of the file, or replacing the existing content.
- Alternatively, it can also delete the file.
- If the "Generate Filename From Expression" option is enabled, the filename will be evaluated as expression.
- For example, if you want to get the filename from "path" and name" properties of incoming connection "AAA", your expression could be: AAA_path + AAA_name + ".txt"
- Please note that static text in expressions should be put into quotes.
- Timer interval in seconds acts as a "Re-write file on timer" option.
- This is useful if you want to keep generating new file names after every few intervals.
- If "Output File Type" is set to value only processor will save incoming data from "value"" payload field as is.
- If "Output File Type" is set to CSV following options will affect output:
- CSV Comma contains CSV-file delimiter (only first character will be used from string entered).
- CSV Header controls whether column names will be included or not.
- CSV Columns From Payload controls whether column names will be generated from payload.
- CSV Custom Columns contains comma-separated list of columns names (overrides CSV Columns From Payload!)
- If "Output File Type" is set to Parquet output file will be rewritten on each incoming payload.
- If Write file Method is set to "append" then last Parquet Buffer Capacity records will be written to file.
Parameters | Details |
|---|---|
File Name | Specifies the name of the file to which data will be written. |
File Write Method | Determines how the data will be written to the file (e.g., appending, overwriting, delete). |
Output File Type | Defines the format of the output file (e.g., JSON, CSV, Parquet). |
Add New Line | Indicates whether to append a new line after each entry in the output file. |
Create Directories | Option to automatically create any necessary directories if they do not exist. |
Generate Filename From Expression | Enables dynamic filename generation based on specified expressions. |
Time Interval in Seconds | Sets a timer for rewriting the file at specified intervals. |
CSV Comma | Specifies the delimiter to be used in CSV files; only the first character will be applied. |
CSV Header | Controls the inclusion or exclusion of column names in the output CSV file. |
CSV Columns From Payload | Determines if column names should be generated based on the incoming payload. |
CSV Custom Columns | Allows the specification of custom column names, overriding those from the payload. |
Parquet Capacity | Defines the buffer size for records in Parquet files, influencing how data is written. |
- Just consumers that print to the console. Note: The output is meant for support logs, not for display on the UI.
