Skip to content

Commit 9a219fa

Browse files
eschabelleschabell
committed
Adjusted azure blog code examples to use 2 space indents. Part of issue #1897.
Signed-off-by: Eric D. Schabell <[email protected]>
1 parent 53119fc commit 9a219fa

File tree

1 file changed

+97
-97
lines changed

1 file changed

+97
-97
lines changed

‎pipeline/outputs/azure_blob.md

Lines changed: 97 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -16,34 +16,34 @@ Ensure you have an Azure Storage account. [Azure Blob Storage Tutorial \(Video\)
1616

1717
Fluent Bit exposes the following configuration properties.
1818

19-
| Key | Description | Default |
20-
| :--- | :--- | :--- |
21-
| `account_name` | Azure Storage account name. | _none_ |
22-
| `auth_type` | Specify the type to authenticate against the service. Supported values: `key`, `sas`. | `key` |
23-
| `shared_key` | Specify the Azure Storage Shared Key to authenticate against the service. This configuration property is mandatory when `auth_type` is `key`. | _none_ |
24-
| `sas_token` | Specify the Azure Storage shared access signatures to authenticate against the service. This configuration property is mandatory when `auth_type` is `sas`. | _none_ |
25-
| `container_name` | Name of the container that will contain the blobs. | _none_ |
26-
| `blob_type` | Specify the desired blob type. Supported values: `appendblob`, `blockblob`. | `appendblob` |
27-
| `auto_create_container` | If `container_name` doesn't exist in the remote service, enabling this option handles the exception and auto-creates the container. | `on` |
28-
| `path` | Optional. The path to store your blobs. If your blob name is `myblob`, specify subdirectories for storage using `path`. For example, setting `path` to `/logs/kubernetes` will store your blob in `/logs/kubernetes/myblob`. | _none_ |
29-
| `compress` | Sets payload compression in network transfer. Supported value: `gzip` | _none_ |
30-
| `compress_blob` | Enables GZIP compression in the final `blockblob` file. This option isn't compatible when `blob_type` = `appendblob`. | _none_ |
31-
| `emulator_mode` | To send data to an Azure emulator service like [Azurite](https://github.com/Azure/Azurite), enable this option to format the requests in the expected format. | `off` |
32-
| `endpoint` | When using an emulator, this option lets you specify the absolute HTTP address of such service. For example, `http://127.0.0.1:10000`. | _none_ |
33-
| `tls` | Enable or disable TLS encryption. Azure service requires this to be set to `on`. | `off` |
34-
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
35-
| `buffering_enabled` | Enable buffering into disk before ingesting into Azure Blob. | `false` |
36-
| `buffer_dir` | Specifies the location of directory where the buffered data will be stored. | `/tmp/fluent-bit/azure-blob/` |
37-
| `upload_timeout` | Optional. Specify a timeout for uploads. Fluent Bit will start ingesting buffer files which have been created more than `x` minutes and ago haven't reached `upload_file_size` limit yet. | `30m` |
38-
| `upload_file_size` | Specifies the size of files to be uploaded in MB. | `200M` |
39-
| `azure_blob_buffer_key` | Set the Azure Blob buffer key which needs to be specified when using multiple instances of Azure Blob output plugin and buffering is enabled. | `key` |
40-
| `store_dir_limit_size` | Set the max size of the buffer directory. | `8G` |
41-
| `buffer_file_delete_early` | Whether to delete the buffered file early after successful blob creation. | `false` |
42-
| `blob_uri_length` | Set the length of generated blob URI before ingesting to Azure Kusto. | `64` |
43-
| `unify_tag` | Whether to create a single buffer file when buffering mode is enabled. | `false` |
44-
| `scheduler_max_retries` | Maximum number of retries for the scheduler send blob. | `3` |
45-
| `delete_on_max_upload_error` | Whether to delete the buffer file on maximum upload errors. | `false` |
46-
| `io_timeout` | HTTP IO timeout. | `60s` |
19+
| Key | Description | Default |
20+
| :--------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------- |
21+
| `account_name` | Azure Storage account name. | _none_ |
22+
| `auth_type` | Specify the type to authenticate against the service. Supported values: `key`, `sas`. | `key` |
23+
| `shared_key` | Specify the Azure Storage Shared Key to authenticate against the service. This configuration property is mandatory when `auth_type` is `key`. | _none_ |
24+
| `sas_token` | Specify the Azure Storage shared access signatures to authenticate against the service. This configuration property is mandatory when `auth_type` is `sas`. | _none_ |
25+
| `container_name` | Name of the container that will contain the blobs. | _none_ |
26+
| `blob_type` | Specify the desired blob type. Supported values: `appendblob`, `blockblob`. | `appendblob` |
27+
| `auto_create_container` | If `container_name` doesn't exist in the remote service, enabling this option handles the exception and auto-creates the container. | `on` |
28+
| `path` | Optional. The path to store your blobs. If your blob name is `myblob`, specify subdirectories for storage using `path`. For example, setting `path` to `/logs/kubernetes` will store your blob in `/logs/kubernetes/myblob`. | _none_ |
29+
| `compress` | Sets payload compression in network transfer. Supported value: `gzip` | _none_ |
30+
| `compress_blob` | Enables GZIP compression in the final `blockblob` file. This option isn't compatible when `blob_type` = `appendblob`. | _none_ |
31+
| `emulator_mode` | To send data to an Azure emulator service like [Azurite](https://github.com/Azure/Azurite), enable this option to format the requests in the expected format. | `off` |
32+
| `endpoint` | When using an emulator, this option lets you specify the absolute HTTP address of such service. For example, `http://127.0.0.1:10000`. | _none_ |
33+
| `tls` | Enable or disable TLS encryption. Azure service requires this to be set to `on`. | `off` |
34+
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
35+
| `buffering_enabled` | Enable buffering into disk before ingesting into Azure Blob. | `false` |
36+
| `buffer_dir` | Specifies the location of directory where the buffered data will be stored. | `/tmp/fluent-bit/azure-blob/` |
37+
| `upload_timeout` | Optional. Specify a timeout for uploads. Fluent Bit will start ingesting buffer files which have been created more than `x` minutes and ago haven't reached `upload_file_size` limit yet. | `30m` |
38+
| `upload_file_size` | Specifies the size of files to be uploaded in MB. | `200M` |
39+
| `azure_blob_buffer_key` | Set the Azure Blob buffer key which needs to be specified when using multiple instances of Azure Blob output plugin and buffering is enabled. | `key` |
40+
| `store_dir_limit_size` | Set the max size of the buffer directory. | `8G` |
41+
| `buffer_file_delete_early` | Whether to delete the buffered file early after successful blob creation. | `false` |
42+
| `blob_uri_length` | Set the length of generated blob URI before ingesting to Azure Kusto. | `64` |
43+
| `unify_tag` | Whether to create a single buffer file when buffering mode is enabled. | `false` |
44+
| `scheduler_max_retries` | Maximum number of retries for the scheduler send blob. | `3` |
45+
| `delete_on_max_upload_error` | Whether to delete the buffer file on maximum upload errors. | `false` |
46+
| `io_timeout` | HTTP IO timeout. | `60s` |
4747

4848
## Get started
4949

@@ -58,50 +58,50 @@ The following configuration example generates a random message with a custom tag
5858

5959
```yaml
6060
service:
61-
flush: 1
62-
log_level: info
63-
61+
flush: 1
62+
log_level: info
63+
6464
pipeline:
65-
inputs:
66-
- name: dummy
67-
dummy: '{"name": "Fluent Bit", "year": 2020}'
68-
samples: 1
69-
tag: var.log.containers.app-default-96cbdef2340.log
70-
71-
outputs:
72-
- name: azure_blog
73-
match: '*'
74-
account_name: YOUR_ACCOUNT_NAME
75-
shared_key: YOUR_SHARED_KEY
76-
path: kubernetes
77-
container_name: logs
78-
auto_create_container: on
79-
tls: on
65+
inputs:
66+
- name: dummy
67+
dummy: '{"name": "Fluent Bit", "year": 2020}'
68+
samples: 1
69+
tag: var.log.containers.app-default-96cbdef2340.log
70+
71+
outputs:
72+
- name: azure_blog
73+
match: "*"
74+
account_name: YOUR_ACCOUNT_NAME
75+
shared_key: YOUR_SHARED_KEY
76+
path: kubernetes
77+
container_name: logs
78+
auto_create_container: on
79+
tls: on
8080
```
8181
8282
{% endtab %}
8383
{% tab title="fluent-bit.conf" %}
8484
8585
```text
8686
[SERVICE]
87-
flush 1
88-
log_level info
87+
flush 1
88+
log_level info
8989

9090
[INPUT]
91-
name dummy
92-
dummy {"name": "Fluent Bit", "year": 2020}
93-
samples 1
94-
tag var.log.containers.app-default-96cbdef2340.log
91+
name dummy
92+
dummy {"name": "Fluent Bit", "year": 2020}
93+
samples 1
94+
tag var.log.containers.app-default-96cbdef2340.log
9595

9696
[OUTPUT]
97-
name azure_blob
98-
match *
99-
account_name YOUR_ACCOUNT_NAME
100-
shared_key YOUR_SHARED_KEY
101-
path kubernetes
102-
container_name logs
103-
auto_create_container on
104-
tls on
97+
name azure_blob
98+
match *
99+
account_name YOUR_ACCOUNT_NAME
100+
shared_key YOUR_SHARED_KEY
101+
path kubernetes
102+
container_name logs
103+
auto_create_container on
104+
tls on
105105
```
106106

107107
{% endtab %}
@@ -145,54 +145,54 @@ After you run the configuration file, you will be able to query the data using t
145145

146146
```yaml
147147
service:
148-
flush: 1
149-
log_level: info
150-
148+
flush: 1
149+
log_level: info
150+
151151
pipeline:
152-
inputs:
153-
- name: dummy
154-
dummy: '{"name": "Fluent Bit", "year": 2020}'
155-
samples: 1
156-
tag: var.log.containers.app-default-96cbdef2340.log
157-
158-
outputs:
159-
- name: azure_blog
160-
match: '*'
161-
account_name: devstoreaccount1
162-
shared_key: Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz
163-
path: kubernetes
164-
container_name: logs
165-
auto_create_container: on
166-
tls: off
167-
emulator_mode: on
168-
endpoint: http://127.0.0.1:10000
152+
inputs:
153+
- name: dummy
154+
dummy: '{"name": "Fluent Bit", "year": 2020}'
155+
samples: 1
156+
tag: var.log.containers.app-default-96cbdef2340.log
157+
158+
outputs:
159+
- name: azure_blog
160+
match: "*"
161+
account_name: devstoreaccount1
162+
shared_key: Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz
163+
path: kubernetes
164+
container_name: logs
165+
auto_create_container: on
166+
tls: off
167+
emulator_mode: on
168+
endpoint: http://127.0.0.1:10000
169169
```
170170
171171
{% endtab %}
172172
{% tab title="fluent-bit.conf" %}
173173
174174
```text
175175
[SERVICE]
176-
flush 1
177-
log_level info
176+
flush 1
177+
log_level info
178178

179179
[INPUT]
180-
name dummy
181-
dummy {"name": "Fluent Bit", "year": 2020}
182-
samples 1
183-
tag var.log.containers.app-default-96cbdef2340.log
180+
name dummy
181+
dummy {"name": "Fluent Bit", "year": 2020}
182+
samples 1
183+
tag var.log.containers.app-default-96cbdef2340.log
184184

185185
[OUTPUT]
186-
name azure_blob
187-
match *
188-
account_name devstoreaccount1
189-
shared_key Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz
190-
path kubernetes
191-
container_name logs
192-
auto_create_container on
193-
tls off
194-
emulator_mode on
195-
endpoint http://127.0.0.1:10000
186+
name azure_blob
187+
match *
188+
account_name devstoreaccount1
189+
shared_key Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz
190+
path kubernetes
191+
container_name logs
192+
auto_create_container on
193+
tls off
194+
emulator_mode on
195+
endpoint http://127.0.0.1:10000
196196
```
197197

198198
{% endtab %}
@@ -212,4 +212,4 @@ Azurite Queue service is successfully listening at http://127.0.0.1:10001
212212
127.0.0.1 - - [03/Sep/2020:17:40:03 +0000] "PUT /devstoreaccount1/logs/kubernetes/var.log.containers.app-default-96cbdef2340.log?comp=appendblock HTTP/1.1" 404 -
213213
127.0.0.1 - - [03/Sep/2020:17:40:03 +0000] "PUT /devstoreaccount1/logs/kubernetes/var.log.containers.app-default-96cbdef2340.log HTTP/1.1" 201 -
214214
127.0.0.1 - - [03/Sep/2020:17:40:04 +0000] "PUT /devstoreaccount1/logs/kubernetes/var.log.containers.app-default-96cbdef2340.log?comp=appendblock HTTP/1.1" 201 -
215-
```
215+
```

0 commit comments

Comments
 (0)