Configure VPC Flow Logs

Console

1. In the Google Cloud console, go to the VPC networkspage.

   Go to VPC networks

2. On the Subnets in current projecttab, select one or more subnets and then click menu Manage flow logs.

3. In menu Manage flow logs, click Add new configuration.

4. Do one of the following:

   • If you selected one subnet, in the Configurations — Subnetssection, click Add a configuration.
   • If you selected multiple subnets, in the Configure VPC Flow Logssection, select Network Management API.

5. For Name, enter a name for the new VPC Flow Logs configuration.

6. Optional: Adjust the Aggregation intervaland any of the settings in the Advanced settingssection:

   • Whether to configure log filtering. By default, Keep only logs that match a filteris deselected.
   • Whether to include metadata in the final log entries. By default, Metadata annotationsincludes all fields.
   • The Secondary sampling rate. 100% means that all entries generated by the primary flow log sampling process are kept. The primary flow log sampling rate isn't configurable. For more information, see Log sampling and processing .

7. Click Save.

gcloud

To enable VPC Flow Logs for a subnet, use the gcloud network-management vpc-flow-logs-configs create command .

You enable VPC Flow Logs by creating a VPC Flow Logs configuration. You can create the configuration with all of its parameters set to their default values, or you can customize the default values.

In the gcloud CLI, set your project to the Google Cloud project ID of the subnet and run one of the following commands:

• To create a default VPC Flow Logs configuration, run the following command:

  gcloud network-management vpc-flow-logs-configs create CONFIG_NAME 
  \
      --location=global \
      --subnet= SUBNET 
  

• To create a custom VPC Flow Logs configuration, specify each parameter that you want to customize.

  For example, to customize the aggregation interval, filtering, secondary sampling rate, and metadata parameters when creating a VPC Flow Logs configuration, run the following command:

  gcloud network-management vpc-flow-logs-configs create CONFIG_NAME 
  \
      --location=global \
      --subnet= SUBNET 
  \
      --aggregation-interval= AGGREGATION_INTERVAL 
  \
      --filter-expr= FILTER_EXPRESSION 
  \
      --flow-sampling= SAMPLING_RATE 
  \
      --metadata= LOGGING_METADATA 
  

  Replace the following:

  • CONFIG_NAME : a name for the configuration.
  • SUBNET : the subnet that you want to log. Must be specified in the following format: "projects/ PROJECT_ID /regions/ REGION /subnetworks/ NAME " , where:
    • PROJECT_ID is the ID of the Google Cloud project that contains the subnet. The configuration must be created in this project.
    • REGION is the region of the subnet.
    • NAME is the name of the subnet.

  To set the optional parameters in a custom configuration, replace the following:

  • AGGREGATION_INTERVAL : the aggregation interval for flow logs generated by this configuration. This parameter can be set to interval-5-sec (default), interval-30-sec , interval-1-min , interval-5-min , interval-10-min , or interval-15-min .
  • FILTER_EXPRESSION : an expression that defines which logs you want to keep. The expression has a limit of 2,048 characters. For more information, see Log filtering and Examples of log filters .
  • SAMPLING_RATE : the secondary flow sampling rate. This parameter can be set from greater than 0.0 to 1.0 (all logs, default). For more information, see Log sampling and processing .
  • LOGGING_METADATA : the metadata annotations that you want to include in the logs:
    • Use include-all-metadata to include all metadata annotations (default).
    • Use exclude-all-metadata to exclude all metadata annotations.
    • Use custom-metadata to include a custom list of metadata fields. To specify the metadata fields, use the --metadata-fields flag:
      • --metadata-fields= METADATA_FIELDS : replace METADATA_FIELDS with a comma-separated list of metadata fields that you want to include in the logs. For example, src_instance,dst_instance . Can be set only if metadata is set to custom-metadata .

API

To enable VPC Flow Logs for a subnet, use the projects.locations.vpcFlowLogsConfigs.create method .

You enable VPC Flow Logs by creating a VPC Flow Logs configuration. You can create the configuration with all of its parameters set to their default values, or you can customize the default values.

To create a default VPC Flow Logs configuration, include the following parameters in your API request:

POST https://networkmanagement.googleapis.com/v1/projects/ PROJECT_ID 
/locations/global/vpcFlowLogsConfigs?vpc_flow_logs_config_id= CONFIG_NAME 
{
  "subnet": " SUBNET 
"
}

To create a custom VPC Flow Logs configuration, specify each parameter that you want to customize.

For example, to customize the aggregation interval, filtering, secondary sampling rate, and metadata parameters when creating a VPC Flow Logs configuration, include the following parameters in your API request:

POST https://networkmanagement.googleapis.com/v1/projects/ PROJECT_ID 
/locations/global/vpcFlowLogsConfigs?vpc_flow_logs_config_id= CONFIG_NAME 
{
  "subnet": " SUBNET 
",
  "aggregationInterval": " AGGREGATION_INTERVAL 
",
  "filterExpr": " FILTER_EXPRESSION 
",
  "flowSampling": SAMPLING_RATE 
,
  "metadata": " LOGGING_METADATA 
"
}

Replace the following:

• PROJECT_ID : the Google Cloud project ID of the subnet.
• CONFIG_NAME : a name for the configuration.
• SUBNET : the subnet that you want to log. Must be specified in the following format: projects/ PROJECT_ID /regions/ REGION /subnetworks/ NAME , where:
  • PROJECT_ID is the project ID of the subnet.
  • REGION is the region of the subnet.
  • NAME is the name of the subnet.

• AGGREGATION_INTERVAL : the aggregation interval for flow logs generated by this configuration. This parameter can be set to INTERVAL_5_SEC (default), INTERVAL_30_SEC , INTERVAL_1_MIN , INTERVAL_5_MIN , INTERVAL_10_MIN , or INTERVAL_15_MIN .
• FILTER_EXPRESSION : an expression that defines which logs you want to keep. The expression has a limit of 2,048 characters. For more information, see Log filtering .
• SAMPLING_RATE : the secondary flow sampling rate. This parameter can be set from greater than 0.0 to 1.0 (all logs, default). For more information, see Log sampling and processing .
• LOGGING_METADATA : the metadata annotations that you want to include in the logs:
  • Use INCLUDE_ALL_METADATA to include all metadata annotations (default).
  • Use EXCLUDE_ALL_METADATA to exclude all metadata annotations.
  • Use CUSTOM_METADATA to include a custom list of metadata fields. To specify the metadata fields, use the metadataFields parameter:
    • metadataFields: METADATA_FIELDS : replace METADATA_FIELDS with a comma-separated list of metadata fields that you want to include in the logs. For example, src_instance,dst_instance . Can be set only if metadata is set to CUSTOM_METADATA .

Console

1. In the Google Cloud console, go to the VPC networkspage.

   Go to VPC networks

2. Click the network where you want to add a subnet.

3. Click Add subnet.

4. For Flow logs, select On.

5. Optional: Adjust the Aggregation intervaland any of the following settings in the Advanced settingssection:

   • Whether to configure log filtering. By default, Keep only logs that match a filteris deselected.
   • Whether to include metadata in the final log entries. By default, Metadata annotationsincludes all fields.
   • The Secondary sampling rate. 50% means that half of entries generated by the primary flow log sampling process are kept. The primary flow log sampling rate isn't configurable. For more information, see Log sampling and processing .

6. Populate other fields as appropriate .

7. Click Add.

gcloud

Run the following command:

gcloud compute networks subnets create SUBNET_NAME 
\
    --enable-flow-logs \
    [--logging-aggregation-interval= AGGREGATION_INTERVAL 
] \
    [--logging-flow-sampling= SAMPLING_RATE 
] \
    [--logging-filter-expr= FILTER_EXPRESSION 
] \
    [--logging-metadata= LOGGING_METADATA 
] \
    [--logging-metadata-fields= METADATA_FIELDS 
] \
    [other flags as needed]

Replace the following:

• AGGREGATION_INTERVAL : the aggregation interval for flow logs in that subnet. The interval can be set to any of the following: 5-sec (default), 30-sec, 1-min, 5-min, 10-min, or 15-min.
• SAMPLING_RATE : the secondary flow sampling rate. Secondary flow sampling can be set from 0.0 (no sampling) to 1.0 (all logs). Default is 0.5 . For more information, see Log sampling and processing .
• FILTER_EXPRESSION : an expression that defines which logs you want to keep. The expression has a limit of 2,048 characters. For more information, see Log filtering and Examples of log filters .

• LOGGING_METADATA : the metadata annotations that you want to include in the logs:

  • Use include-all to include all metadata annotations.
  • Use exclude-all to exclude all metadata annotations (default).
  • Use custom to include a custom list of metadata fields that you specify in METADATA_FIELDS .

• METADATA_FIELDS : a comma-separated list of metadata fields you want to include in the logs. For example, src_instance,dst_instance . Can be set only if LOGGING_METADATA is set to custom .

API

Enable VPC Flow Logs when you create a new subnet.

