Use Chrome Management Telemetry API notifications

For administrators or third-party partners using Chrome Management Telemetry API.

As a Chrome administrator, you can use the Chrome Telemetry API to monitor the operation and health of ChromeOS devices helping you with root cause analysis and troubleshooting.

Using Chrome Management Telemetry API notifications, you can subscribe to and receive Telemetry API event notifications using Google Cloud Pub/Sub.

For more details, see Chrome Management Telemetry API. 

Google Cloud Pub/Sub

Using Google Cloud Pub/Sub, you can create a system of event producers and consumers, called publishers and subscribers. This system streams analytics and data integration pipelines to receive and distribute data.

Publishers communicate with subscribers asynchronously by broadcasting events. They send events to the Pub/Sub service, regardless of how or when these events are processed. Pub/Sub then delivers the events to all the services that need them. Pub/Sub does not have to wait for subscribers to receive the data and this increases the flexibility of the system.

Before you begin

Before you can connect the Chrome Management Telemetry API notifications to Google Cloud Pub/Sub, make sure of the following;

• You have super admin access to the Google Admin console. This requires a Google managed account and a verified domain. For more details, see Join your managed Chrome organization.
• Your ChromeOS devices are enrolled in the domain used to access the Admin console. For more details, see Enroll ChromeOS devices.
• You have a Google Cloud project to enable Pub/Sub for notifications.

Step 1: Enable Chrome Management Telemetry notifications

1. Sign in to your Google Admin console.

   Sign in using your administrator account (does not end in @gmail.com).

2. In the Admin console, go to Menu  DevicesChromeSettingsDevice settings.
3. To apply the setting to all devices, leave the top organizational unit selected. Otherwise, select a child organizational unit.
4. Go to User and device reporting.
5. Click Report device telemetry.
6. Select Enable all telemetry reporting.
7. Click Save.

When you have turned on telemetry reporting, you can create a subscription on various types of events that happen on the ChromeOS devices in your organization. Notifications of these events are then sent to their configured Pub/Sub topic.

Step 2: Create a Pub/Sub topic in a Google Cloud Project

For more details, see Integrate Google Cloud Pub/Sub with Chrome Enterprise Core.

1. Sign into the Google Cloud Platform.
2. In the Pub/Sub section, go to the Topics page.
3. Select an existing topic or click Create Topic.
4. Enter a Topic ID and click Create Topic.
5. Select the topic you created to receive the events from Chrome.
6. Under Permissions, click Add Member.
7. Under New principals, enter cloud-pub-sub-publisher@chrome-reporting.iam.gserviceaccount.com.
   This is the account that the Google server uses to make calls to the Publish API of the Pub/Sub topic. The topic must grant publishing access to this account.
8. From Role, select Pub/Sub Publisher.
9. Click Save.
10. Copy your topic’s full path and save it for the next steps in the Admin console.

Step 3: Register the Pub/Sub topic and create notification configurations

To create notification configurations, you need to call the Chrome Management Telemetry API. The following links provide any additional information you need.

• To learn how to access the Chrome Management Telemetry API, see this general guide.
• To learn how to create a notification configuration, see here. You can call the Telemetry notifications API and create notification configurations by sending a POST request.
  • In the body, replace the google_cloud_pubsub_topic with your topic.
    For example, to configure event notifications for USB added and removed notifications, set:

{

  "google_cloud_pubsub_topic": "projects/your-project/topics/your-topic",

  "filter": {

    "telemetry_event_notification_filter": {

      "event_types": [

        "USB_ADDED",

        "USB_REMOVED"

      ]

    }

  }

}

Step 4: Begin receiving Chrome Management Telemetry API notifications

You can receive notifications in the following ways:

• Using Google Cloud console
• Using Google Cloud CLI 
• Writing code to receive the notifications using Google-provided libraries