Update changelog and supporting files for cloud_pubsub
This commit is contained in:
parent
f42d9378ba
commit
0afa99c17b
|
@ -1,5 +1,9 @@
|
||||||
## v1.10 [unreleased]
|
## v1.10 [unreleased]
|
||||||
|
|
||||||
|
#### New Inputs
|
||||||
|
|
||||||
|
- [cloud_pubsub](/plugins/inputs/cloud_pubsub/README.md) - Contributed by @emilymye
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
|
|
||||||
- [#4345](https://github.com/influxdata/telegraf/pull/4345): Allow for force gathering ES cluster stats.
|
- [#4345](https://github.com/influxdata/telegraf/pull/4345): Allow for force gathering ES cluster stats.
|
||||||
|
|
|
@ -145,6 +145,7 @@ For documentation on the latest development code see the [documentation index][d
|
||||||
* [ceph](./plugins/inputs/ceph)
|
* [ceph](./plugins/inputs/ceph)
|
||||||
* [cgroup](./plugins/inputs/cgroup)
|
* [cgroup](./plugins/inputs/cgroup)
|
||||||
* [chrony](./plugins/inputs/chrony)
|
* [chrony](./plugins/inputs/chrony)
|
||||||
|
* [cloud_pubsub](./plugins/inputs/cloud_pubsub) Google Cloud Pub/Sub
|
||||||
* [conntrack](./plugins/inputs/conntrack)
|
* [conntrack](./plugins/inputs/conntrack)
|
||||||
* [consul](./plugins/inputs/consul)
|
* [consul](./plugins/inputs/consul)
|
||||||
* [couchbase](./plugins/inputs/couchbase)
|
* [couchbase](./plugins/inputs/couchbase)
|
||||||
|
|
|
@ -115,6 +115,7 @@ following works:
|
||||||
- golang.org/x/crypto [BSD 3-Clause Clear License](https://github.com/golang/crypto/blob/master/LICENSE)
|
- golang.org/x/crypto [BSD 3-Clause Clear License](https://github.com/golang/crypto/blob/master/LICENSE)
|
||||||
- golang.org/x/net [BSD 3-Clause Clear License](https://github.com/golang/net/blob/master/LICENSE)
|
- golang.org/x/net [BSD 3-Clause Clear License](https://github.com/golang/net/blob/master/LICENSE)
|
||||||
- golang.org/x/oauth2 [BSD 3-Clause "New" or "Revised" License](https://github.com/golang/oauth2/blob/master/LICENSE)
|
- golang.org/x/oauth2 [BSD 3-Clause "New" or "Revised" License](https://github.com/golang/oauth2/blob/master/LICENSE)
|
||||||
|
- golang.org/x/sync [BSD 3-Clause "New" or "Revised" License](https://github.com/golang/sync/blob/master/LICENSE)
|
||||||
- golang.org/x/sys [BSD 3-Clause Clear License](https://github.com/golang/sys/blob/master/LICENSE)
|
- golang.org/x/sys [BSD 3-Clause Clear License](https://github.com/golang/sys/blob/master/LICENSE)
|
||||||
- golang.org/x/text [BSD 3-Clause Clear License](https://github.com/golang/text/blob/master/LICENSE)
|
- golang.org/x/text [BSD 3-Clause Clear License](https://github.com/golang/text/blob/master/LICENSE)
|
||||||
- google.golang.org/api [BSD 3-Clause "New" or "Revised" License](https://github.com/googleapis/google-api-go-client/blob/master/LICENSE)
|
- google.golang.org/api [BSD 3-Clause "New" or "Revised" License](https://github.com/googleapis/google-api-go-client/blob/master/LICENSE)
|
||||||
|
|
|
@ -6,9 +6,6 @@ and creates metrics using one of the supported [input data formats][].
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
This section contains the default TOML to configure the plugin. You can
|
|
||||||
generate it using `telegraf --usage pubsub`.
|
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[[inputs.pubsub]]
|
[[inputs.pubsub]]
|
||||||
## Required. Name of Google Cloud Platform (GCP) Project that owns
|
## Required. Name of Google Cloud Platform (GCP) Project that owns
|
||||||
|
@ -24,22 +21,22 @@ generate it using `telegraf --usage pubsub`.
|
||||||
## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md
|
## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md
|
||||||
data_format = "influx"
|
data_format = "influx"
|
||||||
|
|
||||||
## Optional. Filepath for GCP credentials JSON file to authorize calls to
|
## Optional. Filepath for GCP credentials JSON file to authorize calls to
|
||||||
## PubSub APIs. If not set explicitly, Telegraf will attempt to use
|
## PubSub APIs. If not set explicitly, Telegraf will attempt to use
|
||||||
## Application Default Credentials, which is preferred.
|
## Application Default Credentials, which is preferred.
|
||||||
# credentials_file = "path/to/my/creds.json"
|
# credentials_file = "path/to/my/creds.json"
|
||||||
|
|
||||||
## Optional. Maximum byte length of a message to consume.
|
## Optional. Maximum byte length of a message to consume.
|
||||||
## Larger messages are dropped with an error. If less than 0 or unspecified,
|
## Larger messages are dropped with an error. If less than 0 or unspecified,
|
||||||
## treated as no limit.
|
## treated as no limit.
|
||||||
# max_message_len = 1000000
|
# max_message_len = 1000000
|
||||||
|
|
||||||
## Optional. Maximum messages to read from PubSub that have not been written
|
## Optional. Maximum messages to read from PubSub that have not been written
|
||||||
## to an output. Defaults to %d.
|
## to an output. Defaults to %d.
|
||||||
## For best throughput set based on the number of metrics within
|
## For best throughput set based on the number of metrics within
|
||||||
## each message and the size of the output's metric_batch_size.
|
## each message and the size of the output's metric_batch_size.
|
||||||
##
|
##
|
||||||
## For example, if each message contains 10 metrics and the output
|
## For example, if each message contains 10 metrics and the output
|
||||||
## metric_batch_size is 1000, setting this to 100 will ensure that a
|
## metric_batch_size is 1000, setting this to 100 will ensure that a
|
||||||
## full batch is collected and the write is triggered immediately without
|
## full batch is collected and the write is triggered immediately without
|
||||||
## waiting until the next flush_interval.
|
## waiting until the next flush_interval.
|
||||||
|
@ -48,28 +45,28 @@ generate it using `telegraf --usage pubsub`.
|
||||||
## The following are optional Subscription ReceiveSettings in PubSub.
|
## The following are optional Subscription ReceiveSettings in PubSub.
|
||||||
## Read more about these values:
|
## Read more about these values:
|
||||||
## https://godoc.org/cloud.google.com/go/pubsub#ReceiveSettings
|
## https://godoc.org/cloud.google.com/go/pubsub#ReceiveSettings
|
||||||
|
|
||||||
## Optional. Maximum number of seconds for which a PubSub subscription
|
## Optional. Maximum number of seconds for which a PubSub subscription
|
||||||
## should auto-extend the PubSub ACK deadline for each message. If less than
|
## should auto-extend the PubSub ACK deadline for each message. If less than
|
||||||
## 0, auto-extension is disabled.
|
## 0, auto-extension is disabled.
|
||||||
# max_extension = 0
|
# max_extension = 0
|
||||||
|
|
||||||
## Optional. Maximum number of unprocessed messages in PubSub
|
## Optional. Maximum number of unprocessed messages in PubSub
|
||||||
## (unacknowledged but not yet expired in PubSub).
|
## (unacknowledged but not yet expired in PubSub).
|
||||||
## A value of 0 is treated as the default PubSub value.
|
## A value of 0 is treated as the default PubSub value.
|
||||||
## Negative values will be treated as unlimited.
|
## Negative values will be treated as unlimited.
|
||||||
# max_outstanding_messages = 0
|
# max_outstanding_messages = 0
|
||||||
|
|
||||||
## Optional. Maximum size in bytes of unprocessed messages in PubSub
|
## Optional. Maximum size in bytes of unprocessed messages in PubSub
|
||||||
## (unacknowledged but not yet expired in PubSub).
|
## (unacknowledged but not yet expired in PubSub).
|
||||||
## A value of 0 is treated as the default PubSub value.
|
## A value of 0 is treated as the default PubSub value.
|
||||||
## Negative values will be treated as unlimited.
|
## Negative values will be treated as unlimited.
|
||||||
# max_outstanding_bytes = 0
|
# max_outstanding_bytes = 0
|
||||||
|
|
||||||
## Optional. Max number of goroutines a PubSub Subscription receiver can spawn
|
## Optional. Max number of goroutines a PubSub Subscription receiver can spawn
|
||||||
## to pull messages from PubSub concurrently. This limit applies to each
|
## to pull messages from PubSub concurrently. This limit applies to each
|
||||||
## subscription separately and is treated as the PubSub default if less than
|
## subscription separately and is treated as the PubSub default if less than
|
||||||
## 1. Note this setting does not limit the number of messages that can be
|
## 1. Note this setting does not limit the number of messages that can be
|
||||||
## processed concurrently (use "max_outstanding_messages" instead).
|
## processed concurrently (use "max_outstanding_messages" instead).
|
||||||
# max_receiver_go_routines = 0
|
# max_receiver_go_routines = 0
|
||||||
```
|
```
|
||||||
|
@ -79,7 +76,7 @@ generate it using `telegraf --usage pubsub`.
|
||||||
This plugin assumes you have already created a PULL subscription for a given
|
This plugin assumes you have already created a PULL subscription for a given
|
||||||
PubSub topic. To learn how to do so, see [how to create a subscription][pubsub create sub].
|
PubSub topic. To learn how to do so, see [how to create a subscription][pubsub create sub].
|
||||||
|
|
||||||
Each plugin agent can listen to one subscription at a time, so you will
|
Each plugin agent can listen to one subscription at a time, so you will
|
||||||
need to run multiple instances of the plugin to pull messages from multiple
|
need to run multiple instances of the plugin to pull messages from multiple
|
||||||
subscriptions/topics.
|
subscriptions/topics.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue