GCP PubSub
Collect GCP PubSub metrics
Configuration¶
Install Func¶
Recommended to activate Guance Integration - Extensions - DataFlux Func (Automata): All prerequisites are automatically installed. Please proceed with script installation.
If deploying Func on your own, refer to Self-deploying Func
Install Script¶
-
Log in to the Func console, click [Script Market], enter the Guance Script Market, and search for
integration_gcp_pubsub. -
Click [Install], then enter the corresponding parameters: Account file name, Target Principal, Account name.
-
Click [Deploy Startup Script], the system will automatically create a
Startupscript set and configure the corresponding startup scripts. -
After activation, you can see the corresponding automatic trigger configuration under "Management / Automatic Trigger Configuration". Click [Execute] to run it immediately without waiting for the scheduled time. Wait a moment, then you can check the execution task records and corresponding logs.
Verification¶
- Under "Management / Automatic Trigger Configuration", confirm if the corresponding task has the automatic trigger configuration, and check the task records and logs for any exceptions.
- In Guance, check if asset information exists under "Infrastructure / Custom".
- In Guance, check if there is corresponding monitoring data under "Metrics".
Metrics¶
GCP PubSub metrics are under the gcp_pubsub Measurement. Below are descriptions of some metrics.
| Metric | Original Metric | Description | Unit |
|---|---|---|---|
| snapshot_backlog_bytes | snapshot/backlog_bytes |
Snapshot backlog bytes | Bytes |
| snapshot_backlog_bytes_by_region | snapshot/backlog_bytes_by_region |
Snapshot backlog bytes by region | Bytes |
| snapshot_config_updates_count | snapshot/config_updates_count |
Snapshot configuration operations | Count |
| snapshot_num_messages | snapshot/num_messages |
Snapshot messages | Count |
| snapshot_num_messages_by_region | snapshot/num_messages_by_region |
Snapshot messages by region | Count |
| snapshot_oldest_message_age | snapshot/oldest_message_age |
Age of the oldest snapshot message | s |
| snapshot_oldest_message_age_by_region | snapshot/oldest_message_age_by_region |
Age of the oldest snapshot message by region | s |
| subscription_ack_latencies | subscription/ack_latencies |
Acknowledgment latency | ms |
| subscription_ack_message_count | subscription/ack_message_count |
Acknowledged message count | Count |
| subscription_backlog_bytes | subscription/backlog_bytes |
Backlog size | Bytes |
| subscription_billable_bytes_by_region | subscription/billable_bytes_by_region |
Billable bytes by region | Bytes |
| subscription_byte_cost | subscription/byte_cost |
Subscription byte cost | Bytes |
| subscription_dead_letter_message_count | subscription/dead_letter_message_count |
Dead letter message count | Count |
| subscription_delivery_latency_health_score | subscription/delivery_latency_health_score |
Delivery latency health score | Count |
| subscription_expired_ack_deadlines_count | subscription/expired_ack_deadlines_count |
Expired acknowledgment deadlines count | Count |
| subscription_message_transform_latencies | subscription/message_transform_latencies |
Subscription message transformation latency | ms |
| subscription_mod_ack_deadline_message_count | subscription/mod_ack_deadline_message_count |
Modified acknowledgment deadline message count | Count |
| subscription_num_retained_acked_messages | subscription/num_retained_acked_messages |
Number of retained acknowledged messages | Bytes |
| subscription_num_retained_acked_messages_by_region | subscription/num_retained_acked_messages_by_region |
Number of retained acknowledged messages by region | Count |
| subscription_num_unacked_messages_by_region | subscription/num_unacked_messages_by_region |
Number of unacknowledged messages by region | Count |
| subscription_num_undelivered_messages | subscription/num_undelivered_messages |
Number of unacknowledged messages | Count |
| subscription_oldest_retained_acked_message_age | subscription/oldest_retained_acked_message_age |
Age of the oldest retained acknowledged message | s |
| subscription_oldest_retained_acked_message_age_by_region | subscription/oldest_retained_acked_message_age_by_region |
Age of the oldest retained acknowledged message by region | s |
| subscription_oldest_unacked_message_age | subscription/oldest_unacked_message_age |
Age of the oldest unacknowledged message | s |
| subscription_oldest_unacked_message_age_by_region | subscription/oldest_unacked_message_age_by_region |
Age of the oldest unacknowledged message by region | s |
| subscription_open_streaming_pulls | subscription/open_streaming_pulls |
Number of open streaming pulls | Count |
| subscription_pull_ack_message_operation_count | subscription/pull_ack_message_operation_count |
Acknowledged message operation count | Count |
| subscription_pull_ack_request_count | subscription/pull_ack_request_count |
Acknowledgment request count | Count |
| subscription_pull_request_count | subscription/pull_request_count |
Pull request count | Count |
| subscription_push_request_count | subscription/push_request_count |
Push request count | Count |
| subscription_push_request_latencies | subscription/push_request_latencies |
Push latency | us |
| subscription_retained_acked_bytes | subscription/retained_acked_bytes |
Retained acknowledged bytes | Bytes |
| subscription_retained_acked_bytes_by_region | subscription/retained_acked_bytes_by_region |
Retained acknowledged bytes by region | Bytes |
| subscription_seek_request_count | subscription/seek_request_count |
Seek request count | Count |
| subscription_sent_message_count | subscription/sent_message_count |
Sent message count | Count |
| topic_byte_cost | topic/byte_cost |
Topic byte cost | Bytes |
| topic_config_updates_count | topic/config_updates_count |
Topic configuration operations count | Count |
| topic_ingestion_byte_count | topic/ingestion_byte_count |
Ingested byte count | Bytes |
| topic_ingestion_data_source_state | topic/ingestion_data_source_state |
Ingested data source state | - |
| topic_ingestion_failure_count | topic/ingestion_failure_count |
Ingestion failure count | Count |
| topic_ingestion_message_count | topic/ingestion_message_count |
Ingested message count | Count |
| topic_message_sizes | topic/message_sizes |
Published message sizes | Bytes |
| topic_message_transform_latencies | topic/message_transform_latencies |
Topic message transformation latency | ms |
| topic_num_retained_acked_messages_by_region | topic/num_retained_acked_messages_by_region |
Number of retained acknowledged messages by region | Count |
| topic_num_retained_messages | topic/num_retained_messages |
Number of retained messages | Count |
| topic_num_unacked_messages_by_region | topic/num_unacked_messages_by_region |
Number of unacknowledged messages by region | Count |
| topic_oldest_retained_acked_message_age_by_region | topic/oldest_retained_acked_message_age_by_region |
Age of the oldest retained acknowledged message by region | s |
| topic_oldest_retained_message_age | topic/oldest_retained_message_age |
Age of the oldest retained message | s |
| topic_oldest_unacked_message_age_by_region | topic/oldest_unacked_message_age_by_region |
Age of the oldest unacknowledged message by region | s |
| topic_retained_acked_bytes_by_region | topic/retained_acked_bytes_by_region |
Retained acknowledged bytes by region | Bytes |
| topic_retained_bytes | topic/retained_bytes |
Retained bytes | Bytes |
| topic_send_request_count | topic/send_request_count |
Sent message count | Count |
| topic_send_request_latencies | topic/send_request_latencies |
Publish request latency | us |
| topic_unacked_bytes_by_region | topic/unacked_bytes_by_region |
Unacknowledged bytes by region | Bytes |