Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Google Cloud Pub/Sub

Connection Parameters

Name
Required?
Description

Private Key JSON

Required

The contents of the private key JSON file created when setting up a service account.

Metric Collection

Controls which metrics get requested from GCP's Stackdriver API.

Projects

Required

A comma separated whitelist of project IDs. If the wildcard "*" is used, resources will be collected from all available projects.

Connection Timeout

The number of seconds to allow for connecting to the target.

Metrics

Subscription

Name
Description

Ack Deadline (Seconds)

This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.

Acknowledge Message Operations (Operations per Second)

Rate of acknowledge message operations.

Acknowledge Requests (Requests per Second)

Rate of acknowledge requests.

Attributes

Endpoint configuration attributes.

Backlog Size (Bytes)

Total size of the unacknowledged messages (a.k.a. backlog messages) in a subscription.

Cost (Bytes per Second)

Rate of operations. This is used to measure quota utilization.

ID

The ID of the subscription.

Message Retention Duration (Seconds)

How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.

Modify Acknowledged Deadline Message Operations (Operations per Second)

Rate of ModifyAckDeadline message operations.

Modify Acknowledged Deadline Requests (Requests per Second)

Rate of ModifyAckDeadline requests.

Oldest Retained Acknowledged Message Age (Seconds)

Age of the oldest acknowledged message retained in a subscription.

Oldest Unacknowledged Message Age (Seconds)

Age of the oldest unacknowledged message (a.k.a. backlog message) in a subscription.

Outstanding Push Messages

Number of messages delivered to a subscription's push endpoint, but not yet acknowledged.

Project ID

The ID of the project to which the subscription belongs.

Pull Operations (Operations per Second)

Rate of pull message operations.

Pull Requests (Requests per Second)

Rate of pull requests.

Push Endpoint

A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".

Push Latency (Microseconds)

Distribution of push request latencies.

Push Requests (Requests per Second)

Rate of push attempts. Unlike pulls, the push server implementation does not batch user messages. So each request only contains one user message. The push server retries on errors, so a given user message can appear multiple times.

Retain Acknowledged Messages

Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the messageRetentionDuration window. ALPHA: This feature is part of an alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Retained Acknowledged Messages

Number of acknowledged messages retained in a subscription.

Retained Acknowledged Size (Bytes)

Total size of the acknowledged messages retained in a subscription.

StreamingPull Acknowledge Message Operations (Operations per Second)

Rate of StreamingPull acknowledge message operations.

StreamingPull Acknowledge Requests (Requests per Second)

Rate of streaming pull requests with non-empty acknowledge ids.

StreamingPull Message Operations (Operations per Second)

Rate of streaming pull message operations.

Streaming Pull Modify Acknowledged Deadline Message Operations (Operations per Second)

Rate of StreamingPull ModifyAckDeadline operations.

Streaming Pull Modify Acknowledged Deadline Requests (Requests per Second)

Rate of streaming pull requests with non-empty ModifyAckDeadline fields.

StreamingPull Responses (Operations per Second)

Rate of streaming pull responses.

Topic

The name of the topic from which this subscription is receiving messages. Format is projects/{project}/topics/{topic}. The value of this field will be deleted-topic if the topic has been deleted.

Unacknowledged Messages

Number of unacknowledged messages (a.k.a. backlog messages) in a subscription.

Updates (per Second)

Rate of configuration changes.

Topic

Name
Description

Cost (Bytes per Second)

Cost of operations. This is used to measure utilization for quotas.

ID

The ID of the topic.

Project ID

The ID of the project to which the topic belongs.

Publish Message Operations (Operations per Second)

The rate of publish message operations.

Publish Message Size (Bytes)

Average publish message sizes.

Publish Requests (Requests per Second)

The rate of publish requests.

Updates

The number of configuration changes.