---
title: Google Cloud Router
description: >-
  Dynamically exchange routes between your VPC and on-premises networks using
  Border Gateway Protocol (BGP).
breadcrumbs: Docs > Integrations > Google Cloud Router
---

> For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt).

# Google Cloud Router

{% callout %}
# Important note for users on the following Datadog sites: us2.ddog-gov.com

{% alert level="info" %}
To find out if this integration is available in your organization, see your [Datadog Integrations](https://app.datadoghq.com/integrations) page or ask your organization administrator.

To initiate an exception request to enable this integration for your organization, email [support@ddog-gov.com](mailto:support@ddog-gov.com).
{% /alert %}

{% /callout %}

## Overview{% #overview %}

Google Cloud Router enables you to dynamically exchange routes between your Virtual Private Cloud (VPC) and on-premises networks by using Border Gateway Protocol (BGP).

Use the Datadog Google Cloud Platform integration to collect metrics from Google Cloud Router.

## Setup{% #setup %}

### Installation{% #installation %}

If you haven't already, set up the [Google Cloud Platform integration](https://docs.datadoghq.com/integrations/google-cloud-platform.md) first. There are no other installation steps.

### Log collection{% #log-collection %}

Google Cloud Router logs are collected with Google Cloud Logging and sent to a Dataflow job through a Cloud Pub/Sub topic. If you haven't already, [set up logging with the Datadog Dataflow template](https://docs.datadoghq.com/integrations/google-cloud-platform.md#log-collection).

Once this is done, export your Google Cloud Router logs from Google Cloud Logging to the Pub/Sub topic:

1. Go to the [Google Cloud Logging page](https://console.cloud.google.com/logs/viewer) and filter the Google Cloud Router logs.
1. Click **Create Export** and name the sink.
1. Choose "Cloud Pub/Sub" as the destination and select the Pub/Sub topic that was created for that purpose. **Note**: The Pub/Sub topic can be located in a different project.
1. Click **Create** and wait for the confirmation message to show up.

## Data Collected{% #data-collected %}

### Metrics{% #metrics %}

|  |
|  |
| **gcp.router.best_received_routes_count**(gauge)                                      | Current number of best routes received by router.                                                                                                                                                                                                                                                                       |
| **gcp.router.bfd.control.receive_intervals**(gauge)                                     | BFD control packets receive intervals.*Shown as millisecond*                                                                                                                                                                                                                                                            |
| **gcp.router.bfd.control.received_packets_count**(count)                               | Number of control packets received from this BFD session.                                                                                                                                                                                                                                                               |
| **gcp.router.bfd.control.rejected_packets_count**(count)                               | Number of control packets rejected, from this BFD session.                                                                                                                                                                                                                                                              |
| **gcp.router.bfd.control.transmit_intervals**(gauge)                                    | BFD control packets transmit intervals.*Shown as millisecond*                                                                                                                                                                                                                                                           |
| **gcp.router.bfd.control.transmitted_packets_count**(count)                            | Number of control packets transmitted from this BFD session.                                                                                                                                                                                                                                                            |
| **gcp.router.bfd.session_flap_events_count**(count)                                   | Number of each BFD flap event from this BFD session. A session flap event refers to the transition from Up state.                                                                                                                                                                                                       |
| **gcp.router.bfd.session_up**(gauge)                                                    | Indicator for successful BFD session establishment. 1 indicates the session is up. 0 indicates the session is down.                                                                                                                                                                                                     |
| **gcp.router.bgp.received_routes_count**(gauge)                                        | Current number of routes received on a bgp session.                                                                                                                                                                                                                                                                     |
| **gcp.router.bgp.sent_routes_count**(gauge)                                            | Current number of routes sent on a bgp session.                                                                                                                                                                                                                                                                         |
| **gcp.router.bgp.session_up**(gauge)                                                    | Indicator for successful bgp session establishment. 1 indicates the session is up. 0 indicates the session is down.                                                                                                                                                                                                     |
| **gcp.router.bgp_sessions_down_count**(gauge)                                         | Number of BGP sessions on the router that are down.                                                                                                                                                                                                                                                                     |
| **gcp.router.bgp_sessions_up_count**(gauge)                                           | Number of BGP sessions on the router that are up.                                                                                                                                                                                                                                                                       |
| **gcp.router.dynamic_routes.learned_routes.any_dropped_unique_destinations**(gauge) | A boolean metric of whether there are any unique destinations dropped in a network region due to exceeding quota.                                                                                                                                                                                                       |
| **gcp.router.dynamic_routes.learned_routes.dropped_unique_destinations**(gauge)      | The number of unique destinations dropped in a network region due to exceeding quota.                                                                                                                                                                                                                                   |
| **gcp.router.dynamic_routes.learned_routes.unique_destinations_limit**(gauge)        | The maximum number of unique destinations allowed by route quota for this network region.                                                                                                                                                                                                                               |
| **gcp.router.dynamic_routes.learned_routes.used_unique_destinations**(gauge)         | Number of unique destinations used by learned routes for this network region.                                                                                                                                                                                                                                           |
| **gcp.router.nat.allocated_ports**(gauge)                                               | Number of ports allocated to all VMs by the NAT gateway.                                                                                                                                                                                                                                                                |
| **gcp.router.nat.closed_connections_count**(count)                                     | Count of connections closed over the NAT gateway.                                                                                                                                                                                                                                                                       |
| **gcp.router.nat.dropped_received_packets_count**(count)                              | Count of received packets dropped by the NAT gateway.                                                                                                                                                                                                                                                                   |
| **gcp.router.nat.dropped_sent_packets_count**(count)                                  | Count of sent packets dropped by the NAT gateway.                                                                                                                                                                                                                                                                       |
| **gcp.router.nat.nat_allocation_failed**(gauge)                                        | Indicates if there is a failure in allocating NAT IPs to any VM in the NAT gateway.                                                                                                                                                                                                                                     |
| **gcp.router.nat.new_connections_count**(count)                                        | Count of new connections created over the NAT gateway.                                                                                                                                                                                                                                                                  |
| **gcp.router.nat.open_connections**(gauge)                                              | Number of connections currently open on the NAT gateway.                                                                                                                                                                                                                                                                |
| **gcp.router.nat.port_usage**(gauge)                                                    | Maximum number of connections from VM to a single internet endpoint (IP:port).                                                                                                                                                                                                                                          |
| **gcp.router.nat.received_bytes_count**(count)                                         | Count of bytes received (destination -> VMs) via the NAT gateway.*Shown as byte*                                                                                                                                                                                                                                        |
| **gcp.router.nat.received_packets_count**(count)                                       | Count of packets received (destination -> VMs) via the NAT gateway.                                                                                                                                                                                                                                                     |
| **gcp.router.nat.sent_bytes_count**(count)                                             | Count of bytes sent (VMs -> destination) over the NAT gateway.*Shown as byte*                                                                                                                                                                                                                                           |
| **gcp.router.nat.sent_packets_count**(count)                                           | Count of packets sent (VMs -> destination) over the NAT gateway.                                                                                                                                                                                                                                                        |
| **gcp.router.router_up**(gauge)                                                         | Number of router software tasks that are running successfully. A value greater than or equal to 1 indicates that the router is up, although not all software tasks may be running. Compare the returned number to the expected number of software tasks for the router. A value of 0 indicates that the router is down. |
| **gcp.router.sent_routes_count**(gauge)                                                | Current number of routes sent by router.                                                                                                                                                                                                                                                                                |

### Events{% #events %}

The Google Cloud Router integration does not include any events.

### Service Checks{% #service-checks %}

The Google Cloud Router integration does not include any service checks.

## Troubleshooting{% #troubleshooting %}

Need help? Contact [Datadog support](https://docs.datadoghq.com/help/).
