gcp_pubsub
Type:
Consumes messages from a GCP Cloud Pub/Sub subscription.
-
Common
-
Advanced
# Common config fields, showing default values
input:
label: ""
gcp_pubsub:
project: "" # No default (required)
subscription: "" # No default (required)
endpoint: ""
sync: false
max_outstanding_messages: 1000
max_outstanding_bytes: 1e+09
# All config fields, showing default values
input:
label: ""
gcp_pubsub:
project: "" # No default (required)
subscription: "" # No default (required)
endpoint: ""
sync: false
max_outstanding_messages: 1000
max_outstanding_bytes: 1e+09
create_subscription:
enabled: false
topic: ""
For information on how to set up credentials see this guide.
Metadata
This input adds the following metadata fields to each message:
-
gcp_pubsub_publish_time_unix - The time at which the message was published to the topic.
-
gcp_pubsub_delivery_attempt - When dead lettering is enabled, this is set to the number of times PubSub has attempted to deliver a message.
-
All message attributes
You can access these metadata fields using function interpolation.
Fields
endpoint
An optional endpoint to override the default of pubsub.googleapis.com:443
. This can be used to connect to a region specific pubsub endpoint. For a list of valid values, see this document.
Type: string
Default: ""
# Examples
endpoint: us-central1-pubsub.googleapis.com:443
endpoint: us-west3-pubsub.googleapis.com:443
max_outstanding_messages
The maximum number of outstanding pending messages to be consumed at a given time.
Type: int
Default: 1000
max_outstanding_bytes
The maximum number of outstanding pending messages to be consumed measured in bytes.
Type: int
Default: 1000000000