blob: fa165c91027987cf1cdd3c410254beb0de083b19 [file] [view]
@PLUGIN@ Configuration
=========================
Overview of all available configuration options:
```
[pubsub]
projectId = my-gcp-project
privateKeyLocation = /path/to/private/key/my-gcp-project-6f0d80a3f655.json
[pubsub "topics"]
main = default
streamEvents = stream-events
[pubsub "limits"]
subscriptionTimeout = 10s
shutdownTimeout = 10s
publisherThreadPoolSize = 4
subscriberThreadPoolSize = 4
[pubsub "retention"]
ackDeadline = 10s
messageRetentionDuration = 7d
retainAckedMessages = false
[pubsub "retry"]
maxDeliveryAttempts = 5
minimumBackoff = 10s
maximumBackoff = 10m
```
```pubsub.projectId```
: The name of the GCP project containing the PubSub topic to be used.
```pubsub.privateKeyLocation```
: The location of the file containing the service account key of the service
account that Gerrit can use to create subscriptions for the topics configured in
pubsub.topics and to subscribe to it.
```pubsub.topics.main```
: The name of the main PubSub topic used for publishing events.
Default: `default`
```pubsub.topics.streamEvents```
: The name of the PubSub topic used for publishing stream events.
Default: `stream-events`
```pubsub.limits.subscriptionTimeout```
: The timeout duration for subscription operations.
Default: `10s`
```pubsub.limits.shutdownTimeout```
: The timeout duration for graceful shutdown of the plugin.
Default: `10s`
```pubsub.limits.publisherThreadPoolSize```
: The number of threads used by the publisher thread pool for publishing messages.
Default: `4`
```pubsub.limits.subscriberThreadPoolSize```
: The number of threads used by the subscriber thread pool for consuming messages.
Default: `4`
```pubsub.retention.ackDeadline```
: The amount of time the Pub/Sub service will wait for an acknowledgement before
redelivering the message.
Default: `10s`
```pubsub.retention.messageRetentionDuration```
: The length of time that messages in the topic should be retained.
Default: `7d`
```pubsub.retention.retainAckedMessages```
: Whether to retain messages that have already been acknowledged.
Default: `false`
```pubsub.retry.maxDeliveryAttempts```
: The maximum number of delivery attempts for a message before it is sent to
the dead letter topic.
Default: `5`
```pubsub.retry.minimumBackoff```
: The minimum backoff duration for retrying failed message deliveries.
Default: `10s`
```pubsub.retry.maximumBackoff```
: The maximum backoff duration for retrying failed message deliveries.
Default: `10m`