View group membership event logs for ULL Multicast

Private Preview — ULL Solution

This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

ULL Solution is available only to approved exchange operators and their exchange participants. If you are an approved exchange participant, contact [e-mail] to request access.

This page provides information about the logs that are available for monitoring multicast group membership events, such as IGMP joins, and describes how to enable and view them.

You can use these logs to help you understand activity in a multicast group, such as when a multicast consumer joined and when they left, or how many multicast consumers are in a group.

About group membership event logs

Google Cloud writes group membership event logs for multicast to Cloud Logging.

This table provides a summary of the logs that are available for each resource type, including the project that receives logs. For more information about the events that are logged and the log format, see the following sections.

Resource	Description of logs
Multicast group consumer activation	Group membership event logs for multicast consumers in a specific multicast consumer VPC network that is activated for a group range and zone. These logs are available in projects that contain multicast consumer configurations and their corresponding multicast consumer network. If you are using Shared VPC, this is the host project. See Enable logging for a multicast group consumer activation.

Logged events

This section describes the group membership events that are logged for multicast in Cloud Logging.

When a multicast consumer sends an IGMP membership report to join a group, the resulting log messages are as follows:

• A successful IGMP join results in two log messages: an IGMP join request received message followed by IGMP consumer joined.
• For a multicast consumer that has already joined a group successfully, a keepalive IGMP join request in a single IGMP join request received message.

For a full list of logged events and their descriptions, see the following table.

Event	Description
IGMP join request received	The Google Cloud control plane received the join request. This message doesn't confirm that the join has completed successfully. Each join request is logged, including keepalive requests that multicast consumers send periodically as part of the IGMP protocol.
IGMP consumer joined	The Google Cloud control plane successfully added the multicast consumer to the group. After this event has propagated to the multicast infrastructure for the domain, the multicast consumer begins receiving multicast traffic. This event is always preceded by an IGMP join request received event.
IGMP consumer left	The Google Cloud control plane received an explicit IGMP leave request from the multicast consumer and applied the request.
IGMP consumer timed out	The Google Cloud control plane removed the multicast consumer from the group because the multicast consumer stopped responding with keepalive requests.
IGMP entitlement rejected	The Google Cloud control plane received the join request, but rejected the request because the required multicast consumer configuration is not complete, such as in the following cases: The multicast consumer VPC network configuration isn't complete. The multicast consumer VPC network configuration hasn't propagated to the multicast infrastructure for the domain. The multicast consumer isn't configured for IGMP. This event is only available in the logs for the multicast group consumer activation resource.

Log format for multicast group consumer activations

This section describes the format of group membership event logs that are available in projects that contain multicast consumer configurations.

These logs are written for membership events for multicast consumers in a given VPC network that is activated for a multicast group range and zone. You can configure logging on the zonal multicast group consumer activation resource as described in Enable logging for a multicast group consumer activation.

The Cloud Logging monitored resource type and log name are as follows:

• Resource type: networkservices.googleapis.com/MulticastGroupConsumerActivation
• Log name: networkservices.googleapis.com%2Fmulticast_memberships

The log includes the following fields:

Field	Type	Description
consumerIp	string	The primary internal IPv4 address of the multicast consumer. Example: 10.0.0.1.
consumerLocation	string	The zone of the multicast consumer. Example: us-east5-a.
consumerNetwork	Resource	The multicast consumer VPC network. Example: consumerNetwork { name: "my-network" id: "1234" }
consumerProject	Project	The project that contains the multicast consumer VPC network. Example: consumerProject { id: "my-project" number: "5678" }
consumerResource	Resource	The multicast consumer VM instance. Example: consumerResource { name: "my-instance" id: "1111" }
consumerResourceProject	Project	The project that contains the multicast consumer VM instance. This can be different from the project that contains the multicast consumer VPC network, such as when using Shared VPC. Example: consumerResourceProject { id: "my-instance-project" number: "4321" }
eventDescription	string	One of the events described in Logged events. Example: IGMP consumer joined.
eventTime	string	The timestamp of the event in RFC 3339 text format. Example: 2024-10-21T06:46:42.990162973Z.
multicastConsumerAssociation	string	The name of the multicast consumer association between the multicast consumer VPC network and the domain. Example: my-consumer-association-name.
multicastGroupConsumerActivation	string	The name of the multicast group consumer activation. Example: my-group-consumer-activation-name.
multicastIp	string	The IP address of the multicast group. Example: 224.0.0.1.

Unlike the multicast group range logs, the multicast group consumer activation logs use string IDs for the project and network because the logs are only available to the project that contains the multicast consumer configurations.

Field format reference

Project

Field	Type	Description
number	string (uint64)	The automatically generated integer ID of the project. Example: 5678.
id	string	The user-assigned ID of the project. Example: my-project.

Resource

Field	Type	Description
id	string (uint64)	The automatically generated integer ID of the resource. Example: 1111.
name	string	The user-assigned name of the resource. Example: my-instance.

Enable group membership event logging

The following sections describe how to enable group membership event logging.

Enable logging for a multicast group consumer activation

This section describes how a multicast consumer network administrator can configure group membership event logging for their VPC network.

For a given VPC network that you enabled to consume multicast traffic, you can configure membership event logging on the corresponding multicast group consumer activation.

For more information about configuring logging when creating a new multicast group consumer activation, see Enable a VPC network to consume multicast traffic. Membership event logging is not enabled by default.

Permissions required for this task

To perform this task, you must have been granted the following permissions or one of the following IAM roles.

Permissions

• networkservices.multicastGroupConsumerActivations.update

Roles

• Multicast Admin (roles/compute.multicastAdmin)

gcloud

To enable or disable logging for a multicast group consumer activation, use the network-services multicast-group-consumer-activations update command.

  gcloud network-services multicast-group-consumer-activations update GROUP_CONSUMER_ACTIVATION_NAME \
      --location=ZONE \
      [--enable-logging | --no-enable-logging]

Replace the following:

• GROUP_CONSUMER_ACTIVATION_NAME: the name of the multicast group consumer activation
• ZONE: the zone of the multicast group consumer activation
• --[no-]enable-logging: determines whether membership event logging is enabled.
  • To enable logging, use --enable-logging.
  • To disable logging, use --no-enable-logging.

API

To enable or disable logging for a multicast group consumer activation, use the multicastGroupConsumerActivations.patch method.

  PATCH https://networkservices.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/multicastGroupConsumerActivations/GROUP_CONSUMER_ACTIVATION_NAME?updateMask=logConfig
  {
    "logConfig": {"enabled": "LOGGING_ENABLED"}
  }

Replace the following:

• PROJECT_ID: The ID of the project
• GROUP_CONSUMER_ACTIVATION_NAME: the name of the multicast group consumer activation
• ZONE: the zone of the multicast group consumer activation
• LOGGING_ENABLED: specifies whether membership event logging is enabled.
  • To enable logging, set to true.
  • To disable logging, set to false.

View group membership event logs

This section describes how to view group membership event logs for multicast.

For more information, see the Logs Explorer overview.

Console

1. In the Google Cloud console, go to the Logs Explorer page:

   Go to Logs Explorer

2. To see multicast group membership event logs, select one of the following monitored resource types from the All resources list:
   • If you are a multicast consumer VPC network administrator and you want to see group membership event logs for your network, then select Multicast Group Consumer Activation.