Skip to content

Commit 7d86f57

Browse files
out_azure_kusto: add docs for plugin buffering functionality (#1546)
* Update azure_kusto.md for buffering commits Signed-off-by: Tanmaya Panda <[email protected]> * Update pipeline/outputs/azure_kusto.md Signed-off-by: esmerel <[email protected]> --------- Signed-off-by: Tanmaya Panda <[email protected]> Signed-off-by: esmerel <[email protected]> Co-authored-by: esmerel <[email protected]>
1 parent 1bde286 commit 7d86f57

File tree

1 file changed

+35
-12
lines changed

1 file changed

+35
-12
lines changed

pipeline/outputs/azure_kusto.md

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -66,28 +66,51 @@ By default, Kusto will insert incoming ingestions into a table by inferring the
6666
| time_key | The key name of time. If `include_time_key` is false, This property is ignored. | `timestamp` |
6767
| ingestion_endpoint_connect_timeout | The connection timeout of various Kusto endpoints in seconds. | `60` |
6868
| compression_enabled | If enabled, sends compressed HTTP payload (gzip) to Kusto. | `true` |
69-
| ingestion_resources_refresh_interval | The ingestion resources refresh interval of Kusto endpoint in seconds. | `3600` |
70-
| workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
69+
| ingestion_resources_refresh_interval | The ingestion resources refresh interval of Kusto endpoint in seconds.
70+
| workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
71+
| buffering_enabled | _Optional_ - Enable buffering into disk before ingesting into Azure Kusto. | `Off` |
72+
| buffer_dir | _Optional_ - When buffering is `On`, specifies the location of directory where the buffered data will be stored. | `/tmp/fluent-bit/azure-kusto/` |
73+
| upload_timeout | _Optional_ - When buffering is `On`, specifies a timeout for uploads. Fluent Bit will start ingesting buffer files which have been created more than x minutes and haven't reached `upload_file_size` limit. | `30m` |
74+
| upload_file_size | _Optional_ - When buffering is `On`, specifies the size of files to be uploaded in MBs. | `200MB` |
75+
| azure_kusto_buffer_key | _Optional_ - When buffering is `On`, set the Azure Kusto buffer key which must be specified when using multiple instances of Azure Kusto output plugin and buffering is enabled. | `key` |
76+
| store_dir_limit_size | _Optional_ - When buffering is `On`, set the max size of the buffer directory. | `8GB` |
77+
| buffer_file_delete_early | _Optional_ - When buffering is `On`, whether to delete the buffered file early after successful blob creation. | `Off` |
78+
| unify_tag | _Optional_ - This creates a single buffer file when the buffering mode is `On`. | `On` |
79+
| blob_uri_length | _Optional_ - Set the length of generated blob URI before ingesting to Kusto. | `64` |
80+
| scheduler_max_retries | _Optional_ - When buffering is `On`, set the maximum number of retries for ingestion using the scheduler. | `3` |
81+
| delete_on_max_upload_error | _Optional_ - When buffering is `On`, whether to delete the buffer file on maximum upload errors. | `Off` |
82+
| io_timeout | _Optional_ - Configure the HTTP IO timeout for uploads. | `60s` |
7183

7284
### Configuration File
7385

7486
Get started quickly with this configuration file:
7587

7688
```
7789
[OUTPUT]
78-
match *
79-
name azure_kusto
80-
tenant_id <app_tenant_id>
81-
client_id <app_client_id>
82-
client_secret <app_secret>
83-
ingestion_endpoint https://ingest-<cluster>.<region>.kusto.windows.net
84-
database_name <database_name>
85-
table_name <table_name>
86-
ingestion_mapping_reference <mapping_name>
90+
Match *
91+
Name azure_kusto
92+
Tenant_Id <app_tenant_id>
93+
Client_Id <app_client_id>
94+
Client_Secret <app_secret>
95+
Ingestion_Endpoint https://ingest-<cluster>.<region>.kusto.windows.net
96+
Database_Name <database_name>
97+
Table_Name <table_name>
98+
Ingestion_Mapping_Reference <mapping_name>
8799
ingestion_endpoint_connect_timeout <ingestion_endpoint_connect_timeout>
88100
compression_enabled <compression_enabled>
89101
ingestion_resources_refresh_interval <ingestion_resources_refresh_interval>
90-
102+
buffering_enabled On
103+
upload_timeout 2m
104+
upload_file_size 125M
105+
azure_kusto_buffer_key kusto1
106+
buffer_file_delete_early Off
107+
unify_tag On
108+
buffer_dir /var/log/
109+
store_dir_limit_size 16GB
110+
blob_uri_length 128
111+
scheduler_max_retries 3
112+
delete_on_max_upload_error Off
113+
io_timeout 60s
91114
```
92115

93116
## Troubleshooting

0 commit comments

Comments
 (0)