POST https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/regions/ REGION 
/subnetworks
{
  "logConfig": {
    "aggregationInterval": " AGGREGATION_INTERVAL 
",
    "flowSampling": SAMPLING_RATE 
,
    "filterExpr": EXPRESSION 
,
    "metadata": METADATA_SETTING 
,
    "metadataFields": METADATA_FIELDS 
,
    "enable": true
  },
  "ipCidrRange": " IP_RANGE 
",
  "network": " NETWORK_URL 
",
  "name": " SUBNET_NAME 
"
}

Replace the following:

• PROJECT_ID : the ID of the project where the subnet will be created.
• REGION : the region where the subnet will be created.
• AGGREGATION_INTERVAL : the aggregation interval for flow logs in the subnet. The interval can be set to any of the following: INTERVAL_5_SEC , INTERVAL_30_SEC , INTERVAL_1_MIN , INTERVAL_5_MIN , INTERVAL_10_MIN , or INTERVAL_15_MIN .
• SAMPLING_RATE : the flow sampling rate. Flow sampling can be set from 0.0 (no sampling) to 1.0 (all logs). Default is .0.5 .
• EXPRESSION : the filter expression you use to filter which logs are actually written. The expression has a limit of 2,048 characters. For details, see Log filtering .

• METADATA_SETTING : the metadata annotations that you want to include in the logs:

  • Use INCLUDE_ALL_METADATA to include all metadata annotations.
  • Use EXCLUDE_ALL_METADATA to exclude all metadata annotations (default).
  • Use CUSTOM_METADATA to include a custom list of metadata fields that you specify in METADATA_FIELDS .

• METADATA_FIELDS : the metadata fields you want to capture when you have set metadata: CUSTOM_METADATA . This is a comma-separated list of metadata fields, such as src_instance, src_vpc.project_id .

• IP_RANGE : the primary internal IP address range of the subnet.

• NETWORK_URL : the Virtual Private Cloud network URL where the subnet will be created.

• SUBNET_NAME : a name for the subnet.

For more information, see the subnetworks.insert method .

Terraform

You can use a Terraform module to create a custom mode VPC network and subnets.

The following example creates three subnets as follows:

• subnet-01 has VPC Flow Logs disabled. When you create a subnet, VPC Flow Logs are disabled unless you explicitly enable them.
• subnet-02 has VPC Flow Logs enabled with the default flow log settings.
• subnet-03 has VPC Flow Logs enabled with some custom settings.

 module "test-vpc-module" {
  source       = "terraform-google-modules/network/google"
  version      = "~> 12.0"
  project_id   = var.project_id # Replace this with your project ID in quotes
  network_name = "my-custom-mode-network"
  mtu          = 1460

  subnets = [
    {
      subnet_name   = "subnet-01"
      subnet_ip     = "10.10.10.0/24"
      subnet_region = "us-west1"
    },
    {
      subnet_name           = "subnet-02"
      subnet_ip             = "10.10.20.0/24"
      subnet_region         = "us-west1"
      subnet_private_access = "true"
      subnet_flow_logs      = "true"
    },
    {
      subnet_name               = "subnet-03"
      subnet_ip                 = "10.10.30.0/24"
      subnet_region             = "us-west1"
      subnet_flow_logs          = "true"
      subnet_flow_logs_interval = "INTERVAL_10_MIN"
      subnet_flow_logs_sampling = 0.7
      subnet_flow_logs_metadata = "INCLUDE_ALL_METADATA"
      subnet_flow_logs_filter   = "false"
    }
  ]
} 

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands .

Console

1. In the Google Cloud console, go to the VPC networkspage.

   Go to VPC networks

2. On the Subnets in current projecttab, select one or more subnets and then click menu Manage flow logs.

3. In menu Manage flow logs, click Add new configuration.

4. Do one of the following:

   • If you selected one subnet, in the Configurations - Subnets (Compute Engine API)section, click Add a configuration.
   • If you selected multiple subnets, in the Configure VPC Flow Logssection, select Compute Engine API.

5. Optional: Adjust the Aggregation intervaland any of the following settings in the Advanced settingssection:

   • Whether to configure log filtering. By default, Keep only logs that match a filteris deselected.
   • Whether to include metadata in the final log entries. By default, Metadata annotationsincludes all fields.
   • The Secondary sampling rate. 50% means that half of entries generated by the primary flow log sampling process are kept. The primary flow log sampling rate isn't configurable. For more information, see Log sampling and processing .

6. Click Save.

gcloud

Run the following command:

gcloud compute networks subnets update SUBNET_NAME 
\
    --enable-flow-logs \
    [--logging-aggregation-interval= AGGREGATION_INTERVAL 
] \
    [--logging-flow-sampling= SAMPLING_RATE 
] \
    [--logging-filter-expr= FILTER_EXPRESSION 
] \
    [--logging-metadata= LOGGING_METADATA 
] \
    [--logging-metadata-fields= METADATA_FIELDS 
] \
    [other flags as needed]

Replace the following:

• AGGREGATION_INTERVAL : the aggregation interval for flow logs in that subnet. The interval can be set to any of the following: 5-sec (default), 30-sec, 1-min, 5-min, 10-min, or 15-min.
• SAMPLING_RATE : the secondary flow sampling rate. Secondary flow sampling can be set from 0.0 (no sampling) to 1.0 (all logs). Default is 0.5 . For more information, see Log sampling and processing .
• FILTER_EXPRESSION : an expression that defines which logs you want to keep. The expression has a limit of 2,048 characters. For more information, see Log filtering and Examples of log filters .

• LOGGING_METADATA : the metadata annotations that you want to include in the logs:

  • Use include-all to include all metadata annotations.
  • Use exclude-all to exclude all metadata annotations (default).
  • Use custom to include a custom list of metadata fields that you specify in METADATA_FIELDS .

• METADATA_FIELDS : a comma-separated list of metadata fields you want to include in the logs. For example, src_instance,dst_instance . Can be set only if LOGGING_METADATA is set to custom .

API

Enable VPC Flow Logs for an existing subnet.

PATCH https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/regions/ REGION 
/subnetworks/ SUBNET_NAME 
{
  "logConfig": {
    "enable": true
    ...other logging fields.
  },
  "fingerprint": " SUBNET_FINGERPRINT 
"
}

Replace the following:

• PROJECT_ID : the ID of the project where the subnet is located.
• REGION : the region where the subnet is located.
• SUBNET_NAME : the name of the existing subnet.
• SUBNET_FINGERPRINT : the fingerprint ID for the existing subnet, which is provided when you describe a subnet .
• For the other logging fields, see Enabling VPC Flow Logging when you create a subnet .

For more information, see the subnetworks.patch method .

Console

1. In the Google Cloud console, go to the Interconnectpage.

   Go to Interconnect

2. In the VLAN attachmentstab, select one or more VLAN attachments and then click menu Manage flow logsin the selection bar at the top of the list.

3. In menu Manage flow logs, click Add new configuration.

4. For Name, enter a name for the new VPC Flow Logs configuration.

5. Optional: Adjust the Aggregation intervaland any of the settings in the Advanced settingssection:

   • Whether to configure log filtering. By default, Keep only logs that match a filteris deselected.
   • Whether to include metadata in the final log entries. By default, Metadata annotationsincludes all fields.
   • The Secondary sampling rate. 100% means that all entries generated by the primary flow log sampling process are kept. The primary flow log sampling rate isn't configurable. For more information, see Log sampling and processing .

6. Click Save.

gcloud

To enable VPC Flow Logs for a VLAN attachment, use the gcloud network-management vpc-flow-logs-configs create command .

You enable VPC Flow Logs by creating a VPC Flow Logs configuration. You can create the configuration with all of its parameters set to their default values, or you can customize the default values.

In the gcloud CLI, set your project to the Google Cloud project ID of the VLAN attachment and run one of the following commands:

• To create a default VPC Flow Logs configuration, run the following command:

  gcloud network-management vpc-flow-logs-configs create CONFIG_NAME 
  \
      --location=global \
      --interconnect-attachment= VLAN_ATTACHMENT 
  

