Exporter des messages Pub/Sub Lite vers Pub/Sub

Ce document explique comment configurer l'exportation automatique de Messages Pub/Sub Lite vers Pub/Sub.

Voici quelques situations dans lesquelles vous pourriez utiliser cette fonctionnalité:

  • Interopérabilité entre les charges de travail qui utilisent une combinaison de Pub/Sub Lite et Pub/Sub.
  • Migrer une charge de travail Pub/Sub Lite vers Pub/Sub
  • utiliser des fonctionnalités Pub/Sub avancées, telles que les abonnements push et à partir d'une application existante basée sur Pub/Sub Lite.
  • Consolider plusieurs pipelines de données

Présentation

Pour exporter des messages de Pub/Sub Lite vers Pub/Sub, vous créez un type d'abonnement spécial appelé abonnement d'exportation. Une exporte l'abonnement reçoit les messages d'un sujet Lite, les convertit en des messages Pub/Sub et envoie les messages convertis à un sujet Pub/Sub de destination.

Schéma de l'exportation de messages Pub/Sub Lite

Un sujet Lite peut combiner à la fois des abonnements d'exportation et des abonnements. Les deux types d'abonnements sont identiques en termes de utilisation du quota débit de réservation. Un abonnement d'exportation utilise la capacité de débit de l'abonnement Lite et est facturé Débit de publication Pub/Sub.

Un abonnement d'exportation connecte un sujet Lite à un seul sujet sujet Pub/Sub. Toutefois, un sujet Lite peut avoir plusieurs exportations Abonnements qui se connectent à différents sujets Pub/Sub (architecture ramifiée). Vous pouvez également exporter plusieurs sujets Lite vers sujet Pub/Sub (architecture en distribution unique).

Authentification

Un abonnement d'exportation accède à la fois à Pub/Sub Lite et aux ressources Pub/Sub. Pour créer un abonnement d'exportation, vous avez besoin du les autorisations suivantes:

  • pubsublite.subscriptions.create Les rôles prédéfinis suivants contiennent autorisation:

    • roles/pubsublite.admin
    • roles/pubsublite.editor

    Consultez la page Contrôle des accès pour Pub/Sub Lite.

  • pubsub.topics.get Les rôles prédéfinis suivants contiennent cette autorisation:

    • roles/pubsub.admin
    • roles/pubsub.editor
    • roles/pubsub.viewer

    Consultez la page Contrôle des accès pour Pub/Sub.

Agents de service

Un abonnement d'exportation publie des messages dans un sujet Pub/Sub au nom de l'utilisateur. Pour ce faire, il utilise un agent de service.

Après avoir créé le premier abonnement d'exportation dans un projet, L'agent de service Pub/Sub Lite est créé automatiquement. Si vous d'autres abonnements d'exportation dans le même projet, ils utilisent le même un agent de service Google Cloud. Le schéma de nommage de l'agent de service est le suivant: service-<your_project_number>@gcp-sa-pubsublite.iam.gserviceaccount.com

L'agent de service est créé et dispose des autorisations nécessaires pour publier des sujets Pub/Sub et Pub/Sub Lite au sein du même en tant qu'abonnement d'exportation. Si votre service Pub/Sub de destination se trouve dans un projet différent de celui de l'abonnement d'exportation, vous devez accorder Autorisations supplémentaires pour l'agent de service en ajoutant le rôle Éditeur Pub/Sub (roles/pubsub.publisher). Vous pouvez accorder des autorisations pour l'intégralité d'un projet sur un sujet particulier. Nous vous recommandons d'accorder des autorisations au niveau du sujet, en suivant le principe du moindre privilège.

Pour en savoir plus, consultez Contrôler les accès via la console Google Cloud Vous pouvez également utiliser gcloud projects add-iam-policy-binding pour ajouter des rôles IAM:

gcloud pubsub topics add-iam-policy-binding TOPIC_NAME \
 --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsublite.iam.gserviceaccount.com
 --role=roles/pubsub.publisher

Remplacez les éléments suivants :

  • TOPIC_NAME: nom de l'instance Pub/Sub de destination pour ajouter la liaison de stratégie IAM.
  • PROJECT_NUMBER: numéro du projet Projet de l'abonnement à l'exportation Pub/Sub Lite.

Créer un abonnement d'exportation

Vous pouvez créer un abonnement d'exportation Lite à l'aide de la console Google Cloud, Google Cloud CLI ou l'API Pub/Sub Lite.

