Docs » Integrations Guide » Integrations Reference » Google Cloud Pub/Sub

../../_images/integration_googlecloudpubsub.png Google Cloud Pub/Sub πŸ”—

DESCRIPTION πŸ”—

Use SignalFx to monitor Google Cloud Pub/Sub via Google Cloud Platform.

FEATURES πŸ”—

Built-in dashboards πŸ”—

  • Pub/Sub Overview: Overview of project level metrics for Google Cloud Pub/Sub

    ../../_images/pubsub_overview.png

  • Pub/Sub Subscription: Metrics for a single subscription from Google Cloud Pub/Sub

    ../../_images/pubsub_subscription.png

  • Pub/Sub Topic: Metrics for a single topic from Google Cloud Pub/Sub

    ../../_images/pubsub_topic.png

  • Pub/Sub Streaming: Metrics for Pub/Sub if the service is being used for data streaming.

INSTALLATION πŸ”—

To access this integration, connect to Google Cloud Platform.

USAGE πŸ”—

Interpreting Built-in dashboards πŸ”—

Pub/Sub Overview

  • Unacknowledged Messages Count - Number of unacknowledged messages aggregated by subscription.

    ../../_images/overview-unack-messages-count.png

  • Oldest Unacknowledged Message(s) - Age, in seconds, of the oldest unacknowledged message for each subscription.

    ../../_images/overview-oldest-unack-message.png

  • Outstanding Messages Count - Number of messages delivered to a subscription’s push endpoint, but not yet acknowledged.

  • Backlog Size - Total size in bytes of unacknowledged messages aggregated by subscription.

    ../../_images/overview-backlog-size.png

  • Subscription Pull Ack. Requests - Cumulative counts of acknowledge requests aggregated by subscription.

    ../../_images/overview-subscription-pull-ack-req.png

  • Subscription Pull Ack. Message Ops - Cumulative counts of acknowledge message ops aggregated by subscription.

    ../../_images/overview-subscription-pull-ack-ops.png

  • Subscription Pull Message Ops - Cumulative counts of pull message ops aggregated by subscription.

    ../../_images/overview-subscription-pull-message-ops.png

  • Subscription Pull Requests - Cumulative counts of pull requests aggregated by subscription.

    ../../_images/overview-subscription-pull-request.png

Pub/Sub Subscription

  • Backlog Size - Total byte size of the unacknowledged messages in a subscription.

    ../../_images/subscription-backlog-size.png

  • Cost per Operation - Cumulative cost of operations per subscription, measured in bytes. This is used to measure utilization for quotas.

    ../../_images/subscription-cost-per-operation.png

  • Undelivered Messages - Number of unacknowledged messages (a.k.a. backlog messages) in a subscription.

    ../../_images/subscription-undelivered-messages.png

  • Outstanding Messages - Number of messages delivered to a subscription’s push endpoint, but not yet acknowledged.

  • Oldest Unacknowledged Message(s) - Age (in seconds) of the oldest unacknowledged message (a.k.a. backlog message) in a subscription.

    ../../_images/subscription-unack-messages.png

Pub/Sub Topic

  • Send Requests - Number of publish requests.

    ../../_images/topic-send-requests.png

  • Send Message Ops - Number of publish message operations.

    ../../_images/topic-send-message-ops.png

  • Bytes per Operation - Cost of operations per topic, measured in bytes. This is used to measure utilization for quotas.

    ../../_images/topic-bytes-per-opertation.png

  • Average Message Size - Average of publish message sizes (in bytes).

    ../../_images/topic-average-message-size.png

METRICS πŸ”—