• To create a custom VPC Flow Logs configuration, specify each parameter that you want to customize.

  For example, to customize the aggregation interval, filtering, secondary sampling rate, and metadata parameters when creating a VPC Flow Logs configuration, run the following command:

  gcloud network-management vpc-flow-logs-configs create CONFIG_NAME 
  \
      --location=global \
      --interconnect-attachment= VLAN_ATTACHMENT 
  \
      --aggregation-interval= AGGREGATION_INTERVAL 
  \
      --filter-expr= FILTER_EXPRESSION 
  \
      --flow-sampling= SAMPLING_RATE 
  \
      --metadata= LOGGING_METADATA 
  

  Replace the following:

  • CONFIG_NAME : a name for the configuration.
  • VLAN_ATTACHMENT : the VLAN attachment that you want to log. Must be specified in the following format: "projects/ PROJECT_ID /regions/ REGION /interconnectAttachments/ NAME " , where:
    • PROJECT_ID is the ID of the Google Cloud project that contains the VLAN attachment. The configuration must be created in this project.
    • REGION is the region of the VLAN attachment.
    • NAME is the name of the VLAN attachment.

  To set the optional parameters in a custom configuration, replace the following:

  • AGGREGATION_INTERVAL : the aggregation interval for flow logs generated by this configuration. This parameter can be set to interval-5-sec (default), interval-30-sec , interval-1-min , interval-5-min , interval-10-min , or interval-15-min .
  • FILTER_EXPRESSION : an expression that defines which logs you want to keep. The expression has a limit of 2,048 characters. For more information, see Log filtering and Examples of log filters .
  • SAMPLING_RATE : the secondary flow sampling rate. This parameter can be set from greater than 0.0 to 1.0 (all logs, default). For more information, see Log sampling and processing .
  • LOGGING_METADATA : the metadata annotations that you want to include in the logs:
    • Use include-all-metadata to include all metadata annotations (default).
    • Use exclude-all-metadata to exclude all metadata annotations.
    • Use custom-metadata to include a custom list of metadata fields. To specify the metadata fields, use the --metadata-fields flag:
      • --metadata-fields= METADATA_FIELDS : replace METADATA_FIELDS with a comma-separated list of metadata fields that you want to include in the logs. For example, src_instance,dst_instance . Can be set only if metadata is set to custom-metadata .

Terraform

You can use a Terraform module to create a VPC Flow Logs configuration for a VLAN attachment.

The following code block creates a default VPC Flow Logs configuration.

 resource "google_network_management_vpc_flow_logs_config" "vpc_flow_logs_config" {
  vpc_flow_logs_config_id = "vpcflowlogs-config"
  location                = "global"
  interconnect_attachment = google_compute_interconnect_attachment.attachment.id
} 

The preceding example assumes that the name of the google_compute_interconnect_attachment resource is attachment . For a full example of this configuration, see the terraform-docs-samples repository.

The following code block creates a VPC Flow Logs configuration where:

• The aggregation interval is set to INTERVAL_10_MIN .
• The secondary flow sampling rate is set to 0.7 .
• The metadata to include in the logs is set to INCLUDE_ALL_METADATA .
• The configuration state is set to ENABLED .

 resource "google_network_management_vpc_flow_logs_config" "vpc_flow_logs_config" {
  vpc_flow_logs_config_id = "vpcflowlogs-config"
  location                = "global"
  interconnect_attachment = google_compute_interconnect_attachment.attachment.id
  aggregation_interval    = "INTERVAL_10_MIN"
  description             = "VPC Flow Logs over an Interconnect Attachment."
  flow_sampling           = 0.7
  metadata                = "INCLUDE_ALL_METADATA"
  state                   = "ENABLED"
} 

The preceding example assumes that the name of the google_compute_interconnect_attachment resource is attachment . For a full example of this configuration, see the terraform-docs-samples repository.

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands .

API

To enable VPC Flow Logs for a VLAN attachment, use the projects.locations.vpcFlowLogsConfigs.create method .

You enable VPC Flow Logs by creating a VPC Flow Logs configuration. You can create the configuration with all of its parameters set to their default values, or you can customize the default values.

To create a default VPC Flow Logs configuration, include the following parameters in your API request:

POST https://networkmanagement.googleapis.com/v1/projects/ PROJECT_ID 
/locations/global/vpcFlowLogsConfigs?vpc_flow_logs_config_id= CONFIG_NAME 
{
  "interconnectAttachment": " VLAN_ATTACHMENT 
"
}

To create a custom VPC Flow Logs configuration, specify each parameter that you want to customize.

For example, to customize the aggregation interval, filtering, secondary sampling rate, and metadata parameters when creating a VPC Flow Logs configuration, include the following parameters in your API request:

POST https://networkmanagement.googleapis.com/v1/projects/ PROJECT_ID 
/locations/global/vpcFlowLogsConfigs?vpc_flow_logs_config_id= CONFIG_NAME 
{
  "interconnectAttachment": " VLAN_ATTACHMENT 
",
  "aggregationInterval": " AGGREGATION_INTERVAL 
",
  "filterExpr": " FILTER_EXPRESSION 
",
  "flowSampling": SAMPLING_RATE 
,
  "metadata": " LOGGING_METADATA 
"
}

Replace the following:

• PROJECT_ID : the Google Cloud project ID of the VLAN attachment.
• CONFIG_NAME : a name for the configuration.
• VLAN_ATTACHMENT : the VLAN attachment that you want to log. Must be specified in the following format: projects/ PROJECT_ID /regions/ REGION /interconnectAttachments/ NAME , where:
  • PROJECT_ID is the project ID of the VLAN attachment.
  • REGION is the region of the VLAN attachment.
  • NAME is the name of the VLAN attachment.

• AGGREGATION_INTERVAL : the aggregation interval for flow logs generated by this configuration. This parameter can be set to INTERVAL_5_SEC (default), INTERVAL_30_SEC , INTERVAL_1_MIN , INTERVAL_5_MIN , INTERVAL_10_MIN , or INTERVAL_15_MIN .
• FILTER_EXPRESSION : an expression that defines which logs you want to keep. The expression has a limit of 2,048 characters. For more information, see Log filtering .
• SAMPLING_RATE : the secondary flow sampling rate. This parameter can be set from greater than 0.0 to 1.0 (all logs, default). For more information, see Log sampling and processing .
• LOGGING_METADATA : the metadata annotations that you want to include in the logs:
  • Use INCLUDE_ALL_METADATA to include all metadata annotations (default).
  • Use EXCLUDE_ALL_METADATA to exclude all metadata annotations.
  • Use CUSTOM_METADATA to include a custom list of metadata fields. To specify the metadata fields, use the metadataFields parameter:
    • metadataFields: METADATA_FIELDS : replace METADATA_FIELDS with a comma-separated list of metadata fields that you want to include in the logs. For example, src_instance,dst_instance . Can be set only if metadata is set to CUSTOM_METADATA .

Console

1. In the Google Cloud console, go to the VPNpage.

   Go to VPN

2. In the Cloud VPN tunnelstab, select one or more Cloud VPN tunnels and then click menu Manage flow logsin the selection bar at the top of the list.

3. In menu Manage flow logs, click Add new configuration.

4. For Name, enter a name for the new VPC Flow Logs configuration.

5. Optional: Adjust the Aggregation intervaland any of the settings in the Advanced settingssection:

   • Whether to configure log filtering. By default, Keep only logs that match a filteris deselected.
   • Whether to include metadata in the final log entries. By default, Metadata annotationsincludes all fields.
   • The Secondary sampling rate. 100% means that all entries generated by the primary flow log sampling process are kept. The primary flow log sampling rate isn't configurable. For more information, see Log sampling and processing .

6. Click Save.

gcloud

To enable VPC Flow Logs for a Cloud VPN tunnel, use the gcloud network-management vpc-flow-logs-configs create command .

You enable VPC Flow Logs by creating a VPC Flow Logs configuration. You can create the configuration with all of its parameters set to their default values, or you can customize the default values.

In the gcloud CLI, set your project to the Google Cloud project ID of the Cloud VPN tunnel and run one of the following commands:

• To create a default VPC Flow Logs configuration, run the following command:

  gcloud network-management vpc-flow-logs-configs create CONFIG_NAME 
  \
      --location=global \
      --vpn-tunnel= VPN_TUNNEL 
  

• To create a custom VPC Flow Logs configuration, specify each parameter that you want to customize.

  For example, to customize the aggregation interval, filtering, secondary sampling rate, and metadata parameters when creating a VPC Flow Logs configuration, run the following command:

  gcloud network-management vpc-flow-logs-configs create CONFIG_NAME 
  \
      --location=global \
      --vpn-tunnel= VPN_TUNNEL 
  \
      --aggregation-interval= AGGREGATION_INTERVAL 
  \
      --filter-expr= FILTER_EXPRESSION 
  \
      --flow-sampling= SAMPLING_RATE 
  \
      --metadata= LOGGING_METADATA 
  

  Replace the following:

  • CONFIG_NAME : a name for the configuration.
  • VPN_TUNNEL : the Cloud VPN tunnel that you want to log. Must be specified in the following format: "projects/ PROJECT_ID /regions/ REGION /vpnTunnels/ NAME " , where:
    • PROJECT_ID is the ID of the Google Cloud project that contains the Cloud VPN tunnel. The configuration must be created in this project.
    • REGION is the region of the Cloud VPN tunnel.
    • NAME is the name of the Cloud VPN tunnel.

  To set the optional parameters in a custom configuration, replace the following:

  • AGGREGATION_INTERVAL : the aggregation interval for flow logs generated by this configuration. This parameter can be set to interval-5-sec (default), interval-30-sec , interval-1-min , interval-5-min , interval-10-min , or interval-15-min .
  • FILTER_EXPRESSION : an expression that defines which logs you want to keep. The expression has a limit of 2,048 characters. For more information, see Log filtering and Examples of log filters .
  • SAMPLING_RATE : the secondary flow sampling rate. This parameter can be set from greater than 0.0 to 1.0 (all logs, default). For more information, see Log sampling and processing .
  • LOGGING_METADATA : the metadata annotations that you want to include in the logs:
    • Use include-all-metadata to include all metadata annotations (default).
    • Use exclude-all-metadata to exclude all metadata annotations.
    • Use custom-metadata to include a custom list of metadata fields. To specify the metadata fields, use the --metadata-fields flag:
      • --metadata-fields= METADATA_FIELDS : replace METADATA_FIELDS with a comma-separated list of metadata fields that you want to include in the logs. For example, src_instance,dst_instance . Can be set only if metadata is set to custom-metadata .