Un abonnement à une exportation Lite doit se trouver dans le même projet et le même emplacement que l'abonnement Lite sujet auquel elle est associée. Pour créer le sujet Lite, consultez Créer et gérer des sujets Lite

Si vous associez un abonnement d'exportation à un sujet Lite, assurez-vous que tous les les messages publiés dans le sujet Lite sont compatibles avec Pub/Sub. Pour en savoir plus, consultez Compatibilité des messages.

Une fois créé, un abonnement d'exportation ne peut plus être un abonnement standard, ou inversement.

Console

  1. Accédez à la page Abonnements Lite.

    Accéder aux abonnements Lite

  2. Cliquez sur Créer un abonnement Lite.

  3. Saisissez un ID d'abonnement Lite.

  4. Sélectionnez un sujet Lite pour recevoir des messages de celui-ci.

  5. Sélectionnez Distribuer les messages immédiatement ou Distribuer les messages après le stockées.

  6. Choisissez un type de Décalage de départ.

  7. Sélectionnez Export to Pub/Sub topic (Exporter vers un sujet Pub/Sub).

  8. Dans la liste Sujet de destination, choisissez un sujet Pub/Sub à recevoir les messages Lite exportés.

  9. Facultatif. Spécifiez une lettre morte.

    1. Cochez la case Activer la gestion des lettres mortes.
    2. Sélectionnez un sujet Lite à utiliser comme file d'attente de lettres mortes ou cliquez sur Créer Sujet Lite pour créer un file d'attente de lettres mortes. Le file d'attente de lettres mortes doit se trouver dans le même emplacement (zone ou région) et le même projet que l'exportation abonnement.

  10. Cliquez sur Créer.

gcloud

Pour créer un abonnement d'exportation, utilisez la gcloud pubsub lite-subscriptions create commande:

gcloud pubsub lite-subscriptions create SUBSCRIPTION_ID \
  --location=LOCATION \
  --topic=TOPIC_ID \
  --export-pubsub-topic=PUBSUB_TOPIC_NAME \
  --export-dead-letter-topic=DEAD_LETTER_TOPIC_ID \
  --export-desired-state=DESIRED_STATE

Remplacez les éléments suivants :

  • SUBSCRIPTION_ID: ID de l'abonnement Lite à créer.
  • LOCATION: emplacement de l'environnement Lite abonnement.
  • TOPIC_ID: ID du sujet Lite à associer à Lite abonnement.
  • PUBSUB_TOPIC_NAME: nom du sujet Pub/Sub à vers lequel exporter. Indiquez le nom complet si le sujet se trouve dans un autre projet: projects/my-project-id/topics/my-topic-id.
  • DEAD_LETTER_TOPIC_ID : facultatif. ID d'un sujet Lite à utiliser comme lettres mortes. La file d'attente de lettres mortes doit être en au même emplacement (zone ou région) et au même projet que l'abonnement d'exportation.
  • DESIRED_STATE : facultatif. État de départ de l'abonnement. Les valeurs suivantes sont acceptées:
    • active: l'abonnement exporte les messages Lite vers Pub/Sub. (Par défaut.)
    • paused: l'exportation des messages Lite est suspendue.

Si la requête aboutit, la ligne de commande affiche une confirmation :

Created [SUBSCRIPTION_ID].

Protocole

Pour créer un abonnement d'exportation Lite, envoyez une requête POST comme suivantes:

POST https://REGION-pubsublite.googleapis.com/v1/admin/projects/PROJECT_NUMBER/locations/LOCATION/subscriptions/SUBSCRIPTION_ID
Authorization: Bearer $(gcloud auth print-access-token)

Remplacez les éléments suivants :

  • REGION: région dans laquelle stocker l'abonnement Lite.
  • PROJECT_NUMBER: numéro du projet dans lequel créer le Abonnement Lite activé.
  • LOCATION: nom d'un emplacement utilisé par Pub/Sub Lite compatibles.
  • SUBSCRIPTION_ID: ID de l'abonnement Lite.

Spécifiez les champs suivants dans le corps de la requête :

{
  "topic": "projects/PROJECT_NUMBER/locations/LOCATION/topics/TOPIC_ID",
  "deliveryConfig": {
      "deliveryRequirement": "DELIVERY_REQUIREMENT",
  },
  "exportConfig": {
      "desiredState": "DESIRED_STATE",
      "deadLetterTopic": "projects/PROJECT_NUMBER/locations/LOCATION/topics/DEAD_LETTER_TOPIC_ID",
      "pubsubConfig": {
          "topic": "PUBSUB_TOPIC_NAME"
      }
  }
}

