IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Elastic Azure Blob Storage connector reference Elastic Microsoft SQL connector reference »
Elastic Docs › ›Elastic connectors

Google Cloud Storage Connector

edit

Google Cloud Storage Connector

edit

The Elastic Google Cloud Storage connector is a connector for Google Cloud Storage data sources.

Availability and prerequisites

edit

This 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

edit

The Google Cloud Storage service account must have (at least) the following scopes and roles:

  • resourcemanager.projects.get
  • serviceusage.services.use
  • storage.buckets.list
  • storage.objects.list
  • storage.objects.get

Google Cloud Storage service account credentials are stored in a JSON file.

Configuration

edit

When using the build a connector workflow, initially 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:

service_account_credentials
The service account credentials generated from Google Cloud Storage (JSON string). Refer to the Google Cloud documentation for more information.
retry_count
The number of retry attempts after a failed call to Google Cloud Storage. Default value is 3.
enable_content_extraction

Whether the connector should extract file content from Google Cloud Storage. 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

edit

The connector will fetch all buckets and paths the service account has access to.

The Owner field is not fetched as read_only scope doesn’t allow the connector to fetch IAM information.

Sync rules

edit
  • Files bigger than 10 MB won’t be extracted.
  • Permission 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 by ingest pipelines.

End-to-end testing

edit

The 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 Google Cloud Storage connector, run the following command:

$ make ftest NAME=google_cloud_storage

For faster tests, add the DATA_SIZE=small flag:

make ftest NAME=google_cloud_storage DATA_SIZE=small

Known issues

edit

There are currently no known issues for this connector.

Troubleshooting

edit

See Troubleshooting.

Security

edit

See Security.

Framework and source

edit

This connector is included in the Python connectors framework.

View the source code for this connector (branch 8.7, compatible with Elastic 8.7).

« Elastic Azure Blob Storage connector reference Elastic Microsoft SQL connector reference »