Terraform

You can use a Terraform module to create a VPC Flow Logs configuration for a Cloud VPN tunnel.

The following code block creates a default VPC Flow Logs configuration.

 resource "google_network_management_vpc_flow_logs_config" "vpc_flow_logs_config" {
  vpc_flow_logs_config_id = "vpcflowlogs-config"
  location                = "global"
  vpn_tunnel              = google_compute_vpn_tunnel.tunnel.id
} 

The preceding example assumes that the name of the google_compute_vpn_tunnel resource is tunnel . For a full example of this configuration, see the terraform-docs-samples repository.

The following code block creates a VPC Flow Logs configuration where:

• The aggregation interval is set to INTERVAL_10_MIN .
• The secondary flow sampling rate is set to 0.7 .
• The metadata to include in the logs is set to INCLUDE_ALL_METADATA .
• The configuration state is set to ENABLED .

 resource "google_network_management_vpc_flow_logs_config" "vpc_flow_logs_config" {
  vpc_flow_logs_config_id = "vpcflowlogs-config"
  location                = "global"
  vpn_tunnel              = google_compute_vpn_tunnel.tunnel.id
  aggregation_interval    = "INTERVAL_10_MIN"
  description             = "VPC Flow Logs over a VPN Gateway."
  flow_sampling           = 0.7
  metadata                = "INCLUDE_ALL_METADATA"
  state                   = "ENABLED"
} 

The preceding example assumes that the name of the google_compute_vpn_tunnel resource is tunnel . For a full example of this configuration, see the terraform-docs-samples repository.

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands .

API

To enable VPC Flow Logs for a Cloud VPN tunnel, use the projects.locations.vpcFlowLogsConfigs.create method .

You enable VPC Flow Logs by creating a VPC Flow Logs configuration. You can create the configuration with all of its parameters set to their default values, or you can customize the default values.

To create a default VPC Flow Logs configuration, include the following parameters in your API request:

POST https://networkmanagement.googleapis.com/v1/projects/ PROJECT_ID 
/locations/global/vpcFlowLogsConfigs?vpc_flow_logs_config_id= CONFIG_NAME 
{
  "vpnTunnel": " VPN_TUNNEL 
"
}

To create a custom VPC Flow Logs configuration, specify each parameter that you want to customize.

For example, to customize the aggregation interval, filtering, secondary sampling rate, and metadata parameters when creating a VPC Flow Logs configuration, include the following parameters in your API request:

POST https://networkmanagement.googleapis.com/v1/projects/ PROJECT_ID 
/locations/global/vpcFlowLogsConfigs?vpc_flow_logs_config_id= CONFIG_NAME 
{
  "vpnTunnel": " VPN_TUNNEL 
",
  "aggregationInterval": " AGGREGATION_INTERVAL 
",
  "filterExpr": " FILTER_EXPRESSION 
",
  "flowSampling": SAMPLING_RATE 
,
  "metadata": " LOGGING_METADATA 
"
}

Replace the following:

• PROJECT_ID : the Google Cloud project ID of the Cloud VPN tunnel.
• CONFIG_NAME : a name for the configuration.
• VPN_TUNNEL : the Cloud VPN tunnel that you want to log. Must be specified in the following format: projects/ PROJECT_ID /regions/ REGION /vpnTunnels/ NAME , where:
  • PROJECT_ID is the project ID of the Cloud VPN tunnel.
  • REGION is the region of the Cloud VPN tunnel.
  • NAME is the name of the Cloud VPN tunnel.

• AGGREGATION_INTERVAL : the aggregation interval for flow logs generated by this configuration. This parameter can be set to INTERVAL_5_SEC (default), INTERVAL_30_SEC , INTERVAL_1_MIN , INTERVAL_5_MIN , INTERVAL_10_MIN , or INTERVAL_15_MIN .
• FILTER_EXPRESSION : an expression that defines which logs you want to keep. The expression has a limit of 2,048 characters. For more information, see Log filtering .
• SAMPLING_RATE : the secondary flow sampling rate. This parameter can be set from greater than 0.0 to 1.0 (all logs, default). For more information, see Log sampling and processing .
• LOGGING_METADATA : the metadata annotations that you want to include in the logs:
  • Use INCLUDE_ALL_METADATA to include all metadata annotations (default).
  • Use EXCLUDE_ALL_METADATA to exclude all metadata annotations.
  • Use CUSTOM_METADATA to include a custom list of metadata fields. To specify the metadata fields, use the metadataFields parameter:
    • metadataFields: METADATA_FIELDS : replace METADATA_FIELDS with a comma-separated list of metadata fields that you want to include in the logs. For example, src_instance,dst_instance . Can be set only if metadata is set to CUSTOM_METADATA .

Console

1. In the Google Cloud console, go to the VPC networkspage.

   Go to VPC networks

2. In the Networks in current projecttab, select one or more networks and then click menu Manage flow logsat the top of the list.

3. In menu Manage flow logs, click Add new configuration.

4. For Name, enter a name for the new VPC Flow Logs configuration.

5. Optional: Adjust the Aggregation intervaland any of the settings in the Advanced settingssection:

   • Whether to configure log filtering. By default, Keep only logs that match a filteris deselected.
   • Whether to include metadata in the final log entries. By default, Metadata annotationsincludes all fields.
   • The Secondary sampling rate. 100% means that all entries generated by the primary flow log sampling process are kept. The primary flow log sampling rate isn't configurable. For more information, see Log sampling and processing .

6. Click Save.

gcloud

To enable VPC Flow Logs for a VPC network, use the gcloud network-management vpc-flow-logs-configs create command .

You enable VPC Flow Logs by creating a VPC Flow Logs configuration. You can create the configuration with all of its parameters set to their default values, or you can customize the default values.

In the gcloud CLI, set your project to the Google Cloud project ID of the VPC network and run one of the following commands:

• To create a default VPC Flow Logs configuration, run the following command:

  gcloud network-management vpc-flow-logs-configs create CONFIG_NAME 
  \
      --location=global \
      --network= NETWORK 
  

• To create a custom VPC Flow Logs configuration, specify each parameter that you want to customize.

  For example, to customize the aggregation interval, filtering, secondary sampling rate, and metadata parameters when creating a VPC Flow Logs configuration, run the following command:

  gcloud network-management vpc-flow-logs-configs create CONFIG_NAME 
  \
      --location=global \
      --network= NETWORK 
  \
      --aggregation-interval= AGGREGATION_INTERVAL 
  \
      --filter-expr= FILTER_EXPRESSION 
  \
      --flow-sampling= SAMPLING_RATE 
  \
      --metadata= LOGGING_METADATA 
  

  Replace the following:

  • CONFIG_NAME : a name for the configuration.
  • NETWORK : the VPC network that you want to log. Must be specified in the following format: "projects/ PROJECT_ID /global/networks/ NAME " , where:
    • PROJECT_ID is the ID of the Google Cloud project that contains the VPC network. The configuration must be created in this project.
    • NAME is the name of the VPC network.

  To set the optional parameters in a custom configuration, replace the following:

  • AGGREGATION_INTERVAL : the aggregation interval for flow logs generated by this configuration. This parameter can be set to interval-5-sec (default), interval-30-sec , interval-1-min , interval-5-min , interval-10-min , or interval-15-min .
  • FILTER_EXPRESSION : an expression that defines which logs you want to keep. The expression has a limit of 2,048 characters. For more information, see Log filtering and Examples of log filters .
  • SAMPLING_RATE : the secondary flow sampling rate. This parameter can be set from greater than 0.0 to 1.0 (all logs, default). For more information, see Log sampling and processing .
  • LOGGING_METADATA : the metadata annotations that you want to include in the logs:
    • Use include-all-metadata to include all metadata annotations (default).
    • Use exclude-all-metadata to exclude all metadata annotations.
    • Use custom-metadata to include a custom list of metadata fields. To specify the metadata fields, use the --metadata-fields flag:
      • --metadata-fields= METADATA_FIELDS : replace METADATA_FIELDS with a comma-separated list of metadata fields that you want to include in the logs. For example, src_instance,dst_instance . Can be set only if metadata is set to custom-metadata .

API

To enable VPC Flow Logs for a VPC network, use the projects.locations.vpcFlowLogsConfigs.create method .

You enable VPC Flow Logs by creating a VPC Flow Logs configuration. You can create the configuration with all of its parameters set to their default values, or you can customize the default values.

To create a default VPC Flow Logs configuration, include the following parameters in your API request:

POST https://networkmanagement.googleapis.com/v1/projects/ PROJECT_ID 
/locations/global/vpcFlowLogsConfigs?vpc_flow_logs_config_id= CONFIG_NAME 
{
  "network": " NETWORK 
"
}