Remplacez les éléments suivants :

  • DELIVERY_REQUIREMENT: exigence de livraison, soit DELIVER_AFTER_STORED ou DELIVER_IMMEDIATELY.
  • DESIRED_STATE: état de départ de l'abonnement. La les valeurs suivantes sont acceptées:
    • ACTIVE: l'abonnement exporte les messages Lite vers Pub/Sub.
    • PAUSED: l'exportation des messages Lite est suspendue.
  • DEAD_LETTER_TOPIC_ID: ID d'un sujet Lite existant à utiliser sous forme de lettre morte. Ce sujet doit se trouver dans le même emplacement (zone ou région) et le projet comme abonnement d'exportation lui-même.
  • PUBSUB_TOPIC_NAME: nom du sujet Pub/Sub à vers lequel exporter. Exemple de format: projects/my-project-id/topics/my-topic-id.

Si la requête aboutit, la réponse est l'abonnement Lite au format JSON :

{
  "deliveryConfig": {
      "deliveryRequirement": "DELIVERY_REQUIREMENT",
  },
  "exportConfig": {
      "desiredState": "DESIRED_STATE",
      "deadLetterTopic": "projects/PROJECT_NUMBER/locations/LOCATION/topics/DEAD_LETTER_TOPIC_ID",
      "pubsubConfig": {
          "topic": "PUBSUB_TOPIC_NAME"
      },
  "name": "projects/PROJECT_NUMBER/locations/LOCATION/subscriptions/SUBSCRIPTION_ID",
  "topic": "projects/PROJECT_NUMBER/locations/LOCATION/topics/TOPIC_ID",
}

Go

Avant d'essayer cet exemple, suivez les instructions d'installation dans le langage Go qui se trouvent sur la page Démarrage rapide : utiliser des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence sur l'API Pub/Sub pour Go. 

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/pubsublite"
)

func createPubsubExportSubscription(w io.Writer, projectID, region, location, topicID, subID, pubsubTopicID string) error {
	// projectID := "my-project-id"
	// region := "us-central1"
	// NOTE: location can be either a region ("us-central1") or a zone ("us-central1-a")
	// For a list of valid locations, see https://cloud.google.com/pubsub/lite/docs/locations.
	// location := "us-central1"
	// NOTE: topic and subscription must be in the same region/zone (e.g. "us-central1-a")
	// topicID := "my-topic"
	// subID := "my-subscription"
	// pubsubTopicID := "destination-topic-id"
	ctx := context.Background()
	client, err := pubsublite.NewAdminClient(ctx, region)
	if err != nil {
		return fmt.Errorf("pubsublite.NewAdminClient: %w", err)
	}
	defer client.Close()

	// Initialize the subscription to the oldest retained messages for each
	// partition.
	targetLocation := pubsublite.AtTargetLocation(pubsublite.Beginning)

	sub, err := client.CreateSubscription(ctx, pubsublite.SubscriptionConfig{
		Name:                fmt.Sprintf("projects/%s/locations/%s/subscriptions/%s", projectID, location, subID),
		Topic:               fmt.Sprintf("projects/%s/locations/%s/topics/%s", projectID, location, topicID),
		DeliveryRequirement: pubsublite.DeliverImmediately, // Can also be DeliverAfterStored.
		// Configures an export subscription that writes messages to a Pub/Sub topic.
		ExportConfig: &pubsublite.ExportConfig{
			DesiredState: pubsublite.ExportActive, // Can also be ExportPaused.
			Destination: &pubsublite.PubSubDestinationConfig{
				Topic: fmt.Sprintf("projects/%s/topics/%s", projectID, pubsubTopicID),
			},
		},
	}, targetLocation)
	if err != nil {
		return fmt.Errorf("client.CreateSubscription got err: %w", err)
	}
	fmt.Fprintf(w, "Created export subscription: %s\n", sub.Name)
	return nil
}

Java

Avant d'exécuter cet exemple, suivez les instructions de configuration de Java dans la section Bibliothèques clientes de Pub/Sub Lite.

