Skip to content

Commit 353b84b

Browse files
Merge pull request #2633 from MicrosoftDocs/main638839408777954478sync_temp
For protected branch, push strategy should use PR and merge to target branch method to work around git push error
2 parents 05aab58 + 23e56f0 commit 353b84b

17 files changed

+114
-117
lines changed

data-explorer/includes/cross-repo/fluent-bit-2.md

Lines changed: 67 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -74,18 +74,32 @@ To configure Fluent Bit to send logs to your table in Kusto, create a [classic m
7474
| tenant_id | The tenant ID from [Create a Microsoft Entra service principal](#create-a-microsoft-entra-service-principal). | :heavy_check_mark: | |
7575
| client_id | The application ID from [Create a Microsoft Entra service principal](#create-a-microsoft-entra-service-principal). | :heavy_check_mark: | |
7676
| client_secret | The client secret key value (password) from [Create a Microsoft Entra service principal](#create-a-microsoft-entra-service-principal). | :heavy_check_mark: | |
77+
| managed_identity_client_id | The client ID of the managed identity to use for authentication. | :heavy_check_mark: | |
7778
| ingestion_endpoint | Enter the value as described for [Ingestion_Endpoint](#ingestion-uri). | :heavy_check_mark: | |
7879
| database_name | The name of the database that contains your logs table. | :heavy_check_mark: | |
7980
| table_name | The name of the table from [Create a target table](#create-a-target-table). | :heavy_check_mark: | |
8081
| ingestion_mapping_reference | The name of the ingestion mapping from [Create a target table](#create-a-target-table). If you didn't create an ingestion mapping, remove the property from the configuration file. | | |
8182
| log_key | Key name of the log content. For instance, `log`. | | `log` |
83+
| include_tag_key | If enabled, a tag is appended to output.| | `On` |
8284
| tag_key | The key name of tag. Ignored if `include_tag_key` is false. | | `tag` |
83-
| include_time_key | A timestamp is appended to output, if enabled. Uses the `time_key` property. | | `true` |
85+
| include_time_key | A timestamp is appended to output, if enabled. Uses the `time_key` property. | | `On` |
8486
| time_key | The key name for the timestamp in the log records. Ignored if `include_time_key` false. | | `timestamp` |
85-
| ingestion_endpoint_connect_timeout | The connection timeout of various Kusto endpoints in seconds. | | `60s` |
87+
| ingestion_endpoint_connect_timeout | The connection timeout of various Kusto endpoints in seconds. | | `60` |
8688
| compression_enabled | Sends compressed HTTP payload (gzip) to Kusto, if enabled. | | `true` |
87-
| ingestion_resources_refresh_interval | The ingestion resources refresh interval of Kusto endpoint in seconds. | | `3600` |
89+
| ingestion_resources_refresh_interval | The ingestion resources refresh interval of Kusto endpoint in seconds. | | |
8890
| workers | The number of [workers](https://docs.fluentbit.io/manual/administration/multithreading#outputs) to perform flush operations for this output. | | `0` |
91+
| buffering_enabled | If enabled, buffers data into disk before ingesting into Kusto. | | `Off` |
92+
| buffer_path | Specifies the location of the directory where the buffered data will be stored if `buffering_enabled` is `On`. | | `/tmp/fluent-bit/azure-kusto/` |
93+
| upload_timeout | Specifies the timeout for uploads if `buffering_enabled` is `On`. Files older than this are ingested even if below size limit. | | `30m` |
94+
| upload_file_size | Specifies the maximum size of a file to be uploaded if `buffering_enabled` is `On`. | | `200MB` |
95+
| azure_kusto_buffer_key | Azure Kusto buffer key to identify plugin instances when `buffering_enabled` is `On`. Required for multiple Azure Kusto outputs with buffering. | | `key` |
96+
| store_dir_limit_size | The maximum size of the directory where buffered data is stored if `buffering_enabled` is `On`. | | `8GB` |
97+
| buffer_file_delete_early| When `buffering_enabled` is `On`, whether to delete the buffered file early after successful blob creation. | | `Off` |
98+
| unify_tag | Creates a single buffer file when `buffering_enabled` is `On`. | | `On` |
99+
| blob_uri_length | Set the length of generated blob URI before ingesting to Kusto. | | `64` |
100+
| scheduler_max_retries | When `buffering_enabled` is `On`, set the maximum number of retries for ingestion using the scheduler. | | `3` |
101+
| delete_on_max_upload_error | When `buffering_enabled` is `On`, whether to delete the buffer file on maximum upload errors. | | `Off` |
102+
| IO_timeout | Configure the HTTP IO timeout for uploads. | | `60s` |
89103

90104
To see an example configuration file, select the relevant tab:
91105

@@ -110,18 +124,31 @@ To see an example configuration file, select the relevant tab:
110124
Refresh_Interval 10
111125
112126
[OUTPUT]
113-
match *
114-
name azure_kusto
115-
tenant_id <TenantId>
116-
client_id <ClientId>
117-
client_secret <AppSecret>
118-
ingestion_endpoint <IngestionEndpoint>
119-
database_name <DatabaseName>
120-
table_name <TableName>
121-
ingestion_mapping_reference <MappingName>
122-
ingestion_endpoint_connect_timeout <IngestionEndpointConnectTimeout>
123-
compression_enabled <CompressionEnabled>
124-
ingestion_resources_refresh_interval <IngestionResourcesRefreshInterval>
127+
[OUTPUT]
128+
Match *
129+
Name azure_kusto
130+
Tenant_Id <app_tenant_id>
131+
Client_Id <app_client_id>
132+
Client_Secret <app_secret>
133+
Ingestion_Endpoint https://ingest-<cluster>.<region>.kusto.windows.net
134+
Database_Name <database_name>
135+
Table_Name <table_name>
136+
Ingestion_Mapping_Reference <mapping_name>
137+
ingestion_endpoint_connect_timeout <ingestion_endpoint_connect_timeout>
138+
compression_enabled <compression_enabled>
139+
ingestion_resources_refresh_interval <ingestion_resources_refresh_interval>
140+
buffering_enabled On
141+
upload_timeout 2m
142+
upload_file_size 125M
143+
azure_kusto_buffer_key kusto1
144+
buffer_file_delete_early Off
145+
unify_tag On
146+
buffer_dir /var/log/
147+
store_dir_limit_size 16GB
148+
blob_uri_length 128
149+
scheduler_max_retries 3
150+
delete_on_max_upload_error Off
151+
io_timeout 60s
125152
```
126153

127154
### [YAML mode](#tab/yaml)
@@ -160,18 +187,31 @@ config:
160187
161188
outputs: |
162189
[OUTPUT]
163-
match *
164-
name azure_kusto
165-
tenant_id <TenantId>
166-
client_id <ClientId>
167-
client_secret <AppSecret>
168-
ingestion_endpoint <IngestionEndpoint>
169-
database_name <DatabaseName>
170-
table_name <TableName>
171-
ingestion_mapping_reference <MappingName>
172-
ingestion_endpoint_connect_timeout <IngestionEndpointConnectTimeout>
173-
compression_enabled <CompressionEnabled>
174-
ingestion_resources_refresh_interval <IngestionResourcesRefreshInterval>
190+
[OUTPUT]
191+
Match *
192+
Name azure_kusto
193+
Tenant_Id <app_tenant_id>
194+
Client_Id <app_client_id>
195+
Client_Secret <app_secret>
196+
Ingestion_Endpoint https://ingest-<cluster>.<region>.kusto.windows.net
197+
Database_Name <database_name>
198+
Table_Name <table_name>
199+
Ingestion_Mapping_Reference <mapping_name>
200+
ingestion_endpoint_connect_timeout <ingestion_endpoint_connect_timeout>
201+
compression_enabled <compression_enabled>
202+
ingestion_resources_refresh_interval <ingestion_resources_refresh_interval>
203+
buffering_enabled On
204+
upload_timeout 2m
205+
upload_file_size 125M
206+
azure_kusto_buffer_key kusto1
207+
buffer_file_delete_early Off
208+
unify_tag On
209+
buffer_dir /var/log/
210+
store_dir_limit_size 16GB
211+
blob_uri_length 128
212+
scheduler_max_retries 3
213+
delete_on_max_upload_error Off
214+
io_timeout 60s
175215
```
176216
177217
---

data-explorer/kusto/query/arg-max-aggregation-function.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ Returns a row in the table that maximizes the specified expression *ExprToMaximi
3737
3838
## Examples
3939

40+
### General examples
41+
4042
The following example finds the maximum latitude of a storm event in each state.
4143

4244
:::moniker range="azure-data-explorer"
@@ -67,7 +69,6 @@ The results table displays only the first 10 rows.
6769
| TEXAS | 36.4607 | DARROUZETT |
6870
| ... | ... | ... |
6971

70-
7172
The following example finds the last time an event with a direct death happened in each state, showing all the columns.
7273

7374
The query first filters the events to include only those events where there was at least one direct death. Then the query returns the entire row with the most recent `StartTime`.
@@ -101,7 +102,6 @@ The results table displays only the first 10 rows and first three columns.
101102
| LAKE MICHIGAN | 2007-06-07T13:00:00Z | 2007-06-07T13:00:00Z | ... |
102103
| ... | ... | ... | ... |
103104

104-
105105
The following example demonstrates null handling.
106106

107107
:::moniker range="azure-data-explorer"
@@ -129,16 +129,11 @@ datatable(Fruit: string, Color: string, Version: int) [
129129
| Banana | | Yellow |
130130
| Pear | 2 | Green |
131131

132-
## Comparison to max()
132+
### Examples comparing arg_max() and max()
133133

134134
The arg_max() function differs from the [max() function](max-aggregation-function.md). The arg_max() function allows you to return other columns along with the maximum value, and [max()](max-aggregation-function.md) only returns the maximum value itself.
135135

136-
### Examples
137-
138-
#### arg_max()
139-
140-
The following example finds the last time an event with a direct death happened, showing all the columns in the table.
141-
136+
The following example uses arg_max() to find the last time an event with a direct death happened in each state, showing all the columns.
142137
The query first filters the events to only include events where there was at least one direct death. Then the query returns the entire row with the most recent (maximum) StartTime.
143138

144139
:::moniker range="azure-data-explorer"
@@ -158,11 +153,7 @@ The results table returns all the columns for the row containing the highest val
158153
|--|--|--|--|
159154
| 2007-12-31T15:00:00Z | 2007-12-31T15:00:00 | 12688 | 69700 | UTAH | Avalanche | ... |
160155

161-
#### max()
162-
163-
Find the last time an event with a direct death happened.
164-
165-
The query filters events to only include events where there is at least one direct death, and then returns the maximum value for StartTime.
156+
The following example uses the max() function to find the last time an event with a direct death happened in each state, but only returns the maximum value of StartTime.
166157

167158
:::moniker range="azure-data-explorer"
168159
> [!div class="nextstepaction"]

data-explorer/kusto/query/arg-min-aggregation-function.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Returns a row in the table that minimizes *ExprToMinimize*, and the values of co
4141
4242
## Examples
4343

44-
Find the minimum latitude of a storm event in each state.
44+
The following example finds the maximum latitude of a storm event in each state.
4545

4646
:::moniker range="azure-data-explorer"
4747
> [!div class="nextstepaction"]
@@ -137,11 +137,7 @@ The arg_min() function differs from the [min() function](min-aggregation-functio
137137

138138
### Examples
139139

140-
#### arg_min()
141-
142-
Find the first time an event with a direct death happened, showing all the columns in the table.
143-
144-
The query first filters the events to only include those where there was at least one direct death. Then the query returns the entire row with the lowest value for StartTime.
140+
The following example uses arg_min() to find the last time an event with a direct death happened in each state, showing all the columns.
145141

146142
:::moniker range="azure-data-explorer"
147143
> [!div class="nextstepaction"]
@@ -160,11 +156,7 @@ The results table returns all the columns for the row containing the lowest valu
160156
|--|--|--|--|
161157
| 2007-01-01T00:00:00Z | 2007-01-22T18:49:00Z | 2408 | 11929 | INDIANA | Flood | ... |
162158

163-
#### min()
164-
165-
Find the first time an event with a direct death happened.
166-
167-
The query filters events to only include those where there is at least one direct death, and then returns the minimum value for StartTime.
159+
The following example uses the min() function to find the last time an event with a direct death happened in each state, but only returns the minimum value of StartTime.
168160

169161
:::moniker range="azure-data-explorer"
170162
> [!div class="nextstepaction"]

data-explorer/kusto/query/array-iff-function.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ Returns a dynamic array of the values taken either from the *when_true* or *when
4040

4141
## Examples
4242

43+
The following example shows how to use the `array_iff()` function to evaluate elements in an array.
44+
4345
:::moniker range="azure-data-explorer"
4446
> [!div class="nextstepaction"]
4547
> <a href="https://dataexplorer.azure.com/clusters/help/databases/Samples?query=H4sIAAAAAAAAAysoyswrUUjOz0vJLMnMz7NNqcxLzM1M1oguKSpN1UlLzClO1QExYzV1FHIQsoY6RjrGILEihJiJjqmOWaymAi9XjUJqRUlqXopCUWqxbWJRUWJlfGZmmgbcFqBRQJ2aACda2uZ8AAAA" target="_blank">Run the query</a>
@@ -56,7 +58,7 @@ print condition=dynamic([true,false,true]), if_true=dynamic([1,2,3]), if_false=d
5658
|---|---|---|---|
5759
|[true, false, true]|[1, 2, 3]|[4, 5, 6]|[1, 5, 3]|
5860

59-
### Numeric condition values
61+
The following example shows how numeric condition values are treated as boolean values.
6062

6163
:::moniker range="azure-data-explorer"
6264
> [!div class="nextstepaction"]
@@ -74,7 +76,7 @@ print condition=dynamic([1,0,50]), if_true="yes", if_false="no"
7476
|---|---|---|---|
7577
|[1, 0, 50]|yes|no|[yes, no, yes]|
7678

77-
### Non-numeric and non-boolean condition values
79+
The following example shows how to use the `array_iff()` function with non-numeric and non-boolean condition values.
7880

7981
:::moniker range="azure-data-explorer"
8082
> [!div class="nextstepaction"]
@@ -92,7 +94,7 @@ print condition=dynamic(["some string value", datetime("01-01-2022"), null]), if
9294
|---|---|---|---|
9395
|[true, false, true]|1|0|[null, null, null]|
9496

95-
### Mismatched array lengths
97+
The following example shows how the function handles mismatched array lengths.
9698

9799
:::moniker range="azure-data-explorer"
98100
> [!div class="nextstepaction"]

data-explorer/kusto/query/beta-inv-function.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ The inverse of the beta cumulative probability density function [beta_cdf()](bet
4242
4343
## Examples
4444

45+
The following example shows how to use the `beta_inv()` function to return the inverse of the beta cumulative probability density function.
46+
4547
:::moniker range="azure-data-explorer"
4648
> [!div class="nextstepaction"]
4749
> <a href="https://dataexplorer.azure.com/clusters/help/databases/Samples?query=H4sIAAAAAAAAA11PQQrCMBC85xVDTw3EkAheivYJPXoRkdQEDaRpsIko+HhDWiq4C8sOzOzOaBVz987UodFjyguDcuGuVtSb+APXcRiMj80UH9bfKDkR5BJcMkjBBcO2zOqonNWwPqRYscKRfPfHCWiRdW9rnJ7gk3MLtZybP9YbyQVdJcUZ7IQ9xKrsVFeRM/nAvKLxGj0OxfTF+mcdljhzDvoFBansKu8AAAA=" target="_blank">Run the query</a>

data-explorer/kusto/query/consume-operator.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,8 @@ Consumes the tabular data stream handed to the operator.
1414
The `consume` operator is mostly used for triggering the query side-effect without actually returning
1515
the results back to the caller.
1616

17-
The `consume` operator can be used for estimating the
18-
cost of a query without actually delivering the results back to the client.
19-
(The estimation isn't exact for various reasons; for example, `consume`
20-
is calculated distributively, so `T | consume` won't transmit the table's
21-
data between the nodes of the cluster.)
17+
The `consume` operator can be used for estimating the cost of a query without actually delivering the results back to the client.
18+
(The estimation isn't exact for various reasons; for example, `consume` is calculated distributively, so `T | consume` won't transmit the table's data between the nodes of the cluster.)
2219

2320
## Syntax
2421

@@ -32,9 +29,13 @@ data between the nodes of the cluster.)
3229
|--|--|--|--|
3330
| *DecodeBlocks* | `bool` | | If set to `true`, or if the request property `perftrace` is set to `true`, the `consume` operator won't just enumerate the records at its input, but actually force each value in those records to be decompressed and decoded.|
3431

35-
## Example
32+
### Returns
3633

37-
The following example consumes the results of a query without returning any data to the client.
34+
The `consume` operator returns the same tabular data stream as its input, but it doesn't return the data to the client.
35+
36+
## Examples
37+
38+
The following example shows how to use the `consume` operator to trigger the query side-effect without actually returning the results back to the caller.
3839

3940
:::moniker range="azure-data-explorer"
4041
> [!div class="nextstepaction"]
@@ -47,5 +48,7 @@ StormEvents
4748
| consume
4849
```
4950

51+
In this example, the query filters the `StormEvents` table for rows where the `State` is "TEXAS" and then applies the `consume` operator. The data is processed, but no results are returned to the client.
52+
5053
**Output**
51-
No rows to show.
54+
The results table is empty, as the `consume` operator does not return any data to the client.

data-explorer/kusto/query/distinct-operator.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ Produces a table with the distinct combination of the provided columns of the in
2828
> [!NOTE]
2929
> The `distinct` operator supports providing an asterisk `*` as the group key to denote all columns, which is helpful for wide tables.
3030
31-
## Example
31+
## Examples
3232

33-
Shows distinct combination of states and type of events that led to over 45 direct injuries.
33+
The following example shows how to use the `distinct` operator to create a table with the distinct combination of the columns of the input table.
3434

3535
:::moniker range="azure-data-explorer"
3636
> [!div class="nextstepaction"]

data-explorer/kusto/query/geo-s2cell-to-central-point-function.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ The geospatial coordinate values in [GeoJSON Format](https://tools.ietf.org/html
3434
3535
## Examples
3636

37+
The following example calculates the geospatial coordinates that represent the center of an S2 cell.
38+
3739
:::moniker range="azure-data-explorer"
3840
> [!div class="nextstepaction"]
3941
> <a href="https://dataexplorer.azure.com/clusters/help/databases/Samples?query=H4sIAAAAAAAAAysoyswrUSjIB5G2Cump+fHFRsmpOTnxJfnxyal5JUWJOfFgWQ0lQyNjE1MzcyVNrhqF1IqS1LwUheT8/KKUzLzEktRioG6wOj0kMYTCnPy89MyS0pRUoDIkBdEGsToKOYkl2KQMYwEypEkCnAAAAA==" target="_blank">Run the query</a>

data-explorer/kusto/query/geo-s2cell-to-polygon-function.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.date: 08/11/2024
99

1010
> [!INCLUDE [applies](../includes/applies-to-version/applies.md)] [!INCLUDE [fabric](../includes/applies-to-version/fabric.md)] [!INCLUDE [azure-data-explorer](../includes/applies-to-version/azure-data-explorer.md)] [!INCLUDE [monitor](../includes/applies-to-version/monitor.md)] [!INCLUDE [sentinel](../includes/applies-to-version/sentinel.md)]
1111
12-
Calculates the polygon that represents the S2 Cell rectangular area.
12+
Calculates the polygon that represents the S2 Cell rectangular area.
1313

1414
Read more about [S2 Cells](http://s2geometry.io/devguide/s2cell_hierarchy).
1515

@@ -34,6 +34,8 @@ Polygon in [GeoJSON Format](https://tools.ietf.org/html/rfc7946) and of a [dynam
3434
3535
## Examples
3636

37+
The following example calculates the polygon that represents the S2 Cell rectangular area.
38+
3739
:::moniker range="azure-data-explorer"
3840
> [!div class="nextstepaction"]
3941
> <a href="https://dataexplorer.azure.com/clusters/help/databases/Samples?query=H4sIAAAAAAAAAysoyswrUSg2Sk7NyQnIz6lMz89TsFVIT82Ph4jFl+THF0DENZQsLJONTC2VNAF6g4+NNQAAAA==" target="_blank">Run the query</a>

0 commit comments

Comments
 (0)