Monitor subscriptions within Pub/Sub

You can use the Google Cloud console to access the monitoring dashboard for a single subscription or all the subscriptions available in your project.

Before you begin

Ensure that you've prepared the following:

• A Cloud Billing account

• A Pub/Sub project with billing enabled

• At least one topic with a subscription in your Pub/Sub project

• Familiarity with Cloud Monitoring and Metrics Explorer

View the monitoring dashboard for all subscriptions

To view the monitoring dashboard for all the subscriptions in a project, perform the following steps:

1. In the Google Cloud console, go to the Pub/Sub Subscriptionspage.

   Go to Subscriptions

2. Click the Metricstab.

   The monitoring dashboard is displayed for all subscriptions in the project.

The monitoring dashboard has two sections: Overviewand Quota.

View the monitoring dashboard for a single subscription

To view the monitoring dashboard for a single subscription in a project, perform the following steps:

1. In the Google Cloud console, go to the Pub/Sub Subscriptionspage.

   Go to Subscriptions

2. In the Subscriptionspage, click any subscription.

   The subscription details page is displayed.

3. Within the subscription details page, click the Metricstab.

   The monitoring dashboard is displayed for the single subscription.

The monitoring dashboard has four sections: Overview, Health, Retention, and Pullor Push, depending on your subscription type. You can see the Retentionsection only if you enable message retention for the subscription.

Customize the monitoring dashboard

You can create a custom dashboard or add individual charts to an existing custom dashboard.

To create a custom dashboard, perform the following steps:

1. Follow the steps to go to the monitoring page for all subscriptions or for a single subscription .

2. Choose one of the following options:

   • To create a new dashboard containing all the charts, or to add all the charts to an existing custom dashboard, click Save as custom dashboard.

   • To add a single chart to a new or custom dashboard, in an individual chart, expand the more_vert More Actionsoption and click Add to custom dashboard.

You can view all your dashboards in the Monitoring console.

Modify a chart

To modify a chart, perform the following steps:

1. Follow the steps to go to the monitoring page for all subscriptions or for a single subscription .

2. In an individual chart, expand the more_vert More Actionsoption and click View in Metrics Explorer.

   The chart opens in Metrics Explorer.

3. You can use Monitoring Query Language queries to make changes to your chart and test the output.

4. Click Save chartto save the changes.

Create an alerting policy

Creating an alerting policy for a chart lets you set up an alert that monitors the metric, configure the circumstances under which you want to be alerted, and configure how you want to be notified.

For more information on how to create alerts, see Create metric-based alert policies .

Some charts might not offer a Create alerting policyoption. In this case, perform the following steps:

1. Save the chart to a custom dashboard.

2. In the custom dashboard, for the individual chart, expand the more_vert More Actionsoption.

3. Click Convert to alert chart.

Key charts to monitor subscriptions

Although there are a number of charts available to monitor your subscription, the following charts are a good starting point to check the status of a single subscription:

• The Oldest unacked messagechart in the Healthsection lets you check if any messages are taking a long time to be acknowledged after being published.

• The Unacked messages by regionchart in the Overviewsection lets you check the number of unacknowledged messages in each region for the subscription.

• The Delivery latency health scorechart in the Healthsection lets you check which factors may be contributing to an increased delivery latency. For more information about this metric, see Monitor delivery latency health .

The following chart in the Quotasection help you monitor quotas for all the subscriptions in your project:

• The Administrator operationschart lets you monitor administrative operations regarding subscriptions. Each administrator operation charges one unit against this quota.

For more information, see Pub/Sub quotas and limits .

What's next

• To monitor topics, see Monitor topics within Pub/Sub .

• To learn more about using MQL to build monitoring charts, see Using the Query Editor .

• To learn more about maintaining a healthy subscription, see Maintain a healthy subscription .