Cloud Pub/Sub Tutorial

This simple tutorial demonstrates writing, deploying, and triggering a Background Cloud Function with a Cloud Pub/Sub trigger. To learn more about Cloud Pub/Sub, see the Cloud Pub/Sub documentation.

Note: You can also use HTTP-triggered functions to listen to Pub/Sub push subscriptions. This allows a single Cloud Function to subscribe to multiple topics.

Objectives

• Write and deploy a Background Cloud Function.
• Trigger the function by publishing a message to a Cloud Pub/Sub topic.

Costs

This tutorial uses billable components of Cloud Platform, including:

• Google Cloud Functions
• Google Cloud Pub/Sub

Use the Pricing Calculator to generate a cost estimate based on your projected usage.

New Cloud Platform users might be eligible for a free trial.

Before you begin

1. Connectez-vous à votre compte Google.

   Si vous n'en possédez pas déjà un, vous devez en créer un.

2. Sélectionnez ou créez un projet Google Cloud Platform.

   Remarque : Si vous ne prévoyez pas de conserver les ressources créées dans ce tutoriel, créez un projet au lieu de sélectionner un projet existant. Une fois que vous avez terminé, vous pouvez supprimer le projet en retirant toutes les ressources associées au projet et au tutoriel.

   Accéder à la page "Gérer les ressources"

3. Assurez-vous que la facturation est activée pour votre projet Google Cloud Platform.

   Découvrir comment activer la facturation

{% dynamic if "no_credentials" in setvar.task_params %}{% dynamic setvar credential_type %}NO_AUTH{% dynamic endsetvar %}{% dynamic if not setvar.redirect_url %}{% dynamic setvar redirect_url %}https://console.cloud.google.com{% dynamic endsetvar %}{% dynamic endif %}{% dynamic endif %}{% dynamic if setvar.in_henhouse_no_auth_whitelist %}{% dynamic if not setvar.credential_type %}{% dynamic setvar credential_type %}NO_AUTH{% dynamic endsetvar %}{% dynamic endif %}{% dynamic elif setvar.in_henhouse_service_account_whitelist %}{% dynamic if not setvar.credential_type %}{% dynamic setvar credential_type %}SERVICE_ACCOUNT{% dynamic endsetvar %}{% dynamic endif %}{% dynamic endif %}{% dynamic if not setvar.service_account_roles and setvar.credential_type == "SERVICE_ACCOUNT" %}{% dynamic setvar service_account_roles %}{% dynamic endsetvar %}{% dynamic endif %}{% dynamic setvar console %}{% dynamic if "no_steps" not in setvar.task_params %}
4. {% dynamic endif %}{% dynamic if setvar.api_list %}{% dynamic if setvar.in_henhouse_no_auth_whitelist or setvar.in_henhouse_service_account_whitelist %}Configurez un projet dans la console GCP.

   Configurer un projet

   Cliquez pour effectuer les opérations suivantes :

   • Créer ou sélectionner un projet
   • Activer {% dynamic if setvar.api_names %}{% dynamic print setvar.api_names %}{% dynamic else %}{% dynamic endif %}{% dynamic if "," in setvar.api_list %}les API requises{% dynamic elif "API" in setvar.api_names %}{% dynamic else %}l'API requise{% dynamic endif %} pour ce projet
   {% dynamic if setvar.credential_type == 'SERVICE_ACCOUNT' %}
   • Créer un compte de service
   • Télécharger une clé privée au format JSON
   {% dynamic endif %}

   Vous pouvez afficher et gérer ces ressources à tout moment dans la console GCP.

   {% dynamic else %}{% dynamic if "no_text" not in setvar.task_params %}Activez {% dynamic if setvar.api_names %}{% dynamic print setvar.api_names %}{% dynamic else %}{% dynamic endif %}{% dynamic if "," in setvar.api_list %}les API requises{% dynamic elif "API" in setvar.api_names %}{% dynamic else %}l'API requise{% dynamic endif %}. {% dynamic endif %}

   Activer {% dynamic if "," in setvar.api_list %}les API{% dynamic else %}l'API{% dynamic endif %}.

   {% dynamic endif %}{% dynamic endif %}{% dynamic if "no_steps" not in setvar.task_params %}
{% dynamic endif %}{% dynamic endsetvar %}{% dynamic print setvar.console %}
5. Install and initialize the Cloud SDK.
6. Update and install gcloud components:

   Node.js 8/10

   gcloud components update

   Node.js 6 (Deprecated)

   gcloud components update

   Python

   gcloud components update

   Go

   gcloud components update

7. Prepare your development environment.

   Node.js

   Go to the Node.js setup guide

   Python

   Go to the Python setup guide

   Go

   Go to the Go setup guide

Preparing the application

1. Clone the sample app repository to your local machine:

   Node.js

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git

   Alternatively, you can download the sample as a zip file and extract it.

   Python

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git

   Alternatively, you can download the sample as a zip file and extract it.

   Go

   git clone https://github.com/GoogleCloudPlatform/golang-samples.git

   Alternatively, you can download the sample as a zip file and extract it.

2. Change to the directory that contains the Cloud Functions sample code for accessing Cloud Pub/Sub:

   Node.js 8/10

   cd nodejs-docs-samples/functions/node8/

   Node.js 6 (Deprecated)

   cd nodejs-docs-samples/functions/helloworld/

   Python

   cd python-docs-samples/functions/helloworld/

   Go

   cd golang-samples/functions/helloworld/

