gcloud logging buckets create - create a bucket
gcloud logging buckets create BUCKET_ID --location=LOCATION [--cmek-kms-key-name=CMEK_KMS_KEY_NAME] [--description=DESCRIPTION] [--index=[KEY=VALUE, ...,...]] [--restricted-fields=[RESTRICTED_FIELD,...]] [--retention-days=RETENTION_DAYS] [GCLOUD_WIDE_FLAG ...]
After creating a bucket, use a log sink to route logs into the bucket.
To create a bucket 'my-bucket' in location 'global', run:
$ gcloud logging buckets create my-bucket --location=global \ --description="my custom bucket"
To create a bucket with extended retention, run:
$ gcloud logging buckets create my-bucket --location=global \ --retention-days=365
To create a bucket in cloud region 'us-central1', run:
$ gcloud logging buckets create my-bucket --location=us-central1
To create a bucket with custom index of 'jsonPayload.foo', run:
$ gcloud logging buckets create my-bucket \ --index=fieldPath=jsonPayload.foo,type=INDEX_TYPE_STRING
To create a bucket with custom CMEK, run:
$ gcloud logging buckets create my-bucket --location=us-central1 \ --cmek-kms-key-name=CMEK_KMS_KEY_NAME
- BUCKET_ID
ID of the bucket to create.
- --location=LOCATION
Location in which to create the bucket. Once the bucket is created, the location cannot be changed.
- --cmek-kms-key-name=CMEK_KMS_KEY_NAME
A valid kms_key_name will enable CMEK for the bucket.
- --description=DESCRIPTION
A textual description for the bucket.
- --index=[KEY=VALUE, ...,...]
Specify an index to be added to the log bucket. This flag can be repeated. The fieldPath and type attributes are required. For example: --index=fieldPath=jsonPayload.foo,type=INDEX_TYPE_STRING. The following keys are accepted:
- fieldPath
The LogEntry field path to index. For example: jsonPayload.request.status. Paths are limited to 800 characters and can include only letters, digits, underscores, hyphens, and periods.
- type
The type of data in this index. For example: INDEX_TYPE_STRING Supported types are INDEX_TYPE_STRING and INDEX_TYPE_INTEGER.
- --restricted-fields=[RESTRICTED_FIELD,...]
Comma-separated list of field paths that require permission checks in this bucket. The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation.
- --retention-days=RETENTION_DAYS
The period logs will be retained, after which logs will automatically be deleted. The default is 30 days.
These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
These variants are also available:
$ gcloud alpha logging buckets create
$ gcloud beta logging buckets create