import com.google.api.gax.rpc.AlreadyExistsException;
import com.google.cloud.pubsublite.AdminClient;
import com.google.cloud.pubsublite.AdminClientSettings;
import com.google.cloud.pubsublite.BacklogLocation;
import com.google.cloud.pubsublite.CloudRegion;
import com.google.cloud.pubsublite.CloudRegionOrZone;
import com.google.cloud.pubsublite.CloudZone;
import com.google.cloud.pubsublite.ProjectNumber;
import com.google.cloud.pubsublite.SeekTarget;
import com.google.cloud.pubsublite.SubscriptionName;
import com.google.cloud.pubsublite.SubscriptionPath;
import com.google.cloud.pubsublite.TopicName;
import com.google.cloud.pubsublite.TopicPath;
import com.google.cloud.pubsublite.proto.ExportConfig;
import com.google.cloud.pubsublite.proto.ExportConfig.PubSubConfig;
import com.google.cloud.pubsublite.proto.ExportConfig.State;
import com.google.cloud.pubsublite.proto.Subscription;
import com.google.cloud.pubsublite.proto.Subscription.DeliveryConfig;
import com.google.cloud.pubsublite.proto.Subscription.DeliveryConfig.DeliveryRequirement;
import java.util.concurrent.ExecutionException;

public class CreatePubsubExportSubscriptionExample {

  public static void main(String... args) throws Exception {
    // TODO(developer): Replace these variables before running the sample.
    String cloudRegion = "your-cloud-region";
    char zoneId = 'b';
    String topicId = "your-topic-id";
    String subscriptionId = "your-subscription-id";
    String pubsubTopicId = "destination-topic-id";
    long projectNumber = Long.parseLong("123456789");
    // True if using a regional location. False if using a zonal location.
    // https://cloud.google.com/pubsub/lite/docs/topics
    boolean regional = false;

    createPubsubExportSubscriptionExample(
        cloudRegion, zoneId, projectNumber, topicId, subscriptionId, pubsubTopicId, regional);
  }

  public static void createPubsubExportSubscriptionExample(
      String cloudRegion,
      char zoneId,
      long projectNumber,
      String topicId,
      String subscriptionId,
      String pubsubTopicId,
      boolean regional)
      throws Exception {

    CloudRegionOrZone location;
    if (regional) {
      location = CloudRegionOrZone.of(CloudRegion.of(cloudRegion));
    } else {
      location = CloudRegionOrZone.of(CloudZone.of(CloudRegion.of(cloudRegion), zoneId));
    }

    TopicPath topicPath =
        TopicPath.newBuilder()
            .setProject(ProjectNumber.of(projectNumber))
            .setLocation(location)
            .setName(TopicName.of(topicId))
            .build();

    SubscriptionPath subscriptionPath =
        SubscriptionPath.newBuilder()
            .setLocation(location)
            .setProject(ProjectNumber.of(projectNumber))
            .setName(SubscriptionName.of(subscriptionId))
            .build();

    com.google.pubsub.v1.TopicName pubsubTopicName =
        com.google.pubsub.v1.TopicName.of(String.valueOf(projectNumber), pubsubTopicId);

    Subscription subscription =
        Subscription.newBuilder()
            .setDeliveryConfig(
                // Possible values for DeliveryRequirement:
                // - `DELIVER_IMMEDIATELY`
                // - `DELIVER_AFTER_STORED`
                // You may choose whether to wait for a published message to be successfully written
                // to storage before the server delivers it to subscribers. `DELIVER_IMMEDIATELY` is
                // suitable for applications that need higher throughput.
                DeliveryConfig.newBuilder()
                    .setDeliveryRequirement(DeliveryRequirement.DELIVER_IMMEDIATELY))
            .setExportConfig(
                // Configures an export subscription that writes messages to a Pub/Sub topic.
                ExportConfig.newBuilder()
                    // Possible values for State:
                    // - `ACTIVE`: enable message processing.
                    // - `PAUSED`: suspend message processing.
                    .setDesiredState(State.ACTIVE)
                    .setPubsubConfig(
                        PubSubConfig.newBuilder().setTopic(pubsubTopicName.toString())))
            .setName(subscriptionPath.toString())
            .setTopic(topicPath.toString())
            .build();

    // Target location within the message backlog that the subscription should be initialized to.
    SeekTarget initialLocation = SeekTarget.of(BacklogLocation.BEGINNING);

    AdminClientSettings adminClientSettings =
        AdminClientSettings.newBuilder().setRegion(location.extractRegion()).build();

    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the "close" method on the client to safely clean up any remaining background resources, or
    // use "try-with-close" statement to do this automatically.
    try (AdminClient adminClient = AdminClient.create(adminClientSettings)) {
      Subscription response = adminClient.createSubscription(subscription, initialLocation).get();
      System.out.println(response.getAllFields() + " created successfully.");
    } catch (ExecutionException e) {
      try {
        throw e.getCause();
      } catch (AlreadyExistsException alreadyExists) {
        System.out.println("This subscription already exists.");
      } catch (Throwable throwable) {
        throwable.printStackTrace();
      }
    }
  }
}

