View logs and metrics
Cloud Router sends logging information to Cloud Logging and sends monitoring metrics to Cloud Monitoring. This page shows you how to access both types of information.
Logs
Cloud Router sends logging information to Cloud Logging, which logs the following events:
- Router events related to your Cloud Router
- BGP events related to a BGP configuration and session
- Route events related to route announcements between the two BGP peers
- Route quota events related to Cloud Router unique prefix quotas
View logs
Console
In the Cloud de Confiance console, go to the Cloud Routers page.
Select a Cloud Router from the list of Cloud Routers.
In the Logs column, click View.
Cloud Router logs have the following formats:
Router, BGP, and route announcement events: Logs (
compute.googleapis.com/router_events) associated with thegce_routermonitored resource:[Event Type]: [Log Text]
Route quota events: JSON logs (
router.googleapis.com/route_quota_events) associated with thegce_network_regionmonitored resource. For details about the payload structure, see Route quota events log.
To build queries in the Logs Explorer, see Build queries in the Logs Explorer.
Info log
The following table lists events that are logged in the Logging Info log.
| Event | Description |
|---|---|
| Router event | Router task activated |
| Router task de-activated | |
| BGP event | Successfully added configuration for peers: LIST_OF_PEERS |
BGP peering with PEER came up x seconds ago |
|
BGP peering with PEER went down with the
reason MESSAGE, where MESSAGE
provides an explanation such as HOLD_TIMER_EXPIRED or
LINK_DOWN.
For more information about LINK_DOWN, see
LINK_DOWN message appears in Cloud Router logs. |
|
BGP Router ID set to BGP_ROUTER_ID |
|
| Route event | Advertising prefix to peers: PREFIX |
Withdrawing prefix from peers: PREFIX |
|
Prefix PREFIX Nexthops LIST_OF_NEXTHOPS received
by Cloud Router |
|
Prefix PREFIX Nexthops LIST_OF_NEXTHOPS deleted
from Cloud Router |
Common Logging events
To view common Logging events for Cloud Router as listed in the following table, use the steps for viewing logs. Specify one of the advanced filters listed in the table. Adjust the timeframe for the Logging search as needed.
| Event description | Logging advanced filter |
|---|---|
| Migrating or restarting a Cloud Router process | resource.type="gce_router" "task activated" |
| Adding learned routes | resource.type="gce_router" "received by cloud router" |
| Removing learned routes | resource.type="gce_router" "deleted from cloud router" |
| Exporting advertised routes | resource.type="gce_router" ("Route Event" AND "Advertising prefix") |
| BGP peering came up | resource.type="gce_router" ("BGP peering" AND "came up") |
| BGP peering came up with MD5 authentication | resource.type="gce_router" ("BGP peering" AND "came up" AND "MD5 authentication enabled") |
| BGP peering went down | resource.type="gce_router" ("BGP peering" AND "went down") |
| BGP peering went down because the link went down on the Google peering edge router | resource.type="gce_router" ("BGP peering" AND "went down" AND "LINK_DOWN") |
| A BGP session was shut down due to excessive received routes | resource.type="gce_router" ("NOTIFICATION 6/1") severity="CRITICAL" |
| A Cloud Router dynamic route prefix quota has been exceeded | resource.type="gce_network_region" ("No more routes" AND "can be programmed") severity="ERROR" |
| A route was dropped because of a quota issue | resource.type="gce_network_region" severity="ERROR" jsonPayload.affectedResource.routes.nextHopIpAddresses=" PEER_IP_ADDRESS"
|
| A BFD session waiting for peer | resource.type="gce_router" ("BFD Event" AND "bfd enabled, state [Init, NoDiagnostic]") |
| A BFD session came up | resource.type="gce_router" ("BFD Event" AND "to [Up, NoDiagnostic]") |
| A BFD session went down (Rx Timer expired) | resource.type="gce_router" ("BFD Event" AND "to [Down, ControlDetectionTimeExpired]") |
A BFD session went down (Peer's state is Down or AdminDown) |
resource.type="gce_router" ("BFD Event" AND "to [Down, NeighborSessionDown]") |
| A BFD session is disabled locally | resource.type="gce_router" ("BFD Event" AND "bfd disabled") |
Route quota events log
Cloud Router writes route quota events to Cloud Logging under
router.googleapis.com/route_quota_events through the
gce_network_region monitored resource. These logs help you monitor route
prefix usage against your quotas and identify any
dropped routes.
Route quota events are logged at the following severity levels:
WARNING: Route usage approaches the quota limit (usage reaches or exceeds 75% of the regional or global limit).ERROR: Route usage reaches or exceeds 100% of the limit. Excess routes can't be programmed and are dropped. If routes are dropped due to quota exhaustion, the log entry includes details about the dropped routes in thejsonPayload.affectedResource.routesfield.
Route quota event fields
Route quota log entries contain a structured JSON payload (jsonPayload) with
the following fields:
| Field | Description |
|---|---|
eventTime |
The timestamp when the quota event occurred. |
routeQuotaEvent.helperMessage |
A message describing the quota state—for example, warning when the usage of a Cloud Router unique prefix quota is approaching or has exceeded its limit. |
routeQuotaEvent.regionalRouteCount |
The usage of the unique Cloud Router dynamic route prefixes from own region per region per VPC network quota. The usage represents the number of unique route prefixes, processed by the dynamic route control plane in a given region of a VPC network, received from all Cloud Router BGP sessions in that same region and network. |
routeQuotaEvent.regionalRouteLimit |
The limit of the unique Cloud Router dynamic route prefixes from own region per region per VPC network quota. The limit represents the maximum number of unique route prefixes that can be processed by the dynamic route control plane in a given region of a VPC network, received from all Cloud Router BGP sessions in that same region and network. |
routeQuotaEvent.globalRouteCount |
The usage of the unique Cloud Router dynamic route prefixes from other regions per region per VPC network quota. The usage represents the number of unique route prefixes, processed by the dynamic route control plane in a given region of a VPC network, received from all Cloud Router BGP sessions in other regions of the same network. |
routeQuotaEvent.globalRouteLimit |
The limit of the unique Cloud Router dynamic route prefixes from other regions per region per VPC network quota. The limit represents the maximum number of unique route prefixes that can be processed by the dynamic route control plane in a given region of a VPC network, received from all Cloud Router BGP sessions in other regions of the same network. |
affectedResource.routes[] |
An entry containing attributes for dropped prefixes that didn't result
in the creation of dynamic routes when a Cloud Router unique
prefix quota's usage exceeds its limit (present in
ERROR severity events). Each entry includes these attributes:
|
Metrics
Cloud Router publishes metrics to Cloud Monitoring. For a list of metrics published for Cloud Router, see Monitor metrics for Cloud Router.
All Cloud Router metrics cover both IPv4 and IPv6 traffic.
View metrics by using the API
You can access these metrics by using the Cloud Monitoring API. For more information, see Read metric data.
View metrics by using Monitoring dashboards
You can also create a custom dashboard in Cloud Monitoring to help you analyze these metrics. For more information, see Manage custom dashboards.
To create a custom dashboard, follow these steps.
Console
In the Cloud de Confiance console, go to the Monitoring page.
Select Dashboards, and then on the Dashboards Overview page, click Create dashboard.
Optional: Update the dashboard title with a descriptive name for your dashboard.
In the Chart library, select the chart that you want to add. For example, to add a Line chart to the dashboard, click or drag that entry from the Chart library to the graph area.
In Chart Title, change the chart title or use the suggested title.
In What data do you want to view?, do the following:
- In Resource type, click the Type to filter field, and enter
Cloud Router. - In Metric, add a Cloud Router metric.
- In Resource type, click the Type to filter field, and enter
Use the Filter controls to restrict the view to only certain routers or sessions.
To add another metric, click Add another metric.
Some metrics are for the Cloud Router and some metrics are for a BGP
session on a given Cloud Router. Cloud Router metrics are
shown as router-name, while BGP session metrics are shown as
router-name(bgp-name).
Monitoring metrics for Cloud Router
What's next
- To troubleshoot issues when using Cloud Router, see Troubleshooting.