Google Cloud Storage 🔗︎

Overview 🔗︎

Store logs in Google Cloud Storage. For details, see

Example 🔗︎

    project: logging-example
    bucket: banzai-log-test
    path: logs/${tag}/%Y/%m/%d/

Configuration 🔗︎

GCSOutput 🔗︎

project (string, required) 🔗︎

Project identifier for GCS

Default: -

keyfile (string, optional) 🔗︎

Path of GCS service account credentials JSON file

Default: -

credentials_json (*secret.Secret, optional) 🔗︎

GCS service account credentials in JSON format Secret

Default: -

client_retries (int, optional) 🔗︎

Number of times to retry requests on server error

Default: -

client_timeout (int, optional) 🔗︎

Default timeout to use in requests

Default: -

bucket (string, required) 🔗︎

Name of a GCS bucket

Default: -

object_key_format (string, optional) 🔗︎

Format of GCS object keys

Default: %{path}%{time_slice}_%{index}.%{file_extension}

path (string, optional) 🔗︎

Path prefix of the files on GCS

Default: -

store_as (string, optional) 🔗︎

Archive format on GCS: gzip json text

Default: gzip

transcoding (bool, optional) 🔗︎

Enable the decompressive form of transcoding

Default: -

auto_create_bucket (bool, optional) 🔗︎

Create GCS bucket if it does not exists

Default: true

hex_random_length (int, optional) 🔗︎

Max length of %{hex_random} placeholder(4-16)

Default: 4

overwrite (bool, optional) 🔗︎

Overwrite already existing path

Default: false

acl (string, optional) 🔗︎

Permission for the object in GCS: auth_read owner_full owner_read private project_private public_read

Default: -

storage_class (string, optional) 🔗︎

Storage class of the file: dra nearline coldline multi_regional regional standard

Default: -

encryption_key (string, optional) 🔗︎

Customer-supplied, AES-256 encryption key

Default: -

object_metadata ([]ObjectMetadata, optional) 🔗︎

User provided web-safe keys and arbitrary string values that will returned with requests for the file as “x-goog-meta-” response headers. Object Metadata

Default: -

format (*Format, optional) 🔗︎


Default: -

buffer (*Buffer, optional) 🔗︎


Default: -

slow_flush_log_threshold (string, optional) 🔗︎

The threshold for chunk flush performance check. Parameter type is float, not time, default: 20.0 (seconds) If chunk flush takes longer time than this threshold, fluentd logs warning message and increases metric fluentd_output_status_slow_flush_count.

Default: -

ObjectMetadata 🔗︎

key (string, required) 🔗︎


Default: -

value (string, required) 🔗︎


Default: -