Python

Avant d'exécuter cet exemple, suivez les instructions de configuration de Python dans la section Bibliothèques clientes de Pub/Sub Lite.

from google.api_core.exceptions import AlreadyExists
from google.cloud.pubsub_v1 import PublisherClient
from google.cloud.pubsublite import AdminClient, Subscription, ExportConfig
from google.cloud.pubsublite.types import (
    BacklogLocation,
    CloudRegion,
    CloudZone,
    SubscriptionPath,
    TopicPath,
)


def create_lite_pubsub_export_subscription(
    project_number,
    cloud_region="us-central1",
    zone_id="a",
    topic_id="my-topic-id",
    subscription_id="my-subscription-id",
    pubsub_topic_id="destination-topic-id",
    regional=True,
    target_location=BacklogLocation.BEGINNING,
):
    if regional:
        location = CloudRegion(cloud_region)
    else:
        location = CloudZone(CloudRegion(cloud_region), zone_id)

    topic_path = TopicPath(project_number, location, topic_id)
    subscription_path = SubscriptionPath(project_number, location, subscription_id)
    destination_topic_path = PublisherClient.topic_path(project_number, pubsub_topic_id)

    subscription = Subscription(
        name=str(subscription_path),
        topic=str(topic_path),
        delivery_config=Subscription.DeliveryConfig(
            # Possible values for delivery_requirement:
            # - `DELIVER_IMMEDIATELY`
            # - `DELIVER_AFTER_STORED`
            # You may choose whether to wait for a published message to be successfully written
            # to storage before the server delivers it to subscribers. `DELIVER_IMMEDIATELY` is
            # suitable for applications that need higher throughput.
            delivery_requirement=Subscription.DeliveryConfig.DeliveryRequirement.DELIVER_IMMEDIATELY,
        ),
        # Configures an export subscription that writes messages to a Pub/Sub topic.
        export_config=ExportConfig(
            # Possible values for desired_state:
            # - `ACTIVE`: enable message processing.
            # - `PAUSED`: suspend message processing.
            desired_state=ExportConfig.State.ACTIVE,
            pubsub_config=ExportConfig.PubSubConfig(
                topic=destination_topic_path,
            ),
        ),
    )

    # Initialize client that will be used to send requests across threads. This
    # client only needs to be created once, and can be reused for multiple requests.
    client = AdminClient(cloud_region)
    try:
        response = client.create_subscription(subscription, target_location)
        print(f"{response.name} created successfully.")
    except AlreadyExists:
        print(f"{subscription_path} already exists.")

Mettre à jour un abonnement d'exportation

Vous pouvez mettre à jour les abonnements Lite à l'aide de la console Google Cloud, Google Cloud CLI ou l'API Pub/Sub Lite. Cette opération peut prendre jusqu'à secondes pour que les nouveaux paramètres soient appliqués.

Console

  1. Accédez à la page Abonnements Lite.

    Accéder aux abonnements Lite

  2. Cliquez sur l'ID d'abonnement Lite.

  3. Sur la page Détails de l'abonnement Lite, cliquez sur Modifier.

gcloud

Pour mettre à jour un abonnement Lite, exécutez la commande gcloud pubsub lite-subscriptions update :

gcloud pubsub lite-subscriptions update SUBSCRIPTION_ID \
--location=LOCATION \
--delivery-requirement=DELIVERY_REQUIREMENT \
--export-pubsub-topic=PUBSUB_TOPIC_NAME \
--export-dead-letter-topic=DEAD_LETTER_TOPIC_ID \
--export-desired-state=DESIRED_STATE

