GCP Pub/Sub

Google Cloud Platform (GCP) Pub/Sub is messaging service that decouples services producing messages from services processing those messages. Cisco Cloud Observability supports the following Pub/Sub entities:

System: A Splunk AppDynamics entity that represents the entire GCP Pub/Sub messaging system in Cisco Cloud Observability. There is one messaging system per GCP project.
Topic: Named resources that represent a feed of messages.
Subscription: Used to read messages from a topic. Subscriptions are attached to topics, and a topic can have multiple subscriptions.
Snapshot: Used to capture the message acknowledgment state of a subscription.

You must configure cloud connections to monitor this entity. See Configure Google Cloud Platform Connection.

Cisco Cloud Observability displays GCP entities on the Observe page. Metrics are displayed for specific entity instances in the list and detail views.

This document contains references to third-party documentation. Splunk AppDynamics does not own any rights and assumes no responsibility for the accuracy or completeness of such third-party documentation.

Detail View

To display the detail view of a GCP Pub/Sub instance:

Navigate to the Observe page.
Under App Integrations, click GCP Pub/Sub Systems, Topics, Subscriptions, or Snapshots.
The list view now displays.
Click an instance Name to display the detail view.
The detail view displays metrics, key performance indicators, and properties (attributes) related to the instance you selected.

Metrics and Key Performance Indicators

Cisco Cloud Observability displays the following metrics and key performance indicators (KPIs) for GCP Pub/Sub. See Google Cloud metrics.

Some GCP metrics have been modified in Cisco Cloud Observability. Metric display names and descriptions may differ from the source metric.

Display Name	Source Metric	Description
Published Message Size (By)	`topic/message_sizes`	The average of publish message sizes in all topics.
Published Requests (Count)	`topic/send_request_count`	The cumulative count of publish requests across all topics.

Display Name	Source Metric	Description
Operation Byte Cost (By)	`topic/byte_cost`	The cost of operations in bytes for a topic.
Published Message Size (By)	`topic/message_sizes`	The distribution of publish message sizes.
Oldest Unacknowledged Message Age (s)	`topic/oldest_unacked_message_age_by_region`	The age (in seconds) of the oldest unacknowledged message in a topic.
Published Requests (Count)	`topic/send_request_count`	The cumulative count of publish requests.
Unacknowledged Size (By)	`topic/unacked_bytes_by_region`	The total byte size of the unacknowledged messages in a topic.

Display Name	Source Metric	Description
Acknowledgement Latency (ms)	`subscription/ack_latencies`	The distribution of acknowledged latencies.
Operation Byte Cost (By)	`subscription/byte_cost`	The cost of operations in bytes for a subscription.
Backlog Size (By)	`subscription/backlog_bytes`	The total byte size of the messages retained in a snapshot or unacknowledged in a subscription.
Acknowledged Messages (Count)	`subscription/ack_message_count`	The count of acknowledged messages in a subscription.
Acknowledgement Latency (ms)	`subscription/ack_latencies`	The distribution of acknowledgement latencies in a subscription.
Dead Letter Messages (Count)	`subscription/dead_letter_message_count`	The count of messages published to dead letter topic.
Mod Ack Deadline Messages (Count)	`subscription/mod_ack_deadline_message_count`	The count of messages whose deadline was updated by `ModifyAckDeadline` requests.
Mod Ack Deadline Requests (Count)	`subscription/mod_ack_deadline_request_count`	The count of `ModifyAckDeadline` requests.
Outstanding Push Messages (Count)	`subscription/num_outstanding_messages`	The number of messages delivered to a subscription's push endpoint that have not been acknowledged.
Unacknowledged Messages (Count)	`subscription/num_undelivered_messages`	The number of unacknowledged messages in a subscription.
Oldest Unacknowledged Message Age (s)	`subscription/oldest_unacked_message_age`	The age of the oldest unacknowledged message in a subscription.
Sent Messages (Count)	`subscription/sent_message_count`	The count of sent messages.
Unacknowledged Bytes (By)	`subscription/unacked_bytes_by_region`	The total byte size of the unacknowledged messages in a subscription.

Display Name	Source Metric	Description
Backlog Size (By)	`snapshot/backlog_bytes`	The total byte size of the messages retained in a snapshot or unacknowledged in a subscription.
Messages (Count)	`snapshot/num_messages`	The number of messages retained in a snapshot.
Oldest Message Age (s)	`snapshot/oldest_message_age`	The age of the oldest message retained in a snapshot.

Properties (Attributes)

Cisco Cloud Observability displays the following properties for GCP Pub/Sub.

