README.md in fluent-plugin-azure-storage-append-blob-lts-0.5.0 vs README.md in fluent-plugin-azure-storage-append-blob-lts-0.6.0

- old
+ new

@@ -22,10 +22,11 @@ ## Configuration <match pattern> type azure-storage-append-blob + azure_cloud <azure cloud environment> azure_storage_account <your azure storage account> azure_storage_access_key <your azure storage access key> # leave empty to use MSI azure_storage_connection_string <your azure storage connection string> # leave empty to use MSI azure_storage_sas_token <your azure storage sas token> # leave empty to use MSI azure_imds_api_version <Azure Instance Metadata Service API Version> # only used for MSI @@ -34,10 +35,11 @@ azure_msi_client_id <Azure Managed Identity Client ID> # only used for MSI auto_create_container true path logs/ azure_object_key_format %{path}%{time_slice}_%{index}.log time_slice_format %Y%m%d-%H + calculate_checksums true # if you want to use %{tag} or %Y/%m/%d/ like syntax in path / azure_blob_name_format, # need to specify tag for %{tag} and time for %Y/%m/%d in <buffer> argument. <buffer tag,time> @type file path /var/log/fluent/azurestorageappendblob @@ -45,10 +47,16 @@ timekey_wait 60 timekey_use_utc true # use utc </buffer> </match> +### `azure_cloud` (Optional) + +Default: `AZUREPUBLICCLOUD` + +Cloud environment used to determine the storage endpoint suffix to use, see [here](https://github.com/Azure/go-autorest/blob/master/autorest/azure/environments.go). + ### `azure_storage_account` (Required) Your Azure Storage Account Name. This can be retrieved from Azure Management portal. ### `azure_storage_access_key` or `azure_storage_sas_token` or `azure_storage_connection_string` (Any required or all empty to use MSI) @@ -58,19 +66,19 @@ If all are empty, the plugin will use the local Managed Identity endpoint to obtain a token for the target storage account. ### `azure_imds_api_version` (Optional, only for MSI) -Default: 2019-08-15 +Default: `2019-08-15` The Instance Metadata Service is used during the OAuth flow to obtain an access token. This API is versioned and specifying the version is mandatory. See [here](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/instance-metadata-service#versioning) for more details. ### `azure_token_refresh_interval` (Optional, only for MSI) -Default: 60 (1 hour) +Default: `60` (1 hour) When using MSI, the initial access token needs to be refreshed periodically. ### `azure_container` (Required) @@ -80,12 +88,13 @@ Azure Identity Client ID to use for accessing Azure Blob service. ### `auto_create_container` +Default: `true` + This plugin creates the Azure container if it does not already exist exist when you set 'auto_create_container' to true. -The default value is `true` ### `azure_object_key_format` The format of Azure Storage object keys. You can use several built-in variables: @@ -124,9 +133,17 @@ azure_object_key_format %{path}/events/ts=%{time_slice}/events-%{hostname}.log ### `time_slice_format` Format of the time used in the file name. Default is '%Y%m%d'. Use '%Y%m%d%H' to split files hourly. + +### `calculate_checksums` + +Default: `true` + +Whether to calculate MD5 checksum of the blob contents during append operation and provide it in a header for the blob service. + +You want to set it to `false` in FIPS-enabled environments. ### Run tests gem install bundler bundle install