Remplacez les éléments suivants :

  • SUBSCRIPTION_ID: ID de l'abonnement Lite
  • LOCATION: emplacement de l'environnement Lite abonnement.
  • DELIVERY_REQUIREMENT : facultatif. L'exigence de livraison, soit deliver-after-stored ou deliver-immediately.
  • PUBSUB_TOPIC_NAME : facultatif. Le nom du Sujet Pub/Sub vers lequel exporter. Indiquez le nom complet si le sujet se trouve dans un autre projet: projects/my-project-id/topics/my-topic-id
  • DEAD_LETTER_TOPIC_ID: ID d'un sujet Lite existant à utiliser sous forme de lettre morte. Ce sujet doit se trouver dans le même emplacement (zone ou région) et le projet comme abonnement d'exportation lui-même.
  • DESIRED_STATE : facultatif. État souhaité de l'abonnement. Les valeurs suivantes sont acceptées:
    • active: l'abonnement exporte les messages Lite vers Pub/Sub. (Par défaut.)
    • paused: l'exportation des messages Lite est suspendue.

Si la requête aboutit, la ligne de commande affiche l'abonnement Lite :

Updated subscription [SUBSCRIPTION_ID].
deliveryConfig:
deliveryRequirement: DELIVERY_REQUIREMENT
exportConfig:
currentState: DESIRED_STATE
deadLetterTopic: projects/PROJECT_NUMBER/locations/LOCATION/topics/DEAD_LETTER_TOPIC_ID
desiredState: DESIRED_STATE
pubsubConfig:
  topic: PUBSUB_TOPIC_NAME
name: projects/PROJECT_NUMBER/locations/LOCATION/subscriptions/SUBSCRIPTION_ID
topic: projects/PROJECT_NUMBER/locations/LOCATION/topics/TOPIC_ID

Protocole

Pour mettre à jour un abonnement Lite, envoyez une requête PATCH comme suit :

PATCH https://REGION-pubsublite.googleapis.com/v1/admin/projects/PROJECT_NUMBER/locations/LOCATION/subscriptions/SUBSCRIPTION_ID?updateMask=deliveryConfig.deliveryRequirement,exportConfig
Authorization: Bearer $(gcloud auth print-access-token)

Remplacez les éléments suivants :

  • REGION: région dans laquelle l'abonnement Lite a été créé.
  • PROJECT_NUMBER: numéro du projet dans lequel le service L'abonnement a été créé.
  • LOCATION: emplacement de création de l'abonnement Lite.
  • SUBSCRIPTION_ID: ID de l'abonnement Lite.

Spécifiez les champs suivants dans le corps de la requête :

{
  "deliveryConfig": {
      "deliveryRequirement": "DELIVERY_REQUIREMENT",
  },
  "exportConfig": {
      "desiredState": "DESIRED_STATE",
      "deadLetterTopic": "projects/PROJECT_NUMBER/locations/LOCATION/topics/DEAD_LETTER_TOPIC_ID",
      "pubsubConfig": {
          "topic": "PUBSUB_TOPIC_NAME"
      }
  }
}

Remplacez les éléments suivants :

  • DELIVERY_REQUIREMENT: exigence de livraison, soit DELIVER_AFTER_STORED ou DELIVER_IMMEDIATELY.
  • DESIRED_STATE: état souhaité pour l'abonnement. La les valeurs suivantes sont acceptées:
    • ACTIVE: l'abonnement exporte les messages Lite vers Pub/Sub.
    • PAUSED: l'exportation des messages Lite est suspendue.
  • DEAD_LETTER_TOPIC_ID: ID d'un sujet Lite existant à utiliser sous forme de lettre morte. Ce sujet doit se trouver dans le même emplacement (zone ou région) et le projet comme abonnement d'exportation lui-même.
  • PUBSUB_TOPIC_NAME: nom de la destination sujet Pub/Sub. Exemple de format: projects/my-project-id/topics/my-topic-id

Si la requête aboutit, la réponse est l'abonnement Lite au format JSON :

{
"deliveryConfig": {
  "deliveryRequirement": "DELIVERY_REQUIREMENT",
},
"exportConfig": {
  "desiredState": "DESIRED_STATE",
  "deadLetterTopic": "projects/PROJECT_NUMBER/locations/LOCATION/topics/DEAD_LETTER_TOPIC_ID",
  "pubsubConfig": { "topic": "PUBSUB_TOPIC_NAME" }
},
"name": "projects/PROJECT_NUMBER/locations/LOCATION/subscriptions/SUBSCRIPTION_ID",
"topic": "projects/PROJECT_NUMBER/locations/LOCATION/topics/TOPIC_ID",
}