Metric Name Description Type
snapshot/backlog_bytes Snapshot backlog bytes gauge
snapshot/backlog_bytes_by_region Snapshot backlog bytes by region gauge
snapshot/config_updates_count Snapshot updates counter
snapshot/num_messages Snapshot messages gauge
snapshot/num_messages_by_region Snapshot messages by region gauge
snapshot/oldest_message_age Oldest snapshot message age gauge
snapshot/oldest_message_age_by_region Oldest snapshot message age by region gauge
subscription/ack_message_count Ack message count counter
subscription/backlog_bytes Backlog size gauge
subscription/byte_cost Subscription byte cost counter
subscription/config_updates_count Subscription updates counter
subscription/mod_ack_deadline_message_count Mod ack deadline message count counter
subscription/mod_ack_deadline_message_operation_count ModifyAckDeadline message operations counter
subscription/mod_ack_deadline_request_count ModifyAckDeadline requests counter
subscription/num_outstanding_messages Outstanding push messages gauge
subscription/num_retained_acked_messages Retained acked messages gauge
subscription/num_retained_acked_messages_by_region Retained acked messages by region gauge
subscription/num_unacked_messages_by_region Unacked messages by region gauge
subscription/num_undelivered_messages Unacked messages gauge
subscription/oldest_retained_acked_message_age Oldest retained acked message age gauge
subscription/oldest_retained_acked_message_age_by_region Oldest retained acked message age by region gauge
subscription/oldest_unacked_message_age Oldest unacked message age gauge
subscription/oldest_unacked_message_age_by_region Oldest unacked message age by region gauge
subscription/pull_ack_message_operation_count Acknowledge message operations counter
subscription/pull_ack_request_count Acknowledge requests counter
subscription/pull_message_operation_count Pull operations counter
subscription/pull_request_count Pull requests counter
subscription/push_request_count Push requests counter
subscription/push_request_latencies Push latency counter
subscription/retained_acked_bytes Retained acked bytes gauge
subscription/retained_acked_bytes_by_region Retained acked bytes by region gauge
subscription/seek_request_count Seek requests counter
subscription/sent_message_count Sent message count counter
subscription/streaming_pull_ack_message_operation_count StreamingPull Acknowledge message operations counter
subscription/streaming_pull_ack_request_count StreamingPull Acknowledge requests counter
subscription/streaming_pull_message_operation_count StreamingPull message operations counter
subscription/streaming_pull_mod_ack_deadline_message_operation_count StreamingPull ModifyAckDeadline message operations counter
subscription/streaming_pull_mod_ack_deadline_request_count StreamingPull ModifyAckDeadline requests counter
subscription/streaming_pull_response_count StreamingPull responses counter
subscription/unacked_bytes_by_region Unacked bytes by region gauge
topic/byte_cost Topic byte cost counter
topic/config_updates_count Topic updates counter
topic/message_sizes Publish message size counter
topic/num_retained_acked_messages_by_region Retained acked messages by region gauge
topic/num_unacked_messages_by_region Unacked messages by region gauge
topic/oldest_retained_acked_message_age_by_region Oldest retained acked message age by region gauge
topic/oldest_unacked_message_age_by_region Oldest unacked message age by region gauge
topic/retained_acked_bytes_by_region Retained acked bytes by region gauge
topic/send_message_operation_count Publish message operations counter
topic/send_request_count Publish requests counter
topic/unacked_bytes_by_region Unacked bytes by region gauge

snapshot/backlog_bytes πŸ”—

gauge

Total byte size of the messages retained in a snapshot.

snapshot/backlog_bytes_by_region πŸ”—

gauge

Total byte size of the messages retained in a snapshot, broken down by Cloud region.

snapshot/config_updates_count πŸ”—

counter

Cumulative count of configuration changes, grouped by operation type and result.

snapshot/num_messages πŸ”—

gauge

Number of messages retained in a snapshot.

snapshot/num_messages_by_region πŸ”—

gauge

Number of messages retained in a snapshot, broken down by Cloud region.

snapshot/oldest_message_age πŸ”—

gauge

Age (in seconds) of the oldest message retained in a snapshot.

snapshot/oldest_message_age_by_region πŸ”—

gauge

Age (in seconds) of the oldest message retained in a snapshot, broken down by Cloud region.

subscription/ack_message_count πŸ”—

counter

Cumulative count of messages acknowledged by Acknowledge requests, grouped by delivery type.

subscription/backlog_bytes πŸ”—

gauge

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

subscription/byte_cost πŸ”—

counter

Cumulative cost of operations, measured in bytes. This is used to measure quota utilization.

subscription/config_updates_count πŸ”—

counter

Cumulative count of configuration changes for each subscription, grouped by operation type and result.

subscription/mod_ack_deadline_message_count πŸ”—

counter

Cumulative count of messages whose deadline was updated by ModifyAckDeadline requests, grouped by delivery type.

subscription/mod_ack_deadline_message_operation_count πŸ”—

counter

Cumulative count of ModifyAckDeadline message operations, grouped by result.

subscription/mod_ack_deadline_request_count πŸ”—

counter

Cumulative count of ModifyAckDeadline requests, grouped by result.

subscription/num_outstanding_messages πŸ”—

gauge

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

subscription/num_retained_acked_messages πŸ”—

gauge

Number of acknowledged messages retained in a subscription.

subscription/num_retained_acked_messages_by_region πŸ”—

gauge

Number of acknowledged messages retained in a subscription, broken down by Cloud region.

subscription/num_unacked_messages_by_region πŸ”—

gauge

Number of unacknowledged messages in a subscription, broken down by Cloud region.

subscription/num_undelivered_messages πŸ”—

gauge

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

subscription/oldest_retained_acked_message_age πŸ”—

gauge

Age (in seconds) of the oldest acknowledged message retained in a subscription.

subscription/oldest_retained_acked_message_age_by_region πŸ”—

gauge

