Skip to content

Commit aeff1a1

Browse files
committed
Pipeline: output: azure: style
Signed-off-by: Lynette Miles <[email protected]>
1 parent d8b48b3 commit aeff1a1

File tree

2 files changed

+25
-24
lines changed

2 files changed

+25
-24
lines changed

pipeline/outputs/azure.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
11
---
2-
description: 'Send logs, metrics to Azure Log Analytics'
2+
description: Send logs, metrics to Azure Log Analytics
33
---
44

55
# Azure Log Analytics
66

7-
Azure output plugin allows to ingest your records into [Azure Log Analytics](https://azure.microsoft.com/en-us/services/log-analytics/) service.
7+
Azure output plugin lets you ingest your records into [Azure Log Analytics](https://azure.microsoft.com/en-us/services/log-analytics/) service.
88

9-
To get more details about how to setup Azure Log Analytics, please refer to the following documentation: [Azure Log Analytics](https://docs.microsoft.com/en-us/azure/log-analytics/)
9+
For details about how to setup Azure Log Analytics, see the [Azure Log Analytics](https://docs.microsoft.com/en-us/azure/log-analytics/) documentation.
1010

11-
## Configuration Parameters
11+
## Configuration parameters
1212

13-
| Key | Description | default |
13+
| Key | Description | Default |
1414
| :--- | :--- | :--- |
15-
| Customer\_ID | Customer ID or WorkspaceID string. | |
16-
| Shared\_Key | The primary or the secondary Connected Sources client authentication key. | |
17-
| Log\_Type | The name of the event type. | fluentbit |
18-
| Log_Type_Key | If included, the value for this key will be looked upon in the record and if present, will over-write the `log_type`. If not found then the `log_type` value will be used. | |
19-
| Time\_Key | Optional parameter to specify the key name where the timestamp will be stored. | @timestamp |
20-
| Time\_Generated | If enabled, the HTTP request header 'time-generated-field' will be included so Azure can override the timestamp with the key specified by 'time_key' option. | off |
21-
| Workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
15+
| `Customer_ID` | Customer ID or WorkspaceID string. | _none_ |
16+
| `Shared_Key` | The primary or the secondary Connected Sources client authentication key. | _none_ |
17+
| `Log_Type` | The name of the event type. | `fluentbit` |
18+
| `Log_Type_Key` | If included, the value for this key checked in the record and if present, will overwrite the `log_type`. If not found then the `log_type` value will be used. | _none_ |
19+
| `Time_Key` | Optional. Specify the key name where the timestamp will be stored. | `@timestamp` |
20+
| `Time_Generated` | If enabled, the HTTP request header `time-generated-field` will be included so Azure can override the timestamp with the key specified by `time_key` option. | `off` |
21+
| `Workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
2222

23-
## Getting Started
23+
## Get started
2424

25-
In order to insert records into an Azure Log Analytics instance, you can run the plugin from the command line or through the configuration file:
25+
To insert records into an Azure Log Analytics instance, run the plugin from the command line or through the configuration file.
2626

27-
### Command Line
27+
### Command line
2828

29-
The **azure** plugin, can read the parameters from the command line in two ways, through the **-p** argument \(property\), e.g:
29+
The _Azure_ plugin can read the parameters from the command line in the following ways, using the `-p` argument (property):
3030

3131
```shell
3232
fluent-bit -i cpu -o azure -p customer_id=abc -p shared_key=def -m '*' -f 1
3333
```
3434

35-
### Configuration File
35+
### Configuration file
3636

37-
In your main configuration file append the following _Input_ & _Output_ sections:
37+
In your main configuration file append the following sections:
3838

3939
{% tabs %}
4040
{% tab title="fluent-bit.yaml" %}
@@ -43,12 +43,12 @@ In your main configuration file append the following _Input_ & _Output_ sections
4343
pipeline:
4444
inputs:
4545
- name: cpu
46-
46+
4747
outputs:
4848
- name: azure
4949
match: '*'
5050
customer_id: abc
51-
shared_key: def
51+
shared_key: def
5252
```
5353
5454
{% endtab %}
@@ -68,7 +68,7 @@ pipeline:
6868
{% endtab %}
6969
{% endtabs %}
7070

71-
Another example using the `Log_Type_Key` with [record-accessor](https://docs.fluentbit.io/manual/administration/configuring-fluent-bit/classic-mode/record-accessor), which will read the table name (or event type) dynamically from kubernetes label `app`, instead of `Log_Type`:
71+
The following example uses the `Log_Type_Key` with [record-accessor](https://docs.fluentbit.io/manual/administration/configuring-fluent-bit/classic-mode/record-accessor), which will read the table name (or event type) dynamically from the Kubernetes label `app`, instead of `Log_Type`:
7272

7373
{% tabs %}
7474
{% tab title="fluent-bit.yaml" %}
@@ -77,13 +77,13 @@ Another example using the `Log_Type_Key` with [record-accessor](https://docs.flu
7777
pipeline:
7878
inputs:
7979
- name: cpu
80-
80+
8181
outputs:
8282
- name: azure
8383
match: '*'
8484
log_type_key: $kubernetes['labels']['app']
8585
customer_id: abc
86-
shared_key: def
86+
shared_key: def
8787
```
8888
8989
{% endtab %}
@@ -102,4 +102,4 @@ pipeline:
102102
```
103103

104104
{% endtab %}
105-
{% endtabs %}
105+
{% endtabs %}

vale-styles/FluentBit/Headings.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ exceptions:
1414
- API
1515
- APIs
1616
- Azure
17+
- Azure Log Analytics
1718
- BuildKite
1819
- CircleCI
1920
- CLI

0 commit comments

Comments
 (0)