Suspendre ou démarrer un abonnement d'exportation

Le paramètre état souhaité pour les abonnements d'exportation est défini sur l'une des valeurs suivantes : deux valeurs:

  • Actif: l'abonnement exporte les messages Lite vers Pub/Sub.
  • Suspendu: l'exportation des messages Lite est suspendue.

Pour modifier l'état souhaité dans la console Google Cloud:

  1. Accédez à la page Abonnements Lite.

    Accéder aux abonnements Lite

  2. Cliquez sur l'ID d'abonnement Lite.

  3. Sur la page Détails de l'abonnement Lite, cliquez sur Suspendre ou sur Démarrer.

Vous pouvez également mettre à jour l'état souhaité à l'aide de la Google Cloud CLI ou l'API Pub/Sub Lite. Voir Mettre à jour un abonnement d'exportation

Bonnes pratiques

Cette section décrit quelques bonnes pratiques concernant l'utilisation d'abonnements d'exportation.

Réservations

Nous vous recommandons d'utiliser un abonnement d'exportation reservation, plutôt que de définir explicitement la capacité de débit de l'abonnement.

Compatibilité des messages

Si un message Pub/Sub Lite n'est pas compatible avec Pub/Sub, l'abonnement d'exportation ne publie pas le message Pub/Sub. Au lieu de cela, il place le message dans la file d'attente de lettres mortes, s'il en a été attribué. Si aucun file d'attente de lettres mortes n'a été attribué, non compatible les messages sont simplement ignorés.

Lorsque vous publiez des messages dans le sujet Lite, tenez compte des points suivants problèmes de compatibilité:

  • Clés : Les clés Pub/Sub Lite sont de type bytes, tandis que Les clés de tri Pub/Sub sont de type string. Pour assurer la compatibilité, le La clé Pub/Sub Lite ne doit contenir que des caractères UTF-8.

  • Attributs : Les attributs de message présentent les exigences suivantes:

    • Pour être compatibles, tous les attributs de message Pub/Sub Lite ne doit comporter qu'une seule valeur. Pub/Sub Lite prend en charge les messages avec plusieurs valeurs, mais Pub/Sub n'accepte attributs à valeur unique.
    • Les attributs du message ne doivent pas dépasser la valeur Limites des messages Pub/Sub le nombre maximal d'attributs par message, ainsi que la taille maximale de clé et de valeur par .

Sujet de lettres mortes

Pour conserver et gérer les messages incompatibles, nous vous recommandons d'utiliser une lettre morte. sur ce sujet. Vous pouvez attribuer une file d'attente de lettres mortes lorsque vous créez l'exportation ou mettre à jour un abonnement d'exportation existant de file d'attente de lettres mortes. Si l'abonnement reçoit un message incompatible avec Pub/Sub, il publie le message dans la file d'attente de lettres mortes.

Un file d'attente de lettres mortes est un sujet Pub/Sub Lite standard. Elle doit être en le même emplacement et le même projet que l'abonnement d'exportation. Il doit s'agir un sujet différent de celui de la source.

En règle générale, un file d'attente de lettres mortes présente une faible utilisation du débit. Par conséquent, nous recommandent d'attribuer une réservation à la file d'attente de lettres mortes, plutôt que alloue du débit au sujet.

Erreurs de distribution

Un abonnement d'exportation tente de distribuer tous les messages compatibles au à un sujet Pub/Sub de destination. Si la distribution du message échoue, l'exportation abonnement est suspendu. Pour identifier la catégorie d'erreur, consultez le subscription/export_status métrique. Les valeurs suivantes indiquent une erreur:

  • PERMISSION_DENIED: autorisations insuffisantes pour exporter des messages.
  • NOT_FOUND: une ou plusieurs ressources sont introuvables. par exemple, la destination Le sujet n'existe pas.

Pour en savoir plus sur le dépannage, consultez Résoudre les problèmes liés à l'exportation des abonnements

Une fois l'erreur résolue, l'abonnement à l'exportation redémarre automatiquement en raison de nouvelles tentatives.

Tarifs

Pub/Sub Lite et Pub/Sub vous sont facturés les ressources consommées par l'abonnement d'exportation. Plus précisément, vous êtes facturé pour le débit et le stockage alloués de l'abonnement les abonnements Pub/Sub Lite, qui sont configurés pour un sujet Pub/Sub Lite. La publication sur le site Web de Google à un sujet Pub/Sub de destination. Voir Tarifs de Pub/Sub

