En este documento, se proporciona una descripción general de una suscripción de extracción, su flujo de trabajo y las propiedades asociadas.
En una suscripción de extracción, un cliente suscriptor solicita mensajes del servidor de Pub/Sub.
El modo de extracción puede usar una de las dos APIs de servicio: Pull o StreamingPull. Para ejecutar la API elegida, puedes seleccionar una biblioteca cliente de alto nivel proporcionada por Google o una biblioteca cliente de bajo nivel generada automáticamente. También puedes elegir entre el procesamiento de mensajes asíncrono y síncrono.
Antes de comenzar
Antes de leer este documento, asegúrate de estar familiarizado con lo siguiente:
Cómo funciona Pub/Sub y los diferentes términos de Pub/Sub
Los diferentes tipos de suscripciones que admite Pub/Sub y por qué podrías querer usar una suscripción de extracción
Flujo de trabajo de la suscripción de extracción
En el caso de una suscripción de extracción, el cliente suscriptor inicia solicitudes a un servidor de Pub/Sub para recuperar mensajes. El cliente suscriptor usa una de las siguientes APIs:
La mayoría de los clientes de suscriptores no realizan estas solicitudes directamente. En su lugar, los clientes dependen de la biblioteca cliente de alto nivel que proporciona Google Cloud, que realiza solicitudes de extracción de transmisión de forma interna y entrega mensajes de forma asíncrona. Para un cliente suscriptor que necesita un mayor control sobre cómo se extraen los mensajes, Pub/Sub usa una biblioteca gRPC de bajo nivel y generada automáticamente. Esta biblioteca realiza solicitudes de extracción o transmisión de extracción directamente. Estas solicitudes pueden ser síncronas o asíncronas.
En las siguientes dos imágenes, se muestra el flujo de trabajo entre un cliente suscriptor y una suscripción de extracción.
Flujo de trabajo de extracción
El flujo de trabajo de extracción es el siguiente y hace referencia a la Figura 1:
- El cliente suscriptor llama de forma explícita al método
pull
, que solicita mensajes para la entrega. Esta solicitud es elPullRequest
como se muestra en la imagen. El servidor de Pub/Sub responde con cero o más mensajes y IDs de confirmación. Una respuesta con cero mensajes o con un error no indica necesariamente que no hay mensajes disponibles para recibir. Esta respuesta es el
PullResponse
, como se muestra en la imagen.El cliente suscriptor llama de forma explícita al método
acknowledge
. El cliente usa el ID de confirmación que se muestra para confirmar que el mensaje se procesó y no es necesario volver a entregarlo.
Para una sola solicitud de extracción de transmisión, un cliente suscriptor puede recibir varias respuestas debido a la conexión abierta. En cambio, solo se muestra una respuesta para cada solicitud de extracción.
Propiedades de una suscripción de extracción
Las propiedades que configures para una suscripción de extracción determinan cómo escribirás los mensajes en tu suscripción. Para obtener más información, consulta propiedades de suscripción.
APIs de servicio de Pub/Sub
La suscripción de extracción de Pub/Sub puede usar una de las siguientes dos APIs para recuperar mensajes:
- Extracción
- StreamingPull
Usa RPCs de Acknowledge y ModifyAckDeadline unarias cuando recibas mensajes con estas APIs. Las dos APIs de Pub/Sub se describen en las siguientes secciones.
API de StreamingPull
Siempre que sea posible, en las bibliotecas cliente de Pub/Sub se usa StreamingPull para obtener la mayor capacidad de procesamiento y la latencia más baja. Aunque es posible que nunca uses directamente la API de StreamingPull, es importante saber en qué se diferencia de la API de Pull.
La API de StreamingPull se basa en una conexión bidireccional persistente para recibir múltiples mensajes a medida que estén disponibles. El siguiente es el flujo de trabajo:
El cliente envía una solicitud al servidor para establecer una conexión. Si se excede la cuota de conexión, el servidor muestra un error de agotamiento de recursos. La biblioteca cliente reintenta los errores de falta de cuota automáticamente.
Si no hay errores o la cuota de conexión vuelve a estar disponible, el servidor envía mensajes de forma continua al cliente conectado.
Si se supera la cuota de rendimiento, el servidor deja de enviar mensajes. Sin embargo, la conexión no se interrumpe. Cuando haya suficiente cuota de rendimiento disponible, se reanudará la transmisión.
El cliente o el servidor terminan la conexión.
La API de StreamingPull mantiene una conexión abierta. Los servidores de Pub/Sub cierran la conexión de forma recurrente después de un período para evitar una conexión fija de larga duración. La biblioteca cliente vuelve a abrir automáticamente una conexión de StreamingPull.
Los mensajes se envían a la conexión cuando están disponibles. Por lo tanto, la API de StreamingPull minimiza la latencia y maximiza la capacidad de procesamiento de los mensajes.
Obtén más información sobre los métodos de RPC de StreamingPull: StreamingPullRequest y StreamingPullResponse.
API de Pull
Esta API es una RPC unaria tradicional que se basa en un modelo de solicitud y respuesta. Una sola respuesta de extracción corresponde a una sola solicitud de extracción. El siguiente es el flujo de trabajo:
El cliente envía una solicitud al servidor para enviar mensajes. Si se excede la cuota de rendimiento, el servidor muestra un error de agotamiento de recursos.
Si no hay errores o la cuota de rendimiento vuelve a estar disponible, el servidor responde con cero o más mensajes y IDs de acuse de recibo.
Cuando se usa la API de Pull unaria, una respuesta con cero mensajes o con un error no indica necesariamente que no hay mensajes disponibles para recibir.
El uso de la API de Pull no garantiza una latencia baja y una alta capacidad de procesamiento de mensajes. Para lograr una alta capacidad de procesamiento y una baja latencia con la API de Pull, debes tener varias solicitudes pendientes simultáneas. Las solicitudes nuevas se crean cuando las solicitudes anteriores reciben una respuesta. La arquitectura de una solución de este tipo es propensa a errores y difícil de mantener. Te recomendamos que uses la API de StreamingPull para esos casos de uso.
Usa la API de Pull en lugar de la API de StreamingPull solo si necesitas un control estricto sobre lo siguiente:
- La cantidad de mensajes que puede procesar el cliente suscriptor
- La memoria y los recursos del cliente
También puedes usar esta API cuando tu suscriptor es un proxy entre Pub/Sub y otro servicio que opera de una manera más orientada a la extracción.
Obtén más información sobre los métodos REST de extracción: Método: projects.subscriptions.pull.
Obtén más información sobre los métodos de RPC de extracción: PullRequest y PullResponse.
Tipos de modos de procesamiento de mensajes
Elige uno de los siguientes modos de extracción para tus clientes suscriptor.
Modo de extracción asíncrona
El modo de extracción asíncrono separa la recepción de mensajes del procesamiento de mensajes en un cliente suscriptor. Este modo es el predeterminado para la mayoría de los clientes de suscriptores. El modo de extracción asíncrono puede usar la API de StreamingPull o la API de extracción unaria. La extracción asíncrona también puede usar la biblioteca cliente de alto nivel o la biblioteca cliente generada automáticamente de bajo nivel.
Puedes obtener más información sobre las bibliotecas cliente más adelante en este documento.
Modo de extracción síncrona
En el modo síncrono de extracción, el procesamiento y la recepción de los mensajes se realizan en secuencia y no están desacoplados entre sí. Por lo tanto, al igual que StreamingPull en comparación con las APIs de Pull unarias, el procesamiento asíncrono ofrece una latencia más baja y una capacidad de procesamiento más alta que el procesamiento síncrono.
Usa el modo de extracción síncrona solo para aplicaciones en las que la baja latencia y la alta capacidad de procesamiento no son los factores más importantes en comparación con otros requisitos. Por ejemplo, una aplicación puede limitarse a usar solo el modelo de programación síncrona. O bien, una aplicación con limitaciones de recursos podría requerir un control más exacto sobre la memoria, la red o la CPU. En esos casos, usa el modo síncrono con la API de Pull unaria.
Bibliotecas cliente de Pub/Sub
Pub/Sub ofrece una biblioteca cliente generada automáticamente de nivel alto y de nivel bajo.
Biblioteca cliente de Pub/Sub de alto nivel
La biblioteca cliente de alto nivel proporciona opciones para controlar los plazos de confirmación mediante la administración de asignaciones de tiempo. Estas opciones son más detalladas que cuando configuras las fechas límite de acuse de recibo con la consola o la CLI a nivel de la suscripción. La biblioteca cliente de alto nivel también implementa compatibilidad con funciones como la entrega ordenada, la entrega exactamente una vez y el control de flujo.
Te recomendamos que uses la extracción asíncrona y la API de StreamingPull con la biblioteca cliente de alto nivel. No todos los lenguajes compatibles con Google Cloud también admiten la API de Pull en la biblioteca cliente de alto nivel.
Para usar las bibliotecas cliente de alto nivel, consulta Bibliotecas cliente de Pub/Sub.
Biblioteca cliente de Pub/Sub generada automáticamente de bajo nivel
Hay disponible una biblioteca cliente de bajo nivel para los casos en los que debes usar la API de Pull directamente. Puedes usar el procesamiento síncrono o asíncrono con la biblioteca cliente de bajo nivel generada automáticamente. Debes codificar manualmente funciones como la entrega ordenada, la entrega exactamente una vez, el control de flujo y la administración de arrendamientos cuando usas la biblioteca cliente generada automáticamente de bajo nivel.
Puedes usar el modelo de procesamiento síncrono cuando usas la biblioteca cliente generada automáticamente de nivel inferior para todos los lenguajes compatibles. Puedes usar la biblioteca cliente generada automáticamente de bajo nivel y la extracción síncrona en los casos en que usar la API de Pull directamente tenga sentido. Por ejemplo, es posible que tengas una lógica de aplicación existente que se base en este modelo.
Para usar directamente las bibliotecas cliente de bajo nivel generadas automáticamente, consulta la descripción general de las APIs de Pub/Sub.
Muestras de código de la biblioteca cliente
Muestras de código de StreamingPull y biblioteca cliente de alto nivel
C++
Antes de probar esta muestra, sigue las instrucciones de configuración de C++ en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para C++.
C#
Antes de probar esta muestra, sigue las instrucciones de configuración de C# en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para C#.
Go
Antes de probar esta muestra, sigue las instrucciones de configuración de Go en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Go.
Java
Antes de probar esta muestra, sigue las instrucciones de configuración de Java en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Java.
Node.js
Antes de probar esta muestra, sigue las instrucciones de configuración de Node.js en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Node.js.
Node.js
Antes de probar esta muestra, sigue las instrucciones de configuración de Node.js en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Node.js.
Python
Antes de probar esta muestra, sigue las instrucciones de configuración de Python en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Python.
Ruby
Antes de probar esta muestra, sigue las instrucciones de configuración de Ruby en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Ruby.
Cómo recuperar atributos personalizados con la biblioteca cliente de alto nivel
En los siguientes ejemplos, se muestra cómo extraer mensajes de forma asíncrona y recuperar los atributos personalizados de los metadatos.
C++
Antes de probar esta muestra, sigue las instrucciones de configuración de C++ en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para C++.
C#
Antes de probar esta muestra, sigue las instrucciones de configuración de C# en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para C#.
Go
Antes de probar esta muestra, sigue las instrucciones de configuración de Go en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Go.
Java
Antes de probar esta muestra, sigue las instrucciones de configuración de Java en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Java.
Node.js
Antes de probar esta muestra, sigue las instrucciones de configuración de Node.js en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Node.js.
Python
Antes de probar esta muestra, sigue las instrucciones de configuración de Python en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Python.
Ruby
Antes de probar esta muestra, sigue las instrucciones de configuración de Ruby en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Ruby.
Controla los errores con la biblioteca cliente de alto nivel
En los siguientes ejemplos, se muestra cómo controlar los errores que surgen cuando se suscriben mensajes.
C++
Antes de probar esta muestra, sigue las instrucciones de configuración de C++ en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para C++.
Go
Antes de probar esta muestra, sigue las instrucciones de configuración de Go en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Go.
Java
Antes de probar esta muestra, sigue las instrucciones de configuración de Java en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Java.
Node.js
Antes de probar esta muestra, sigue las instrucciones de configuración de Node.js en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Node.js.
Python
Antes de probar esta muestra, sigue las instrucciones de configuración de Python en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Python.
Ruby
Antes de probar esta muestra, sigue las instrucciones de configuración de Go en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Go.
Muestras de código de extracción unaria
Este es un ejemplo de código para extraer y confirmar una cantidad fija de mensajes.
C++
Antes de probar esta muestra, sigue las instrucciones de configuración de C++ en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para C++.
C#
Antes de probar esta muestra, sigue las instrucciones de configuración de C# en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para C#.
Java
Antes de probar esta muestra, sigue las instrucciones de configuración de Java en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Java.
Node.js
Antes de probar esta muestra, sigue las instrucciones de configuración de Node.js en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Node.js.
PHP
Antes de probar esta muestra, sigue las instrucciones de configuración de Node.js en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Node.js.
Ruby
Antes de probar esta muestra, sigue las instrucciones de configuración de Ruby en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Ruby.
Protocolo
Solicitud:
POST https://pubsub.googleapis.com/v1/projects/myproject/subscriptions/mysubscription:pull
{
"returnImmediately": "false",
"maxMessages": "1"
}
Respuesta:
200 OK
{
"receivedMessages": [{
"ackId": "dQNNHlAbEGEIBERNK0EPKVgUWQYyODM2LwgRHFEZDDsLRk1SK...",
"message": {
"data": "SGVsbG8gQ2xvdWQgUHViL1N1YiEgSGVyZSBpcyBteSBtZXNzYWdlIQ==",
"messageId": "19917247034"
}
}]
}
Solicitud:
POST https://pubsub.googleapis.com/v1/projects/myproject/subscriptions/mysubscription:acknowledge
{
"ackIds": [
"dQNNHlAbEGEIBERNK0EPKVgUWQYyODM2LwgRHFEZDDsLRk1SK..."
]
}
Python
Antes de probar esta muestra, sigue las instrucciones de configuración de Python en la guía de inicio rápido sobre el uso de bibliotecas cliente. Si quieres obtener más información, consulta la documentación de referencia de la API de Pub/Sub para Python.
Pub/Sub entrega una lista de mensajes. Si la lista tiene varios mensajes, Pub/Sub los ordena con la misma clave de ordenamiento. A continuación, se muestran algunas advertencias importantes:
Establecer un valor para
max_messages
en la solicitud no garantiza que se muestremax_messages
, incluso si hay tantos mensajes en la lista de tareas pendientes. Es posible que la API de Pub/Sub Pull devuelva menos demax_messages
para reducir la latencia de entrega de los mensajes que están disponibles para entregarse.Una respuesta de extracción que incluye 0 mensajes no debe usarse como indicador de que no hay mensajes en la lista de tareas pendientes. Es posible obtener una respuesta con 0 mensajes y tener una solicitud posterior que devuelva mensajes.
Para lograr una baja latencia de entrega de mensajes con el modo de extracción unaria, es esencial tener muchas solicitudes de extracción pendientes al mismo tiempo. A medida que aumenta la capacidad de procesamiento del tema, se necesitan más solicitudes de extracción. En general, se prefiere el modo StreamingPull para aplicaciones sensibles a la latencia.
Cuotas y límites
Tanto las conexiones de Pull como las de StreamingPull están sujetas a cuotas y límites. Para obtener más información, consulta Cuotas y límites de Pub/Sub.
¿Qué sigue?
Crea una suscripción de extracción para tu tema.
Crea o modifica una suscripción con gcloud CLI.
Crea o modifica una suscripción con las APIs de REST.
Crea o modifica una suscripción con las APIs de RPC.