GCP Plugin (Public Preview)

Configuration

The GCP plugin allows you to collect devices, metadata, and metrics from the GCP Public Cloud environment. The GCP plugin makes use of GCP API for metric collection and allows you to monitor multiple different accounts.

Execute the following steps to monitor a GCP account. This will automatically create devices and collect metrics for various GCP resources for that account.

  1. To access the Device Manager from the navigation bar, click the Devices menu and select Device Manager.
  2. Either add a device with the GCP plugin or edit an existing device to enable the GCP plugin.
    • Click Add Device to display the New Device page.
    • Click wrenchIcon icon under the Actions column to display the Edit Device page.
  3. Click the plugin drop-down. By default, it is set to SNMP. Select GCP.

    gcpPluginDeviceManager

  4. Select the Enable GCP Integration check box.
  5. In the Project ID field, enter the ID of the GCP project you want to monitor.
  6. In the Service Account ID field, enter the ID of the GCP service account for SevOne.
  7. In the Private Key field, enter the value of the private key of GCP service account for SevOne.
  8. Click Save As New to save the current changes as a New Device, or click Save to confirm the changes in the Edit Device page.
  9. When the desired changes have been saved, click the Cancel button to return to the Device Manager page.

GCP Services

The GCP plugin supports the following services.

gcpObjectTypes
  • GCP Cloud Router
  • GCP Cloud Storage
  • GCP Compute Instance
  • GCP Interconnect

The GCP plugin uses:

  • GCP Monitoring API for metrics collection
  • GCP API for Metadata collection

Please refer to GCP Quick Start Guide (Public Preview) for additional details on how to setup GCP integration using the GCP Plugin.

GCP Device Groups

Device groups are created at an interval of 6 hours on SevOne NMS to group GCP devices by device description and metadata values. The GCP plugin regularly applies the rules for these groups to ensure the devices are added to appropriate groups.

Device Groups Hierarchy

  • All Device Groups (default) - device group that contains all devices on SevOne NMS.
  • GCP - device group that contains all automatically created GCP devices. A device is a member of this group if any of the following rules apply.
    • Cloud Router - this device group contains all Cloud Routers that exist as part of a GCP integration that has been created. A device is a member of this group if it contains GCP Cloud Router in the device description.
    • Cloud Storage - this device group contains all Cloud Storage that exist as part of a GCP integration that has been created. A device is a member of this group if it contains GCP Cloud Storage in the device description.
    • Compute Instance - this device group contains all Compute Instances that exist as part of an GCP integration that has been created. A device is a member of this group if it contains GCP Compute Instance in the device description.
    • Interconnect - this device group contains all Interconnects that exist as part of an GCP integration that has been created. A device is a member of this group if it contains GCP Interconnect in the device description.

GCP Metadata

New devices have metadata attributes added to them automatically in both the GCP and  GCP <service name> namespaces. i.e., a compute instance will have metadata attributes populated in both GCP and GCP Compute Instance namespaces.

The tables below contain all GCP metadata namespaces and the attributes associated with them in SevOne NMS.

GCP

Contains all attribute names and types that are created within the GCP metadata namespace. All GCP devices will have the following attributes populated.

Attribute Name Attribute Type Description
Billing account ID Text The billing account ID in which the resource belongs.
Project ID Text The project ID to which the resource belongs.
Project name Text The project display name.
Region Text The region in which the resource belongs.
Resource ID Text The resource ID of the resource.
Zone Text The zone in which the resource belongs.

GCP Compute Instance

Attribute Name Attribute Type Description
CPU platform Text The CPU platform used by the instance.
Machine type Text The machine type of the instance.
VM provisioning model Text The provisioning model of the instance.

GCP Cloud Router

Attribute Name Attribute Type Description
Google ASN Text Local BGP Autonomous System Number (ASN).
Interconnect encryption Text Indicates if a router is dedicated for use with encrypted VLAN attachments.
Network Text The network to which this router belongs.

GCP Cloud Storage

Attribute Name Attribute Type Description
Access Control Text The bucket's uniform bucket-level access configuration.
Default storage class Text The bucket's default storage class.
Encryption Text Encryption configuration for a bucket.
Location Text The location of the bucket.
Location type Text The type of bucket location.
Public access Text The bucket's public access configuration.

GCP Interconnect

Attribute Name Attribute Type Description
Capacity Integer Capacity of the interconnect.
Colocation facility Text Interconnect location where the connection is to be provisioned.
Description Text Description of the interconnect.
Type Text Type of the interconnect.