To create a custom VPC Flow Logs configuration, specify each parameter that you want to customize.

For example, to customize the aggregation interval, filtering, secondary sampling rate, and metadata parameters when creating a VPC Flow Logs configuration, include the following parameters in your API request:

POST https://networkmanagement.googleapis.com/v1/projects/ PROJECT_ID 
/locations/global/vpcFlowLogsConfigs?vpc_flow_logs_config_id= CONFIG_NAME 
{
  "network": " NETWORK 
",
  "aggregationInterval": " AGGREGATION_INTERVAL 
",
  "filterExpr": " FILTER_EXPRESSION 
",
  "flowSampling": SAMPLING_RATE 
,
  "metadata": " LOGGING_METADATA 
"
}

Replace the following:

• PROJECT_ID : the Google Cloud project ID of the VPC network.
• CONFIG_NAME : a name for the configuration.
• NETWORK : the VPC network that you want to log. Must be specified in the following format: projects/ PROJECT_ID /global/networks/ NAME , where:
  • PROJECT_ID is the project ID of the VPC network.
  • NAME is the name of the VPC network.

• AGGREGATION_INTERVAL : the aggregation interval for flow logs generated by this configuration. This parameter can be set to INTERVAL_5_SEC (default), INTERVAL_30_SEC , INTERVAL_1_MIN , INTERVAL_5_MIN , INTERVAL_10_MIN , or INTERVAL_15_MIN .
• FILTER_EXPRESSION : an expression that defines which logs you want to keep. The expression has a limit of 2,048 characters. For more information, see Log filtering .
• SAMPLING_RATE : the secondary flow sampling rate. This parameter can be set from greater than 0.0 to 1.0 (all logs, default). For more information, see Log sampling and processing .
• LOGGING_METADATA : the metadata annotations that you want to include in the logs:
  • Use INCLUDE_ALL_METADATA to include all metadata annotations (default).
  • Use EXCLUDE_ALL_METADATA to exclude all metadata annotations.
  • Use CUSTOM_METADATA to include a custom list of metadata fields. To specify the metadata fields, use the metadataFields parameter:
    • metadataFields: METADATA_FIELDS : replace METADATA_FIELDS with a comma-separated list of metadata fields that you want to include in the logs. For example, src_instance,dst_instance . Can be set only if metadata is set to CUSTOM_METADATA .

Console

1. In the Google Cloud console, go to the VPC Flow Logspage.

   Go to VPC Flow Logs

2. Click Add VPC Flow Logs configurationand then click Add a configuration for the organization.

3. For Name, enter a name for the new VPC Flow Logs configuration.

4. Optional: Adjust the Aggregation intervaland any of the settings in the Advanced settingssection:

   • Whether to configure log filtering. By default, Keep only logs that match a filteris deselected.
   • Whether to include cross-project annotations. By default, Cross-project metadata annotationsis selected. For more information, see Cross-project annotations .
   • Whether to include metadata in the final log entries. By default, Metadata annotationsincludes all fields.
   • The Secondary sampling rate. 100% means that all entries generated by the primary flow log sampling process are kept. The primary flow log sampling rate isn't configurable. For more information, see Log sampling and processing .

5. Click Save.

gcloud

To enable VPC Flow Logs for an organization, use the gcloud network-management vpc-flow-logs-configs create command .

You enable VPC Flow Logs by creating a VPC Flow Logs configuration. You can create the configuration with all of its parameters set to their default values, or you can customize the default values.

• To create a default VPC Flow Logs configuration, run the following command:

  gcloud network-management vpc-flow-logs-configs create CONFIG_NAME 
  \
      --location=global \
      --organization= ORGANIZATION 
  

• To create a custom VPC Flow Logs configuration, specify each parameter that you want to customize.

  For example, to customize the aggregation interval, filtering, secondary sampling rate, and metadata parameters when creating a VPC Flow Logs configuration, run the following command:

  gcloud network-management vpc-flow-logs-configs create CONFIG_NAME 
  \
      --location=global \
      --organization= ORGANIZATION 
  \
      --aggregation-interval= AGGREGATION_INTERVAL 
  \
      --filter-expr= FILTER_EXPRESSION 
  \
      --flow-sampling= SAMPLING_RATE 
  \
      --metadata= LOGGING_METADATA 
  \
      --cross-project-metadata= CROSS_PROJECT_METADATA 
  

  Replace the following:

  • CONFIG_NAME : a name for the configuration
  • ORGANIZATION : the ID of the organization

  To set the optional parameters in a custom configuration, replace the following:

  • AGGREGATION_INTERVAL : the aggregation interval for flow logs generated by this configuration. This parameter can be set to interval-5-sec (default), interval-30-sec , interval-1-min , interval-5-min , interval-10-min , or interval-15-min .
  • FILTER_EXPRESSION : an expression that defines which logs you want to keep. The expression has a limit of 2,048 characters. For more information, see Log filtering and Examples of log filters .
  • SAMPLING_RATE : the secondary flow sampling rate. This parameter can be set from greater than 0.0 to 1.0 (all logs, default). For more information, see Log sampling and processing .
  • LOGGING_METADATA : the metadata annotations that you want to include in the logs:
    • Use include-all-metadata to include all metadata annotations (default).
    • Use exclude-all-metadata to exclude all metadata annotations.
    • Use custom-metadata to include a custom list of metadata fields. To specify the metadata fields, use the --metadata-fields flag:
      • --metadata-fields= METADATA_FIELDS : replace METADATA_FIELDS with a comma-separated list of metadata fields that you want to include in the logs. For example, src_instance,dst_instance . Can be set only if metadata is set to custom-metadata .
  • CROSS_PROJECT_METADATA : cross-project annotations. Can be set to cross-project-metadata-enabled (default) or cross-project-metadata-disabled . For more information, see Cross-project annotations .

API

To enable VPC Flow Logs for an organization, use the organizations.locations.vpcFlowLogsConfigs.create method.

You enable VPC Flow Logs by creating a VPC Flow Logs configuration. You can create the configuration with all of its parameters set to their default values, or you can customize the default values.

To create a default VPC Flow Logs configuration, include the following parameters in your API request:

POST -H "x-goog-user-project: PROJECT_ID 
" https://networkmanagement.googleapis.com/v1/organizations/ ORGANIZATION_ID 
/locations/global/vpcFlowLogsConfigs?vpc_flow_logs_config_id= CONFIG_NAME 

To create a custom VPC Flow Logs configuration, specify each parameter that you want to customize.

For example, to customize the aggregation interval, filtering, secondary sampling rate, and metadata parameters when creating a VPC Flow Logs configuration, include the following parameters in your API request:

POST -H "x-goog-user-project: PROJECT_ID 
" https://networkmanagement.googleapis.com/v1/organizations/ ORGANIZATION_ID 
/locations/global/vpcFlowLogsConfigs?vpc_flow_logs_config_id= CONFIG_NAME 
{
  "aggregationInterval": " AGGREGATION_INTERVAL 
",
  "filterExpr": " FILTER_EXPRESSION 
",
  "flowSampling": SAMPLING_RATE 
,
  "metadata": " LOGGING_METADATA 
",
  "crossProjectMetadata": " CROSS_PROJECT_METADATA 
"
}

Replace the following:

• PROJECT_ID : the ID of the quota project. API requests are counted against this project. The quota value for the Network Management API is set to 1,200 requests per minute, for both the project- and organization-level quota.
• ORGANIZATION_ID : the ID of the organization.
• CONFIG_NAME : a name for the configuration.

• AGGREGATION_INTERVAL : the aggregation interval for flow logs generated by this configuration. This parameter can be set to INTERVAL_5_SEC (default), INTERVAL_30_SEC , INTERVAL_1_MIN , INTERVAL_5_MIN , INTERVAL_10_MIN , or INTERVAL_15_MIN .
• FILTER_EXPRESSION : an expression that defines which logs you want to keep. The expression has a limit of 2,048 characters. For more information, see Log filtering .
• SAMPLING_RATE : the secondary flow sampling rate. This parameter can be set from greater than 0.0 to 1.0 (all logs, default). For more information, see Log sampling and processing .
• LOGGING_METADATA : the metadata annotations that you want to include in the logs:
  • Use INCLUDE_ALL_METADATA to include all metadata annotations (default).
  • Use EXCLUDE_ALL_METADATA to exclude all metadata annotations.
  • Use CUSTOM_METADATA to include a custom list of metadata fields. To specify the metadata fields, use the metadataFields parameter:
    • metadataFields: METADATA_FIELDS : replace METADATA_FIELDS with a comma-separated list of metadata fields that you want to include in the logs. For example, src_instance,dst_instance . Can be set only if metadata is set to CUSTOM_METADATA .

• CROSS_PROJECT_METADATA : cross-project annotations. Can be set to CROSS_PROJECT_METADATA_ENABLED (default) or CROSS_PROJECT_METADATA_DISABLED . For more information, see Cross-project annotations .

Console

To view all VPC Flow Logs configurations, do the following:

1. In the Google Cloud console, go to the VPC Flow Logspage.

   Go to VPC Flow Logs