3. Take a look at the sample code:

   Node.js 8/10

   functions/node8/index.js

   View on GitHub Feedback

   /**
    * Background Cloud Function to be triggered by Pub/Sub.
    * This function is exported by index.js, and executed when
    * the trigger topic receives a message.
    *
    * @param {object} pubSubEvent The event payload.
    * @param {object} context The event metadata.
    */
   exports.helloPubSub = (pubSubEvent, context) => {
     const name = pubSubEvent.data
       ? Buffer.from(pubSubEvent.data, 'base64').toString()
       : 'World';
   
     console.log(`Hello, ${name}!`);
   };

   Node.js 6 (Deprecated)

   functions/helloworld/index.js

   View on GitHub Feedback

   /**
    * Background Cloud Function to be triggered by Pub/Sub.
    * This function is exported by index.js, and executed when
    * the trigger topic receives a message.
    *
    * @param {object} event The Cloud Functions event.
    * @param {function} callback The callback function.
    */
   exports.helloPubSub = (event, callback) => {
     const pubsubMessage = event.data;
     const name = pubsubMessage.data
       ? Buffer.from(pubsubMessage.data, 'base64').toString()
       : 'World';
   
     console.log(`Hello, ${name}!`);
   
     callback();
   };

   Python

   functions/helloworld/main.py

   View on GitHub Feedback

   def hello_pubsub(data, context):
       """Background Cloud Function to be triggered by Pub/Sub.
       Args:
            data (dict): The dictionary with data specific to this type of event.
            context (google.cloud.functions.Context): The Cloud Functions event
            metadata.
       """
       import base64
   
       if 'data' in data:
           name = base64.b64decode(data['data']).decode('utf-8')
       else:
           name = 'World'
       print('Hello {}!'.format(name))

   Go

   functions/helloworld/hello_pubsub.go

   View on GitHub Feedback

   // Package helloworld provides a set of Cloud Functions samples.
   package helloworld
   
   import (
   	"context"
   	"log"
   )
   
   // PubSubMessage is the payload of a Pub/Sub event.
   type PubSubMessage struct {
   	Data []byte `json:"data"`
   }
   
   // HelloPubSub consumes a Pub/Sub message.
   func HelloPubSub(ctx context.Context, m PubSubMessage) error {
   	name := string(m.Data)
   	if name == "" {
   		name = "World"
   	}
   	log.Printf("Hello, %s!", name)
   	return nil
   }
   

   Note: the Pub/Sub message's data is stored as a base64-encoded string in the data property of the PubsubMessage object. To extract this data, you may need to decode it as shown in the examples above.

Deploying the function

To deploy the function with a Cloud Pub/Sub trigger, run the following command in the directory where the sample code is located:

Node.js 8

gcloud functions deploy helloPubSub --runtime nodejs8 --trigger-topic YOUR_TOPIC_NAME

Node.js 10 (Beta)

gcloud functions deploy helloPubSub --runtime nodejs10 --trigger-topic YOUR_TOPIC_NAME

Node.js 6 (Deprecated)

gcloud functions deploy helloPubSub --runtime nodejs6 --trigger-topic YOUR_TOPIC_NAME

Python

gcloud functions deploy hello_pubsub --runtime python37 --trigger-topic YOUR_TOPIC_NAME

Go

gcloud functions deploy HelloPubSub --runtime go111 --trigger-topic YOUR_TOPIC_NAME

where YOUR_TOPIC_NAME is the name of the Cloud Pub/Sub topic to which the function will be subscribed.

Note: The function deployment creates the specified Cloud Pub/Sub topic for you. You can also specify an existing topic in your project to subscribe to.

Triggering the function

1. Publish a message to your Cloud Pub/Sub topic. In this example, the message is a name that the function will include in a greeting:

   gcloud pubsub topics publish YOUR_TOPIC_NAME --message YOUR_NAME

   Replace YOUR_TOPIC_NAME with the name of your Cloud Pub/Sub topic, and YOUR_NAME with an arbitrary string.

2. Check the logs to be sure the executions have completed:

   gcloud functions logs read --limit 50
   

   Note: Logs might take a few moments to appear. If you don't see them immediately, check again in a minute or two.

Cleaning up

To avoid incurring charges to your Google Cloud Platform account for the resources used in this tutorial:

Deleting the project

The easiest way to eliminate billing is to delete the project that you created for the tutorial.

To delete the project:

Attention : La suppression d'un projet aura les effets suivants :

• Tout le contenu du projet est supprimé. Si vous avez utilisé un projet existant pour ce tutoriel et que vous le supprimez, vous supprimerez également tout autre travail effectué dans le projet.
• Les ID de projets personnalisés sont perdus. Lorsque vous avez créé ce projet, vous avez peut-être créé un ID de projet personnalisé que vous souhaitez utiliser à l'avenir. Pour conserver les URL qui utilisent l'ID de projet, telle qu'une URL appspot.com, supprimez les ressources sélectionnées dans le projet au lieu de supprimer l'ensemble du projet.

Si vous envisagez d'explorer plusieurs tutoriels et guides de démarrage rapide, vous pouvez constater que réutiliser des projets peut vous aider à éviter de dépasser les limites de quotas des projets.

1. Dans la console GCP, accédez à la page "Projets".

   Accéder à la page Projets

2. Dans la liste des projets, sélectionnez celui que vous souhaitez supprimer, puis cliquez sur Supprimer.
3. Dans la boîte de dialogue, saisissez l'ID du projet, puis cliquez sur Arrêter pour supprimer le projet.

Deleting the Cloud Function

Deleting Cloud Functions does not remove any resources stored in Cloud Storage.

To delete the Cloud Function you created in this tutorial, run the following command:

Node.js

gcloud functions delete helloPubSub 

Python

gcloud functions delete hello_pubsub 

Go

gcloud functions delete HelloPubSub 

You can also delete Cloud Functions from the Google Cloud Platform Console.