Display Name	Property Name	Description
Provider	`cloud.provider`	The name of the cloud provider.
Account ID	`cloud.account.id`	The cloud account ID the resource is assigned to.
Region	`cloud.region`	The geographical region where the resource is running. This value is `global` for Pub/Sub resources.
Platform	`cloud.platform`	The cloud platform in use. This value is `gcp_messaging_system` for all Pub/Sub resources.
Messaging System ID	`messaging.system.id`	The unique identifier of this messaging system. This value follows the format `internal:systems/gcp-pubsub-<PROJECT_ID>`.
Messaging System Name	`messaging.system.name`	The name of the messaging system. This value follows the format `gcp-pubsub-<PROJECT_ID>`.
Messaging System Type	`messaging.system.type`	The type of the messaging system (Kafka, AMQ, etc.). This value is GCP Pub/Sub for all Pub/Sub resources.

Display Name	Property Name	Description
Provider	`cloud.provider`	The name of the cloud provider.
Account ID	`cloud.account.id`	The cloud account ID the resource is assigned to.
Region	`cloud.region`	The geographical region where the resource is running. This value is `global` for Pub/Sub resources.
Platform	`cloud.platform`	The cloud platform in use.
ID	`messaging.destination.id`	The ID of the topic.
Name	`messaging.destination.name`	The name of the topic.
Schema	`gcp.topic.schema`	The ID of the schema that messages published should be validated against.
Retention Duration	`gcp.topic.message_retention_duration`	Indicates the minimum duration to retain a message after it is published to the topic. Retention duration is represented in ISO 8601 format.
Messaging System ID	`messaging.system.id`	The unique identifier of the messaging system.

Display Name	Property Name	Description
Provider	`cloud.provider`	The name of the cloud provider.
Account ID	`cloud.account.id`	The cloud account ID the resource is assigned to.
Region	`cloud.region`	The geographical region where the resource is running. This value is `global` for Pub/Sub resources.
Platform	`cloud.platform`	The cloud platform in use.
ID	`gcp.subscription.id`	The ID of the subscription.
Name	`gcp.subscription.name`	The name of the subscription.
Topic	`gcp.subscription.topic_id`	The ID of the topic from which the subscription is retaining messages.
Push Endpoint	`gcp.subscription.push_endpoint`	The URL identifying the endpoint to which messages should be pushed. Empty if not configured to push.
BigQuery Config Table	`gcp.subscription.bigquery_config.table_id`	The ID of the BigQuery table to write data to. Empty if not configured to write to BigQuery.
BigQuery Config State	`gcp.subscription.bigquery_config.state`	Indicates if the subscription can write messages to BigQuery. Possible values: `STATE_UNSPECIFIED`: Default value. This value is unused. `ACTIVE`: The subscription can actively send messages to BigQuery. `PERMISSION_DENIED`: Cannot write to the BigQuery table because of permission denied errors. This can occur if the Pub/Sub Subscription has not been granted the appropriate BigQuery IAM permissions or if the BigQuery API is not enabled for the project. `NOT_FOUND`: Cannot write to the BigQuery table because it does not exist. `SCHEMA_MISMATCH`: Cannot write to the BigQuery table due to a schema mismatch.
Ack Deadline Seconds	`gcp.subscription.ack_deadline_seconds`	The acknowledgement deadline in seconds.
Retention Duration	`gcp.subscription.message_retention_duration`	The amount of time that unacknowledged messages in the subscription's backlog are retained. Retention duration is represented in ISO 8601 format.
Detached	`gcp.subscription.detached`	Indicates if the subscription is detached from its topic.
State	`gcp.subscription.state`	Indicates if the subscription can receive messages. Possible values: `STATE_UNSPECIFIED` `ACTIVE` `RESOURCE_ERROR`

Display Name	Property Name	Description
Provider	`cloud.provider`	The name of the cloud provider.
Account ID	`cloud.account.id`	The cloud account ID the resource is assigned to.
Region	`cloud.region`	The geographical region where the resource is running. This value is `global` for Pub/Sub resources.
Platform	`cloud.platform`	The cloud platform in use.
ID	`gcp.snapshot.id`	The ID of the snapshot.
Name	`gcp.snapshot.name`	The name of the snapshot.
Topic	`gcp.snapshot.topic_id`	The ID of the topic from which this snapshot is retaining messages.
Expire Time	`gcp.snapshot.expire_time`	The time the snapshot is guaranteed to exist up to, calculated from the oldest unacknowledged message in it.

Retention and Purge Time-To-Live (TTL)

For all cloud and infrastructure entities, the retention TTL is 180 minutes (3 hours) and the purge TTL is 525,600 minutes (365 days).

Third party names, logos, marks, and general references used in these materials are the property of their respective owners or their affiliates in the United States and/or other countries. Inclusion of such references are for informational purposes only and are not intended to promote or otherwise suggest a relationship between Splunk AppDynamics and the third party.