Operational Dashboards

Operational Dashboards show real-time API performance for one subscribe key per dashboard, including request volume, error rates, and traffic by region. Operational Dashboards are available on the Platinum and Enterprise support plans. PubNub builds and hosts each dashboard and sends you a link after you raise a support request.

The data behind the dashboards comes from the requests your app makes to PubNub APIs. Metrics update every five minutes.

Availability

Feature	Platinum	Enterprise
Operational dashboard links	One dashboard	Unlimited dashboards
Raw metrics export (Datadog / New Relic)	No	Included

Access

To get a dashboard, raise a PubNub support ticket or contact support. Include:

• Subscribe key. The key the dashboard monitors.
• Link access. Whether the dashboard link is public, so anyone with the link can open it, or restricted to email addresses you list.

PubNub processes the request and sends you the dashboard link. See Availability for what your support plan includes. If your support plan doesn't include what you need, contact sales about pricing.

What the dashboard shows

The dashboard for your subscribe key has seven sections.

Summary

The Summary section shows the last hour of traffic for your subscribe key, updated every five minutes. It includes:

• Total request count for the previous hour
• Request distribution across the PubNub Points of Presence that handled your traffic, for example Virginia, California, Frankfurt, Tokyo, or Mumbai
• Total requests per five-minute interval, compared against the same time yesterday
• Maximum requests per second for the top five APIs in the last hour
• Client disconnect count per five-minute interval

Client errors

The Client errors section shows the count of API calls that returned a 4xx response and the percentage of total calls that returned an error. Operational Dashboards color-code the client error rate green up to 1%, yellow from 1% to 5%, and red above 5%.

The section splits 4xx errors into two categories:

• Non-403 errors. These typically come from invalid API calls. High counts here suggest coding errors in your client.
• 403 Not Authorized errors. If you use Access Manager, elevated 403 counts can indicate a token provisioning error or calls by unauthorized users.

Messaging

The Messaging section shows call counts for each messaging API and a graph of successful requests per five-minute interval.

Presence, Access Manager, and channel groups

This section of the dashboard shows usage for Presence, Access Manager, and channel group operations:

• Counts for hereNow, whereNow, and Presence heartbeat calls
• Access Manager token grants (v3)
• Calls to addChannels, listChannels, and removeChannels

Server errors

The Server errors section shows counts of API calls that returned a 5xx server error. Multiple 5xx errors can indicate a platform issue. Check the PubNub status board and contact support if errors persist.

Functions

The Functions section shows activity for keysets configured with Functions:

• Execution counts for functions triggered by a publish event or a direct URL call
• Outbound XHR request counts from functions
• Function error counts

Some functions return errors on purpose. Whether errors in this section matter depends on your function logic.

Push notifications

The Push notifications section shows activity for keysets configured with mobile push notifications:

• Total send attempts by PubNub
• Error counts from Apple (APNs) and Android (FCM) push providers

Most push errors come from token configuration issues. If errors rise, check that your push tokens in PubNub are valid and not expired.

Raw metrics export

The Operational Dashboards raw metrics export is available on the Enterprise support plan. You can request it instead of, or alongside, a dashboard link. The export streams the same data to your own monitoring environment in Datadog or New Relic, where you can build custom queries and alerts. To start from ready-made queries for request volume, error rates, and per-API health, see Operational Dashboards raw metrics queries.

To request an export, open a PubNub support ticket and include:

• Datadog. Your Datadog API key, and your Datadog region if it isn't the default US region.
• New Relic. Your New Relic Insert key, and your New Relic datacenter if it isn't US.

Raw metric format

The primary metric is pubnub.http_status. It carries the following tags:

Tag	Description	Example values
customer	Account name for the subscribe key	acme-prod
api	API that handled the request	publish, subscribe, presence, history, signal, pam-grant, auth-grant, message-actions, channel-registration, files.publish-file, run_before, run_after
status	HTTP response status code	200, 403, 404, 499
status_class	HTTP status class	2xx, 3xx, 4xx, 5xx
region	PubNub Point of Presence where the request was recorded	us-east-1, us-west-1, eu-central-1, ap-northeast-1, ap-south-1

Status 499 means the client closed the connection before PubNub returned a response.

The Functions and Push notifications sections appear in the dashboard only. The raw metrics export doesn't include them.