Inviare notifiche a Slack

Questo documento spiega come inviare notifiche relative al budget a Slack.

I budget in genere sono configurati per inviare notifiche via email. Tuttavia, l'email non è sempre il modo migliore per rimanere al passo con i costi del cloud, in particolare se il budget è critico e tempestivo. Con le notifiche programmatiche, puoi inoltrare i messaggi relativi al budget ad altri mezzi, come Slack.

Prima di iniziare

Prima di iniziare, devi completare le seguenti attività:

  1. Abilita l'API Cloud Billing
  2. Creare un budget
  3. Configurare le notifiche relative al budget programmatico

Configurare un canale Slack e le autorizzazioni

Il primo passaggio consiste nel creare lo spazio di lavoro di Slack e i token utente del bot che vengono utilizzati per chiamare l'API Slack. I token API possono essere gestiti all'indirizzo https://api.slack.com/apps. Per istruzioni dettagliate, consulta Utenti bot sul sito di Slack.

Configura le notifiche di Slack.

Configurare una funzione Cloud Run

  1. Completa i passaggi descritti in Creare una funzione Cloud Run. Assicurati che Tipo di trigger sia impostato sullo stesso argomento Pub/Sub utilizzato dal budget.

  2. Aggiungi le seguenti dipendenze:

    Node.js

    Copia quanto segue in 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": ">=16.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",
    "google-auth-library": "^9.0.0",
    "googleapis": "^143.0.0",
    "slack": "^11.0.1"
  },
  "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

    Copia quanto segue in requirements.txt:

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

  3. Copia il seguente codice nella funzione Cloud Run per pubblicare notifiche sul budget in un canale di chat di Slack utilizzando l'API Slack:

    Node.js 

    const slack = require('slack');

// 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';

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

  await slack.chat.postMessage({
    token: BOT_ACCESS_TOKEN,
    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. Assicurati che i seguenti parametri postMessage dell'API Slack siano impostati correttamente:

    • Token di accesso OAuth dell'utente del bot
    • Nome canale

Testa la funzione

Per assicurarti che la funzione funzioni come previsto, segui i passaggi descritti in Testare una funzione Cloud Run.

Se l'operazione va a buon fine, viene visualizzato un messaggio in Slack.

Passaggi successivi

Esamina altri esempi di notifiche programmatiche per scoprire come svolgere le seguenti operazioni: