Envoyer des notifications à Slack

Ce document explique comment envoyer des notifications de budget à Slack.

Les budgets sont généralement configurés pour envoyer des notifications par e-mail. Toutefois, l'envoi d'e-mails n'est pas toujours le meilleur moyen de rester informé de vos coûts Google Cloud, surtout si votre budget est critique et sensible au facteur temps. Avec les notifications automatisées, vous pouvez transférer vos messages budgétaires vers d'autres plates-formes, telles que Slack.

Avant de commencer

Avant de commencer, vous devez effectuer les tâches suivantes :

  1. Activer l'API Cloud Billing
  2. Créer un budget
  3. Configurer des notifications de budget automatisées

Configurer un canal Slack et des autorisations

La première étape consiste à créer un espace de travail Slack et les jetons de l'utilisateur bot utilisés pour appeler l'API Slack. Les jetons d'API peuvent être gérés à l'adresse https://api.slack.com/apps. Pour obtenir des instructions détaillées, consultez la page concernant les utilisateurs bot sur le site de Slack.

Configurer les notifications Slack.

Configurer une fonction Cloud Run

  1. Suivez les étapes décrites dans Créer une fonction Cloud Run. Assurez-vous que le type de déclencheur est défini sur le même sujet Pub/Sub que celui sur lequel votre budget sera configuré.

  2. Ajoutez les dépendances suivantes :

    Node.js

    Copiez ce qui suit dans le fichier package.json :

    {
  "name": "cloud-functions-billing",
  "private": "true",
  "version": "0.0.1",
  "description": "Examples of integrating Cloud Functions with billing",
  "main": "index.js",
  "engines": {
    "node": ">=18.0.0"
  },
  "scripts": {
    "compute-test": "c8 mocha -p -j 2 test/periodic.test.js --timeout=600000",
    "test": "c8 mocha -p -j 2 test/index.test.js --timeout=5000 --exit"
  },
  "author": "Ace Nassri <anassri@google.com>",
  "license": "Apache-2.0",
  "dependencies": {
    "@google-cloud/billing": "^4.0.0",
    "@google-cloud/compute": "^4.0.0",
    "@slack/web-api": "^7.15.0",
    "google-auth-library": "^9.0.0",
    "googleapis": "^143.0.0"
  },
  "devDependencies": {
    "@google-cloud/functions-framework": "^3.0.0",
    "c8": "^10.0.0",
    "gaxios": "^6.0.0",
    "mocha": "^10.0.0",
    "promise-retry": "^2.0.0",
    "proxyquire": "^2.1.0",
    "sinon": "^18.0.0",
    "wait-port": "^1.0.4"
  }
}

    Python

    Copiez ce qui suit dans le fichier requirements.txt :

    slackclient==2.9.4
google-api-python-client==2.131.0

  3. Copiez le code suivant dans votre fonction Cloud Run pour publier des notifications de budget sur un canal de discussion Slack à l'aide de l'API Slack :

    Node.js 

    const {WebClient} = require('@slack/web-api');

// TODO(developer) replace these with your own values
const BOT_ACCESS_TOKEN =
  process.env.BOT_ACCESS_TOKEN || 'xxxx-111111111111-abcdefghidklmnopq';
const CHANNEL = process.env.SLACK_CHANNEL || 'general';
const slackClient = new WebClient(BOT_ACCESS_TOKEN);

exports.notifySlack = async pubsubEvent => {
  const pubsubAttrs = pubsubEvent.attributes;
  const pubsubData = Buffer.from(pubsubEvent.data, 'base64').toString();
  const budgetNotificationText = `${JSON.stringify(
    pubsubAttrs
  )}, ${pubsubData}`;

  await slackClient.chat.postMessage({
    channel: CHANNEL,
    text: budgetNotificationText,
  });

  return 'Slack notification sent successfully';
};

    Python 

    import base64
import json
import os
import slack
from slack.errors import SlackApiError
# See https://api.slack.com/docs/token-types#bot for more info
BOT_ACCESS_TOKEN = "xxxx-111111111111-abcdefghidklmnopq"
CHANNEL = "C0XXXXXX"

slack_client = slack.WebClient(token=BOT_ACCESS_TOKEN)


def notify_slack(data, context):
    pubsub_message = data

    # For more information, see
    # https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format
    try:
        notification_attr = json.dumps(pubsub_message["attributes"])
    except KeyError:
        notification_attr = "No attributes passed in"

    try:
        notification_data = base64.b64decode(data["data"]).decode("utf-8")
    except KeyError:
        notification_data = "No data passed in"

    # This is just a quick dump of the budget data (or an empty string)
    # You can modify and format the message to meet your needs
    budget_notification_text = f"{notification_attr}, {notification_data}"

    try:
        slack_client.api_call(
            "chat.postMessage",
            json={"channel": CHANNEL, "text": budget_notification_text},
        )
    except SlackApiError:
        print("Error posting to Slack")

  4. Assurez-vous que les paramètres postMessage de l'API Slack suivants sont correctement définis :

    • Jeton d'accès OAuth de l'utilisateur bot
    • Nom de la chaîne

Tester votre fonction

Pour vous assurer que votre fonction fonctionne comme prévu, suivez les étapes décrites dans Tester une fonction Cloud Run.

Si l'opération réussit, un message s'affiche dans Slack.

Étape suivante

Consultez d'autres exemples de notifications automatisées pour découvrir comment effectuer les opérations suivantes :