2. In the Organization-level configurationsand Project-level configurationssections, view your active and paused configurations. If the status of a VPC Flow Logs configuration for a resource is On, it means that logging is turned on.

You can also view VPC Flow Logs configurations in the Flow log configscolumn on the resource page. For example, to view which VPC networks and subnets have VPC Flow Logs configurations:

1. Go to the VPC networkspage.

   Go to VPC networks

2. Click the Networks in current projector Subnets in current projecttab and in the Flow log configscolumn, view your active and paused VPC Flow Logs configurations.

gcloud

To view VPC Flow Logs configurations, use the gcloud network-management vpc-flow-logs-configs list and gcloud network-management vpc-flow-logs-configs describe commands.

View organization-level configurations

• To view all VPC Flow Logs configurations for an organization, run the following command:

  gcloud network-management vpc-flow-logs-configs list --location=global \
      --organization= ORGANIZATION 
  

• To view a specific VPC Flow Logs configuration, run the following command:

  gcloud network-management vpc-flow-logs-configs describe CONFIG_NAME 
  \
      --location=global \
      --organization= ORGANIZATION 
  

  Replace the following:

  • ORGANIZATION : the ID of the organization
  • CONFIG_NAME : the name of the configuration

View project-level configurations

• To view all VPC Flow Logs configurations in a project, run the following command:

  gcloud network-management vpc-flow-logs-configs list --location=global

• To view a specific VPC Flow Logs configuration, run the following command:

  gcloud network-management vpc-flow-logs-configs describe CONFIG_NAME 
  \
      --location=global

  Replace CONFIG_NAME with the name of the VPC Flow Logs configuration that you want to view.

View all configurations for a resource

To view all VPC Flow Logs configurations for a VPC network, subnet, VLAN attachment, or a VPN tunnel, run the following command:

gcloud network-management vpc-flow-logs-configs show-effective-flow-logs-configs \
    --location=global \
    --resource= TARGET_RESOURCE 

Replace TARGET_RESOURCE with one of the following resources:

• "projects/ PROJECT_ID /regions/ REGION /subnetworks/ SUBNET " : lists all configurations for the subnet, including the following:

  • All configurations for which the subnet is the target resource
  • All configurations for the VPC network of the subnet
  • All configurations for the organization that owns the project of the subnet

  • Compute Engine API only: the VPC Flow Logs configuration for the subnet

    To identify the configuration in the output, look for "scope": "COMPUTE_API_SUBNET" . This configuration doesn't exist if you use only the Network Management API to configure VPC Flow Logs .

• "projects/ PROJECT_ID /regions/ REGION /interconnectAttachments/ VLAN_ATTACHMENT " : lists all configurations for the VLAN attachment, including the following:

  • All configurations for which the VLAN attachment is the target resource
  • All configurations for the VPC network of the VLAN attachment
  • All configurations for the organization that owns the project of the VLAN attachment

• "projects/ PROJECT_ID /regions/ REGION /vpnTunnels/ VPN_TUNNEL " : lists all configurations for the Cloud VPN tunnel, including the following:

  • All configurations for which the Cloud VPN tunnel is the target resource
  • All configurations for the VPC network of the Cloud VPN tunnel
  • All configurations for the organization that owns the project of the Cloud VPN tunnel

• "projects/ PROJECT_ID /global/networks/ NETWORK " : lists all configurations for the VPC network, including the following:

  • All configurations for which the network is the target resource
  • All configurations for the organization that owns the project of the network

When specifying the target resource, replace the following:

• PROJECT_ID : the project ID of the target resource
• REGION : the region of the target resource, if the resource is a subnet, VLAN attachment, or VPN tunnel
• SUBNET : the name of the subnet
• VLAN_ATTACHMENT : the name of the VLAN attachment
• VPN_TUNNEL : the name of the VPN tunnel
• NETWORK : the name of the network

API

View organization-level configurations

• To view all VPC Flow Logs configurations for an organization, use the organizations.locations.vpcFlowLogsConfigs.list method:

  GET -H "x-goog-user-project: PROJECT_ID 
  " https://networkmanagement.googleapis.com/v1/organizations/ ORGANIZATION_ID 
  /locations/global/vpcFlowLogsConfigs

• To view a specific VPC Flow Logs configuration for an organization, use the organizations.locations.vpcFlowLogsConfigs.get method:

  GET -H "x-goog-user-project: PROJECT_ID 
  " https://networkmanagement.googleapis.com/v1/organizations/ ORGANIZATION_ID 
  /locations/global/vpcFlowLogsConfigs/ CONFIG_NAME 
  

  Replace the following:

  • PROJECT_ID : the ID of the quota project. API requests are counted against this project.
  • ORGANIZATION_ID : the ID of the organization.
  • CONFIG_NAME : the name of the configuration.

• If you don't have the necessary permissions to perform the preceding tasks at the organization level, you can use the following request to view all VPC Flow Logs configurations for the organization of your project:

  GET https://networkmanagement.googleapis.com/v1/projects/ PROJECT_ID 
  /locations/global/vpcFlowLogsConfigs:queryOrgVpcFlowLogsConfigs

  Replace PROJECT_ID with the ID of the project.

View project-level configurations

• To view all VPC Flow Logs configurations in a project, use the projects.locations.vpcFlowLogsConfigs.list method :

  GET https://networkmanagement.googleapis.com/v1/projects/ PROJECT_ID 
  /locations/global/vpcFlowLogsConfigs

• To view a specific VPC Flow Logs configuration, use the projects.locations.vpcFlowLogsConfigs.get method :

  GET https://networkmanagement.googleapis.com/v1/projects/ PROJECT_ID 
  /locations/global/vpcFlowLogsConfigs/ CONFIG_NAME 
  

  Replace the following:

  • PROJECT_ID : the ID of the project
  • CONFIG_NAME : the name of the VPC Flow Logs configuration

View all configurations for a resource

To view all VPC Flow Logs configurations for a VPC network, subnet, VLAN attachment, or a VPN tunnel, use the following request:

GET https://networkmanagement.googleapis.com/v1/projects/ PROJECT_ID 
/locations/global/vpcFlowLogsConfigs:showEffectiveFlowLogsConfigs?resource=" TARGET_RESOURCE 
"

Replace the following:

• PROJECT_ID : the ID of the Google Cloud project

• TARGET_RESOURCE : one of the following target resources:

  • projects/ PROJECT_ID /regions/ REGION /subnetworks/ SUBNET : lists all configurations for the subnet, including the following:

    • All configurations for which the subnet is the target resource
    • All configurations for the VPC network of the subnet
    • All configurations for the organization that owns the project of the subnet

    • Compute Engine API only: the VPC Flow Logs configuration for the subnet

      To identify the configuration in the output, look for "scope": "COMPUTE_API_SUBNET" . This configuration doesn't exist if you use only the Network Management API to configure VPC Flow Logs .

  • projects/ PROJECT_ID /regions/ REGION /interconnectAttachments/ VLAN_ATTACHMENT : lists all configurations for the VLAN attachment, including the following:

    • All configurations for which the VLAN attachment is the target resource
    • All configurations for the VPC network of the VLAN attachment
    • All configurations for the organization that owns the project of the VLAN attachment

  • projects/ PROJECT_ID /regions/ REGION /vpnTunnels/ VPN_TUNNEL : lists all configurations for the Cloud VPN tunnel, including the following:

    • All configurations for which the Cloud VPN tunnel is the target resource
    • All configurations for the VPC network of the Cloud VPN tunnel
    • All configurations for the organization that owns the project of the Cloud VPN tunnel

  • projects/ PROJECT_ID /global/networks/ NETWORK : lists all configurations for the VPC network, including the following:

    • All configurations for which the network is the target resource
    • All configurations for the organization that owns the project of the network

  When specifying the target resource, replace the following:

  • PROJECT_ID : the project ID of the target resource
  • REGION : the region of the target resource, if the resource is a subnet, VLAN attachment, or VPN tunnel
  • SUBNET : the name of the subnet
  • VLAN_ATTACHMENT : the name of the VLAN attachment
  • VPN_TUNNEL : the name of the VPN tunnel
  • NETWORK : the name of the network

Console

1. In the Google Cloud console, go to the VPC Flow Logspage.

   Go to VPC Flow Logs

2. In the Project-level configurationssection, click the Subnets (Compute Engine API)tab and view which subnets in the project have VPC Flow Logs enabled.

   These configurations are managed by the Compute Engine API. Configurations that are managed by the Network Management API are displayed in the Subnetstab.

gcloud

To view which subnets in a VPC network have VPC Flow Logs enabled, run the following command:

gcloud compute networks subnets list \
    --project PROJECT_ID 
\
    --network=" NETWORK 
" \
    --format="csv(name,region,logConfig.enable)"

Replace the following:

• PROJECT_ID : the ID of the project you are querying
• NETWORK : the name of the network containing the subnets

Console

1. In the Google Cloud console, go to the VPC Flow Logspage.

   Go to VPC Flow Logs

2. In the Organization-level configurationssection, select one or more configurations that you want to update and click Edit.

