cameronlee314 commented on a change in pull request #1323: Add docs for configs of Azure Blob SystemProducer URL: https://github.com/apache/samza/pull/1323#discussion_r396830826
########## File path: docs/learn/documentation/versioned/jobs/samza-configurations.md ########## @@ -245,6 +246,34 @@ Configs for producing to [ElasticSearch](https://www.elastic.co/products/elastic |systems.**_system-name_**.<br>bulk.flush.max.size.mb|5|The maximum aggregate size of messages in the buffered before flushing.| |systems.**_system-name_**.<br>bulk.flush.interval.ms|never|How often buffered messages should be flushed.| +#### <a name="azure-blob-storage"></a>[3.7 Azure Blob Storage](#azure-blob-storage) +Configs for producing to [Azure Blob Storage](https://azure.microsoft.com/en-us/services/storage/blobs/). This section applies if you have set systems.**__system-name__**.samza.factory = `org.apache.samza.system.azureblob.AzureBlobSystemFactory`.<br> +**_system-name_** is the Azure container name you want to produce blobs to. If such a container does not exist then it is created.<br> + +|Name|Default|Description| +|--- |--- |--- | +|sensitive.systems.**_system-name_**.azureblob.account.name| |__Required:__ The Azure account name to which the Azure container belongs to. | +|sensitive.systems.**_system-name_**.azureblob.account.key| |__Required:__ Key for the Azure account specified above.| + +#### <a name="advanced-azure-blob-storage"></a>[Advanced Azure Blob Storage Configurations](#advanced-azure-blob-storage) +|Name|Default|Description| +|--- |--- |--- | +|systems.**_system-name_**.azureblob.proxy.use |"false"|if true, proxy will be used to connect to Azure.| +|systems.**_system-name_**.azureblob.proxy.hostname| |if proxy.use is true then host name of proxy.| +|systems.**_system-name_**.azureblob.proxy.port| |if proxy.use is true then port of proxy.| +|samza.azureblob.log.slowRequestMs|30 secs|The duration after which an Azure request will be logged as a warning.| +|systems.**_system-name_**.azureblob.writer.factory.class|`org.apache.samza.system.`<br>`azureblob.avro.`<br>`AzureBlobAvroWriterFactory`|Fully qualified class name of the `org.apache.samza.system.azureblob.producer.AzureBlobWriter` impl for the system producer.<br><br>The default writer creates blobs that are of type AVRO and require the messages sent to a blob to be AVRO records. The blobs created by the default writer are of type [Block Blobs](https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs#about-block-blobs).<br>All the following configs are relevant to this default writer.| +|systems.**_system-name_**.azureblob.compression.type|"none"|type of compression to be used before uploading blocks. Can be "none" or "gzip".| +|systems.**_system-name_**.azureblob.maxFlushThresholdSize|10485760 (10 MB)|max size of the uncompressed block to be uploaded in bytes. Maximum size allowed by Azure is 100MB.| +|systems.**_system-name_**.azureblob.maxBlobSize|Long.MAX_VALUE (unlimited)|max size of the uncompressed blob in bytes.<br>If default value then size is unlimited capped only by Azure BlockBlob size of 4.75 TB (100 MB per block X 50,000 blocks).| Review comment: Minor: extra space before `4.75TB` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