GCP Metrics

After a device is configured to monitor a GCP account, object, and indicator types are created on the configured SevOne NMS. GCP monitoring API starts pulling information into the corresponding SevOne NMS device, objects, and indicators.

From SevOne NMS > Administration > Monitoring Configuration > Object Types, under All Object Types in the left navigation bar, you will see all the object types and its respective indicators that the GCP plugin creates.

The tables below contain all the metrics collected by SevOne NMS and the associated Object and Indicator types created on SevOne NMS.

GCP Compute Instance

GCP Compute Instance contains the following object types.

For details, please refer to https://cloud.google.com/monitoring/api/metrics_gcp#gcp-compute

Object Type Indicator Name Unit Description
GCP Compute Instance CPU reserved_cores Number Reserved vCPUs.
scheduler_wait_time Seconds Scheduler wait time.
usage_time Seconds CPU usage.
utilization Percent CPU utilization.
Object Type Indicator Name Unit Description
GCP Compute Instance Disk average_io_latency Microseconds Disk average latency.
average_io_queue_depth Number Disk average IO queue depth.
max_read_bytes_count Bytes Peak disk read bytes.
max_read_ops_count Number Peak disk read Ops.
max_write_bytes_count Bytes Peak disk write bytes.
max_write_ops_count Number Peak disk write Ops.
read_bytes_count Bytes Disk read bytes.
read_ops_count Number Disk read operations.
write_bytes_count Bytes Disk write bytes.
write_ops_count Number Disk write operations.
Object Type Indicator Name Unit Description
GCP Compute Instance Memory ram_size Bytes VM memory total.
ram_used Bytes VM memory used.
swap_in_bytes_count Bytes VM swap in.
swap_out_bytes_count Bytes VM swap out.
Object Type Indicator Name Unit Description
GCP Compute Instance Network received_bytes_count Bytes Received bytes.
received_packets_count Number Received packets.
sent_bytes_count Bytes Sent bytes.
sent_packets_count Number Sent packets.
Object Type Indicator Name Unit Description
GCP Compute Instance Uptime uptime Seconds Uptime.
uptime_total Seconds Uptime total.

GCP Cloud Router

GCP Cloud Router contains the following object types.

For details, please refer to https://cloud.google.com/monitoring/api/metrics_gcp#gcp-router

Object Type Indicator Name Unit Description
GCP Router Availability router_up Number Router tasks up.
Object Type Indicator Name Unit Description
GCP Router BGP Sessions bgp_sessions_down_count Number BGP sessions down count.
bgp_sessions_up_count Number BGP sessions up count.
received_routes_count Number BGP received routes count.
sent_routes_count Number BGP sent routes count.
session_up Number BGP session status.
Object Type Indicator Name Unit Description
GCP Router Routes best_received_routes_count Number Received routes count.
sent_routes_count Number Sent routes count.

GCP Cloud Storage

GCP Cloud Storage contains the following object types.

For details, please refer to https://cloud.google.com/monitoring/api/metrics_gcp#gcp-storage

Object Type Indicator Name Unit Description
GCS ACL Operations acl_operations_count Number ACL usage.
object_specific_acl_mutation_count Number Object ACL changes.
Object Type Indicator Name Unit Description
GCS Autoclass Transitions transitioned_bytes_count Bytes Autoclass transitioned bytes count.
transition_operation_count Number Autoclass transition count.
Object Type Indicator Name Unit Description
GCS Network received_bytes_count Bytes Received bytes.
sent_bytes_count Bytes Sent bytes.
Object Type Indicator Name Unit Description
GCS Operations lro_count Number Operation count.
request_count Number Request count.
Object Type Indicator Name Unit Description
GCS Storage object_count Number Object count.
total_bytes Bytes Total bytes.
total_byte_seconds Byte*Seconds Total byte seconds.

GCP Interconnect

GCP Interconnect contains the following object types.

For details, please refer to https://cloud.google.com/monitoring/api/metrics_gcp#gcp-interconnect

Object Type Indicator Name Unit Description
GCP Interconnect Network capacity Bytes Network capacity.
dropped_packets_count Number Dropped packets.
received_bytes_count Bytes Ingress bytes.
received_unicast_packets_count Number Ingress unicast packets.
receive_errors_count Number Ingress errors.
send_errors_count Number Egress errors.
sent_bytes_count Bytes Egress bytes.
sent_unicast_packets_count Number Egress unicast packets.