Elastic Azure Blob Storage connector reference
editElastic Azure Blob Storage connector reference
editThe Elastic Azure Blob Storage connector is a connector for Azure Blob Storage.
Availability and prerequisites
editThis connector is available as a connector client from the Python connectors framework. This connector client is compatible with Elastic versions 8.6.0+. To use this connector, satisfy all connector client requirements.
This connector is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Usage
editTo use this connector as a connector client, use the build a connector workflow. See Connector clients and frameworks.
For additional operations, see Usage.
Compatibility
editThis connector has not been tested with Azure Government. Therefore we cannot guarantee that it will work with Azure Government endpoints. For more information on Azure Government compared to Global Azure, refer to the official Microsoft documentation.
Configuration
editWhen using the build a connector workflow, intially these fields will use the default configuration set in the connector source code.
These are set in the get_default_configuration
function definition.
These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, you’ll be able to update these values in Kibana.
The following configuration fields are required to set up the connector:
-
account_name
- Name of Azure Blob Storage account.
-
account_key
- Account key for the Azure Blob Storage account.
-
blob_endpoint
- Endpoint for the Blob Service.
-
retry_count
-
Number of retry attempts after a failed call.
Default value is
3
. -
concurrent_downloads
-
Number of concurrent downloads for fetching content.
Default value is
100
. -
enable_content_extraction
-
Whether the connector should extract file content. Default value is
True
, the connector will try to extract file contents.If
enable_content_extraction=False
the connector will not attempt to download the content of files.Don’t confuse this with the "Deployment wide content extraction" setting in the Kibana UI. This deployment-wide setting toggles binary content extraction and is powered by ingest pipelines.
Documents and syncs
editThe connector will fetch all data available in the container.
Sync rules
edit- Files bigger than 10 MB won’t be extracted.
- Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.
- Filtering rules are not yet available. Currently filtering is controlled via ingest pipelines.
End-to-end testing
editThe connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.
To perform E2E testing for the Azure Blob Storage connector, run the following command:
$ make ftest NAME=azure_blob_storage
For faster tests, add the DATA_SIZE=small
flag:
make ftest NAME=azure_blob_storage DATA_SIZE=small
Known issues
editThis connector has the following known issues:
-
lease data
andtier
fields are not updated in Elasticsearch indicesThis is because the blob timestamp is not updated. Refer to Github issue.
Troubleshooting
editSee Troubleshooting.
Security
editSee Security.
Framework and source
editThis connector is included in the Python connectors framework.
View the source code for this connector (branch 8.7, compatible with Elastic 8.7)