Age (in seconds) of the oldest acknowledged message retained in a subscription, broken down by Cloud region.

subscription/oldest_unacked_message_age πŸ”—

gauge

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

subscription/oldest_unacked_message_age_by_region πŸ”—

gauge

Age (in seconds) of the oldest unacknowledged message in a subscription, broken down by Cloud region.

subscription/pull_ack_message_operation_count πŸ”—

counter

Cumulative count of acknowledge message operations, grouped by result. For a definition of message operations, see Cloud Pub/Sub metric subscription/mod_ack_deadline_message_operation_count.

subscription/pull_ack_request_count πŸ”—

counter

Cumulative count of acknowledge requests, grouped by result.

subscription/pull_message_operation_count πŸ”—

counter

Cumulative count of pull message operations, grouped by result. For a definition of message operations, see Cloud Pub/Sub metric subscription/mod_ack_deadline_message_operation_count.

subscription/pull_request_count πŸ”—

counter

Cumulative count of pull requests, grouped by result.

subscription/push_request_count πŸ”—

counter

Cumulative count of push attempts, grouped by result. 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.

subscription/push_request_latencies πŸ”—

counter

Distribution of push request latencies (in microseconds), grouped by result.

subscription/retained_acked_bytes πŸ”—

gauge

Total byte size of the acknowledged messages retained in a subscription.

subscription/retained_acked_bytes_by_region πŸ”—

gauge

Total byte size of the acknowledged messages retained in a subscription, broken down by Cloud region.

subscription/seek_request_count πŸ”—

counter

Cumulative count of seek attempts, grouped by result.

subscription/sent_message_count πŸ”—

counter

Cumulative count of messages sent by Cloud Pub/Sub to subscriber clients, grouped by delivery type.

subscription/streaming_pull_ack_message_operation_count πŸ”—

counter

Cumulative count of StreamingPull acknowledge message operations, grouped by result. For a definition of message operations, see Cloud Pub/Sub metric subscription/mod_ack_deadline_message_operation_count.

subscription/streaming_pull_ack_request_count πŸ”—

counter

Cumulative count of streaming pull requests with non-empty acknowledge ids, grouped by result.

subscription/streaming_pull_message_operation_count πŸ”—

counter

Cumulative count of streaming pull message operations, grouped by result. For a definition of message operations, see Cloud Pub/Sub metric subscription/mod_ack_deadline_message_operation_count.

subscription/streaming_pull_mod_ack_deadline_message_operation_count πŸ”—

counter

Cumulative count of StreamingPull ModifyAckDeadline operations, grouped by result. For a definition of message operations, see Cloud Pub/Sub metric subscription/mod_ack_deadline_message_operation_count.

subscription/streaming_pull_mod_ack_deadline_request_count πŸ”—

counter

Cumulative count of streaming pull requests with non-empty ModifyAckDeadline fields, grouped by result.

subscription/streaming_pull_response_count πŸ”—

counter

Cumulative count of streaming pull responses, grouped by result.

subscription/unacked_bytes_by_region πŸ”—

gauge

Total byte size of the unacknowledged messages in a subscription, broken down by Cloud region.

topic/byte_cost πŸ”—

counter

Cost of operations, measured in bytes. This is used to measure utilization for quotas.

topic/config_updates_count πŸ”—

counter

Cumulative count of configuration changes, grouped by operation type and result.

topic/message_sizes πŸ”—

counter

Distribution of publish message sizes (in bytes).

topic/num_retained_acked_messages_by_region πŸ”—

gauge

Number of acknowledged messages retained in a topic, broken down by Cloud region.

topic/num_unacked_messages_by_region πŸ”—

gauge

Number of unacknowledged messages in a topic, broken down by Cloud region.

topic/oldest_retained_acked_message_age_by_region πŸ”—

gauge

Age (in seconds) of the oldest acknowledged message retained in a topic, broken down by Cloud region.

topic/oldest_unacked_message_age_by_region πŸ”—

gauge

Age (in seconds) of the oldest unacknowledged message in a topic, broken down by Cloud region.

topic/retained_acked_bytes_by_region πŸ”—

gauge

Total byte size of the acknowledged messages retained in a topic, broken down by Cloud region.

topic/send_message_operation_count πŸ”—

counter

Cumulative count of publish message operations, grouped by result. For a definition of message operations, see Cloud Pub/Sub metric subscription/mod_ack_deadline_message_operation_count.

topic/send_request_count πŸ”—

counter

Cumulative count of publish requests, grouped by result.

topic/unacked_bytes_by_region πŸ”—

gauge

Total byte size of the unacknowledged messages in a topic, broken down by Cloud region.

For more information about the metrics emitted by Google Cloud Pub/Sub, visit the service’s metric page at https://cloud.google.com/monitoring/api/metrics#gcp-pubsub