3. Adjust any of the following:

   • The Aggregation interval. By default, the aggregation interval is set to 5 sec.
   • Whether to set the Statusof the VPC Flow Logs configuration to on or off. The Onstatus means that the selected VPC Flow Logs configuration is active and generates flow logs.
   • Whether to configure log filtering. By default, Keep only logs that match a filteris deselected.
   • Whether to include cross-project annotations. By default, Cross-project metadata annotationsis selected. For more information, see Cross-project annotations .
   • Whether to include metadata in the final log entries. By default, Metadata annotationsincludes all fields.
   • The Secondary sampling rate. 100% means that all entries generated by the primary flow log sampling process are kept. The primary flow log sampling rate isn't configurable. For more information, see Log sampling and processing .

4. Click Save.

gcloud

Use the gcloud network-management vpc-flow-logs-configs update command . The square brackets [] in the following commands indicate optional parameters.

To update a VPC Flow Logs configuration for an organization, run the following command:

gcloud network-management vpc-flow-logs-configs update CONFIG_NAME 
\
    --location=global \
    --organization= ORGANIZATION 
\
    [--aggregation-interval= AGGREGATION_INTERVAL 
] \
    [--filter-expr= FILTER_EXPRESSION 
] \
    [--flow-sampling= SAMPLING_RATE 
] \
    [--metadata= LOGGING_METADATA 
] \
    [--cross-project-metadata= CROSS_PROJECT_METADATA 
] \
    [--state= STATE 
]

For example, to update the aggregation interval parameter, run the following command:

gcloud network-management vpc-flow-logs-configs update CONFIG_NAME 
\
    --location=global \
    --organization= ORGANIZATION 
\
    --aggregation-interval= AGGREGATION_INTERVAL 

Replace the following:

• CONFIG_NAME : the name of the configuration that you want to update. The configuration is located in the same Google Cloud project as the resource for which the configuration is used.
• ORGANIZATION : the ID of the organization.

To update the optional parameters, replace the following:

• AGGREGATION_INTERVAL : the aggregation interval for flow logs generated by this configuration. This parameter can be set to interval-5-sec (default), interval-30-sec , interval-1-min , interval-5-min , interval-10-min , or interval-15-min .
• FILTER_EXPRESSION : an expression that defines which logs you want to keep. The expression has a limit of 2,048 characters. For more information, see Log filtering and Examples of log filters .
• SAMPLING_RATE : the secondary flow sampling rate. This parameter can be set from greater than 0.0 to 1.0 (all logs, default). For more information, see Log sampling and processing .
• LOGGING_METADATA : the metadata annotations that you want to include in the logs:
  • Use include-all-metadata to include all metadata annotations (default).
  • Use exclude-all-metadata to exclude all metadata annotations.
  • Use custom-metadata to include a custom list of metadata fields. To specify the metadata fields, use the --metadata-fields flag:
    • --metadata-fields= METADATA_FIELDS : replace METADATA_FIELDS with a comma-separated list of metadata fields that you want to include in the logs. For example, src_instance,dst_instance . Can be set only if metadata is set to custom-metadata .
• CROSS_PROJECT_METADATA : cross-project annotations. Can be set to cross-project-metadata-enabled (default) or cross-project-metadata-disabled . For more information, see Cross-project annotations .
• STATE : the state of the configuration. Can be enabled (default) or disabled .

API

Use the organizations.locations.vpcFlowLogsConfigs.patch method. For information about the fields that you can modify, see REST Resource: projects.locations.vpcFlowLogsConfigs .

To update a VPC Flow Logs configuration for an organization, include the following parameters in your API request:

PATCH -H "x-goog-user-project: PROJECT_ID 
" https://networkmanagement.googleapis.com/v1/organizations/ ORGANIZATION_ID 
/locations/global/vpcFlowLogsConfigs/ CONFIG_NAME 
?updateMask= FIELDS 
{
  ...fields to modify
}

Replace the following:

• PROJECT_ID : the ID of the quota project. API requests are counted against this project. The quota value for the Network Management API is set to 1,200 requests per minute, for both the project- and organization-level quota.
• ORGANIZATION_ID : the ID of the organization for which the configuration is used.
• CONFIG_NAME : the name of the configuration that you want to update.
• FIELDS : the name of the field or fields that you want to update, comma-separated—for example, aggregationInterval,flowSampling,metadata .

For example, to update the aggregationInterval field for a configuration my-config in my-organization , use the following API request:

PATCH -H "x-goog-user-project: PROJECT_ID 
" https://networkmanagement.googleapis.com/v1/organizations/my-organization/locations/global/vpcFlowLogsConfigs/my-config?updateMask=aggregationInterval
{
  aggregationInterval: AGGREGATION_INTERVAL 
}

Replace the following:

• PROJECT_ID : the ID of the quota project. API requests are counted against this project.
• AGGREGATION_INTERVAL with any of the supported values for this parameter.

Console

1. In the Google Cloud console, go to the VPC Flow Logspage.

   Go to VPC Flow Logs

2. In the Project-level configurationssection, select one or more configurations that you want to update and click Edit.

3. Adjust any of the following:

   • The Aggregation interval. By default, the aggregation interval is set to 5 sec.
   • Whether to set the Statusof the VPC Flow Logs configuration to on or off. The Onstatus means that the selected VPC Flow Logs configuration is active and generates flow logs.
   • Whether to configure log filtering. By default, Keep only logs that match a filteris deselected.
   • Whether to include metadata in the final log entries. By default, Metadata annotationsincludes all fields.
   • The Secondary sampling rate. 100% means that all entries generated by the primary flow log sampling process are kept. The primary flow log sampling rate isn't configurable. For more information, see Log sampling and processing .

4. Click Save.

You can also use the menu Manage flow logsmenu in the following locations to edit your VPC Flow Logs configurations:

• The Networks in current projectand Subnets in current projecttabs on the VPC networks page
• The VLAN attachmentstab on the Interconnect page
• The VPN tunnelstab on the VPN page

gcloud

Use the gcloud network-management vpc-flow-logs-configs update command . The square brackets [] in the following command indicate optional parameters.

gcloud network-management vpc-flow-logs-configs update CONFIG_NAME 
\
    --location=global \
    [--network= NETWORK 
| --subnet= SUBNET 
| --interconnect-attachment= VLAN_ATTACHMENT 
| --vpn-tunnel= VPN_TUNNEL 
] \
    [--aggregation-interval= AGGREGATION_INTERVAL 
] \
    [--filter-expr= FILTER_EXPRESSION 
] \
    [--flow-sampling= SAMPLING_RATE 
] \
    [--metadata= LOGGING_METADATA 
] \
    [--state= STATE 
]

For example, to update the aggregation interval parameter, run the following command:

gcloud network-management vpc-flow-logs-configs update CONFIG_NAME 
\
    --location=global \
    --aggregation-interval= AGGREGATION_INTERVAL 

Replace the following:

• CONFIG_NAME : the name of the configuration that you want to update. The configuration is located in the same Google Cloud project as the resource for which the configuration is used.

To update the optional parameters, replace the following:

• NETWORK , SUBNET , VLAN_ATTACHMENT , or VPN_TUNNEL : the name of the target resource. Only one resource can be specified per configuration. Use this option to update the name of the target resource. Must be specified in the following format:
  • VPC network: projects/ PROJECT_ID /global/networks/ NAME
  • Subnet: projects/ PROJECT_ID /regions/ REGION /subnetworks/ NAME
  • VLAN attachment: projects/ PROJECT_ID /regions/ REGION /interconnectAttachments/ NAME
  • Cloud VPN tunnel: projects/ PROJECT_ID /regions/ REGION /vpnTunnels/ NAME
  • Replace the following:
    • PROJECT_ID : the ID of the Google Cloud project that contains the resource.
    • REGION : the region of the resource.
    • NAME : the name of the resource.
• AGGREGATION_INTERVAL : the aggregation interval for flow logs generated by this configuration. This parameter can be set to interval-5-sec (default), interval-30-sec , interval-1-min , interval-5-min , interval-10-min , or interval-15-min .
• FILTER_EXPRESSION : an expression that defines which logs you want to keep. The expression has a limit of 2,048 characters. For more information, see Log filtering and Examples of log filters .
• SAMPLING_RATE : the secondary flow sampling rate. This parameter can be set from greater than 0.0 to 1.0 (all logs, default). For more information, see Log sampling and processing .
• LOGGING_METADATA : the metadata annotations that you want to include in the logs:
  • Use include-all-metadata to include all metadata annotations (default).
  • Use exclude-all-metadata to exclude all metadata annotations.
  • Use custom-metadata to include a custom list of metadata fields. To specify the metadata fields, use the --metadata-fields flag:
    • --metadata-fields= METADATA_FIELDS : replace METADATA_FIELDS with a comma-separated list of metadata fields that you want to include in the logs. For example, src_instance,dst_instance . Can be set only if metadata is set to custom-metadata .
• STATE : the state of the configuration. Can be enabled (default) or disabled .

API