L'utilisation de la fonctionnalité d'exportation n'entraîne aucuns frais supplémentaires la différence de prix entre les abonnements à l'exportation Pub/Sub Lite et abonnements standards.

Résoudre les problèmes liés à l'exportation des abonnements

Cette section décrit quelques conseils de dépannage pour l'exportation des abonnements.

L'abonnement à l'exportation est suspendu

Si l'abonnement est suspendu, aucun message n'est exporté.

Pour détecter ce problème:

  • Console Google Cloud: consultez les détails de l'abonnement Si l'abonnement est en pause, les valeurs État souhaité et État actuel sont Paused.

  • Métriques: la métrique subscription/export_status est PAUSED.

Pour résoudre ce problème, démarrer l'abonnement.

Le sujet de destination ou la file d'attente de lettres mortes a été supprimé

Si vous supprimez le sujet Pub/Sub associé à une exportation abonnement ou supprimer le file d'attente de lettres mortes, une erreur se produit.

Pour détecter ce problème:

  • Console Google Cloud: consultez les détails de l'abonnement Si le sujet était supprimée, l'état actuel est Not found.

  • Métriques: la métrique subscription/export_status. Si le sujet était supprimée, la valeur est NOT_FOUND.

Pour résoudre ce problème, vérifiez le sujet Pub/Sub de destination et file d'attente de lettres mortes (le cas échéant).

Si la destination Pub/Sub de destination a été supprimée, recréez le sujet avec le même nom. L'abonnement à l'exportation reprend la publication, en supposant que autorisations n'ont pas été modifiées.

Si le file d'attente de lettres mortes a été supprimé, créez-en un autre et mettez à jour l'abonnement à l'exportation pour le référencer.

Messages incompatibles

Les messages incompatibles avec Pub/Sub ne sont pas exportés.

Pour détecter ce problème:

  • Métriques: la métrique subscription/unexportable_message_count indique le nombre de messages incompatibles qui n'ont pas pu être exportés.

Pour résoudre ce problème, utilisez une lettre morte pour conserver les messages incompatibles. Examinez les messages pour en déterminer la cause, puis les transformer et les publier à nouveau si nécessaire. Voir Compatibilité des messages :

L'exportation est limitée

Pour détecter ce problème:

  • Métriques: la métrique subscription/flow_control_status indique un contrôle de flux raison de NO_CLIENT_TOKENS, qui indique que la limite par partition de octets en attente ou messages est atteint. Tant que le problème n'est pas résolu, le nombre de tâches en attente augmentera pour les abonnements à l'exportation associés.

Cette erreur a plusieurs causes possibles. La plupart des causes possibles sont sur le backend, mais vérifiez les points suivants:

  • Veillez à publier des messages Lite avec la même clé à un taux inférieur supérieure à 1 Mio/s par clé. L'abonnement à l'exportation écrit les clés de message Lite sous la forme et Pub/Sub a un débit de 1 Mio/s limit sur chaque clé de tri. Dépassement de cette peut entraîner un ralentissement.

L'utilisateur n'est pas autorisé à effectuer cette action.

L'agent de service Pub/Sub Lite doit les autorisations nécessaires pour publier dans le sujet Pub/Sub de destination.

Pour détecter ce problème:

  • Console Google Cloud: consultez les détails de l'abonnement S'il y a des erreurs d'autorisation, l'état actuel est Permission denied.

  • Métriques: la métrique subscription/export_status est PERMISSON_DENIED.

Par exemple, les situations suivantes peuvent être à l'origine de cette erreur:

  • L'agent de service Pub/Sub Lite ne dispose pas de l'autorisation appropriée ou un rôle permettant de publier des messages dans le sujet Pub/Sub de destination un autre projet.
  • L'agent de service a été supprimé de la stratégie IAM de l'exportation le projet parent de l'abonnement.
  • L'agent de service Pub/Sub Lite est toujours en cours de configuration. Un service est créé automatiquement lorsque vous créez le premier abonnement d'exportation dans un projet. L'erreur d'autorisation devrait être automatiquement résolue sous 10 minutes.

Pour résoudre le problème, vérifiez si l'agent de service a obtenu le bon l'autorisation ou le rôle requis. Consultez la page Agents de service.

Étape suivante

Choisissez entre Pub/Sub et Pub/Sub Lite.