Use the projects.locations.vpcFlowLogsConfigs.patch method . For information about the fields that you can modify, see REST Resource: projects.locations.vpcFlowLogsConfigs .

To update a VPC Flow Logs configuration, include the following parameters in your API request:

PATCH https://networkmanagement.googleapis.com/v1/projects/ PROJECT_ID 
/locations/global/vpcFlowLogsConfigs/ CONFIG_NAME 
?updateMask= FIELDS 
{
  ...fields to modify
}

Replace the following:

• PROJECT_ID : the ID of the Google Cloud project that contains the VPC Flow Logs configuration. This ID is the same as the project ID of the resource for which the configuration is used.
• CONFIG_NAME : the name of the configuration that you want to update.
• FIELDS : the name of the field or fields that you want to update, comma-separated—for example, aggregationInterval,flowSampling,metadata .

For example, to update the aggregationInterval field for a configuration my-config in my-project , use the following API request:

PATCH https://networkmanagement.googleapis.com/v1/projects/my-project/locations/global/vpcFlowLogsConfigs/my-config?updateMask=aggregationInterval
{
  aggregationInterval: AGGREGATION_INTERVAL 
}

Replace AGGREGATION_INTERVAL with any of the supported values for this parameter.

Console

1. In the Google Cloud console, go to the VPC networkspage.

   Go to VPC networks

2. Under Subnets in current project, click the subnet that you want to update.

3. Click Edit.

4. Optional: Adjust any of the following settings:

   • The Aggregation interval. By default, the aggregation interval is set to 5 sec.
   • Whether to configure log filtering. By default, Keep only logs that match a filteris deselected.
   • Whether to include metadata in the final log entries. By default, Metadata annotationsincludes all fields.
   • The Secondary sampling rate. 50% means that half of entries generated by the primary flow log sampling process are kept. The primary flow log sampling rate isn't configurable. For more information, see Log sampling and processing .

5. Click Save.

Alternatively, you can update your VPC Flow Logs configuration parameters by using the menu Manage flow logsmenu under Subnets in current projecton the VPC networks page.

gcloud

Run the following command:

gcloud compute networks subnets update SUBNET_NAME 
\
    [--logging-aggregation-interval= AGGREGATION_INTERVAL 
] \
    [--logging-flow-sampling= SAMPLING_RATE 
] \
    [--logging-filter-expr= FILTER_EXPRESSION 
] \
    [--logging-metadata= LOGGING_METADATA 
] \
    [--logging-metadata-fields= METADATA_FIELDS 
] \

Replace the following:

• AGGREGATION_INTERVAL : the aggregation interval for flow logs in that subnet. The interval can be set to any of the following: 5-sec (default), 30-sec, 1-min, 5-min, 10-min, or 15-min.
• SAMPLING_RATE : the secondary flow sampling rate. Secondary flow sampling can be set from 0.0 (no sampling) to 1.0 (all logs). Default is 0.5 . For more information, see Log sampling and processing .
• FILTER_EXPRESSION : an expression that defines what logs you want to keep. The expression has a limit of 2,048 characters. For more information, see Log filtering and Examples of log filters .

• LOGGING_METADATA : the metadata annotations that you want to include in the logs:

  • Use include-all to include all metadata annotations.
  • Use exclude-all to exclude all metadata annotations (default).
  • Use custom to include a custom list of metadata fields that you specify in METADATA_FIELDS .

• METADATA_FIELDS : a comma-separated list of metadata fields you want to include in the logs. For example, src_instance,dst_instance . Can be set only if LOGGING_METADATA is set to custom .

API

Modify the log sampling fields to update VPC Flow Logs behaviors.

PATCH https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/regions/ REGION 
/subnetworks/ SUBNET_NAME 
{
  "logConfig": {
    ...fields to modify
  },
  "fingerprint": " SUBNET_FINGERPRINT 
"
}

Replace the following:

• PROJECT_ID : the ID of the project where the subnet is located.
• REGION : the region where the subnet is located.
• SUBNET_NAME : the name of the existing subnet.
• SUBNET_FINGERPRINT : the fingerprint ID for the existing subnet, which is provided when you describe a subnet .
• For the fields that you can modify, see Enable VPC Flow Logs when you create a subnet .

For more information, see the subnetworks.patch method .

Console

1. In the Google Cloud console, go to the VPC Flow Logspage.

   Go to VPC Flow Logs

2. In the Organization-level configurationsor Project-level configurationssections, select one or more VPC Flow Logs configurations that you want to turn off and change the configuration status to Turn off.

   If your selection includes both active and inactive configurations, in the Change configuration statusmenu, click Turn all off.

gcloud

To pause logs collection for a VPC Flow Logs configuration, use the gcloud network-management vpc-flow-logs-configs update command .

Pause an organization-level configuration

gcloud network-management vpc-flow-logs-configs update CONFIG_NAME 
\
    --location=global \
    --organization= ORGANIZATION 
\
    --state=disabled

Replace the following:

• CONFIG_NAME : the name of the configuration
• ORGANIZATION : the ID of the organization

Pause a project-level configuration

gcloud network-management vpc-flow-logs-configs update CONFIG_NAME 
\
    --location=global \
    --state=disabled

Replace CONFIG_NAME with the name of the configuration.

API

Pause an organization-level configuration

To pause logs collection, use the organizations.locations.vpcFlowLogsConfigs.patch method.

PATCH -H "x-goog-user-project: PROJECT_ID 
" https://networkmanagement.googleapis.com/v1/organizations/ ORGANIZATION_ID 
/locations/global/vpcFlowLogsConfigs/ CONFIG_NAME 
?updateMask=state
{
  "state": "DISABLED"
}

Replace the following:

• PROJECT_ID : the ID of the quota project. API requests are counted against this project.
• ORGANIZATION_ID : the ID of the organization.
• CONFIG_NAME : the name of the configuration.

Pause a project-level configuration

To pause logs collection, use the projects.locations.vpcFlowLogsConfigs.patch method .

PATCH https://networkmanagement.googleapis.com/v1/projects/ PROJECT_ID 
/locations/global/vpcFlowLogsConfigs/ CONFIG_NAME 
?updateMask=state
{
  "state": "DISABLED"
}

Replace the following:

• PROJECT_ID : the ID of the Google Cloud project that contains the configuration. This ID is the same as the project ID of the resource for which the configuration is used.
• CONFIG_NAME : the name of the configuration.

Console

1. In the Google Cloud console, go to the VPC Flow Logspage.

   Go to VPC Flow Logs

2. In the Organization-level configurationsor Project-level configurationssections, select one or more VPC Flow Logs configurations that you want to delete and click Delete.

gcloud

To delete a VPC Flow Logs configuration, use the gcloud network-management vpc-flow-logs-configs delete command .

Delete an organization-level configuration

gcloud network-management vpc-flow-logs-configs delete CONFIG_NAME 
\
    --location=global \
    --organization= ORGANIZATION 

Replace the following:

• CONFIG_NAME : the name of the configuration
• ORGANIZATION : the ID of the organization

Delete a project-level configuration

gcloud network-management vpc-flow-logs-configs delete CONFIG_NAME 
\
    --location=global

Replace CONFIG_NAME with the name of the configuration that you want to delete.

API

Delete an organization-level configuration

To delete a VPC Flow Logs configuration, use the organizations.locations.vpcFlowLogsConfigs.delete method.

DELETE -H "x-goog-user-project: PROJECT_ID 
" https://networkmanagement.googleapis.com/v1/organizations/ ORGANIZATION_ID 
/locations/global/vpcFlowLogsConfigs/ CONFIG_NAME 

Replace the following:

• PROJECT_ID : the ID of the quota project. API requests are counted against this project.
• ORGANIZATION_ID : the ID of the organization.
• CONFIG_NAME : the name of the configuration.

Delete a project-level configuration

To delete a VPC Flow Logs configuration, use the projects.locations.vpcFlowLogsConfigs.delete method .

DELETE https://networkmanagement.googleapis.com/v1/projects/ PROJECT_ID 
/locations/global/vpcFlowLogsConfigs/ CONFIG_NAME 

Replace the following:

• PROJECT_ID : the ID of the Google Cloud project that contains the configuration
• CONFIG_NAME : the name of the configuration

Console

1. In the Google Cloud console, go to the VPC networkspage.

   Go to VPC networks

2. Click the subnet that you want to update.

3. Click Edit.

4. For Flow logs, select Off.

5. Click Save.

gcloud

Run the following command:

gcloud compute networks subnets update SUBNET_NAME 
\
    --no-enable-flow-logs

API

Disable VPC Flow Logs on a subnet to stop collecting log records.

PATCH https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/regions/ REGION 
/subnetworks/ SUBNET_NAME 
{
  "logConfig": {
    "enable": false
  },
  "fingerprint": " SUBNET_FINGERPRINT 
"
}

Replace the following:

• PROJECT_ID : the ID of the project where the subnet is located
• REGION : the region where the subnet is located
• SUBNET_NAME : the name of the existing subnet
• SUBNET_FINGERPRINT : the fingerprint ID for the existing subnet, which is provided when you describe a subnet

For more information, see the subnetworks.patch method .