Serve - send an SMS alert

In this part of the tour you'll learn how to create a simple destination. This destination sends an SMS alert to a systems administrator when a CPU spike data frame arrives.

Watch the video

Prerequisites

If you've completed this tutorial so far, you should have all the prerequisites already installed.

Optionally: You can sign up for a free Vonage account, to be able to send an SMS. If you would like to try this, simply set send_sms_bool = True in the main.py code you create later, to switch this feature on.

Create the destination

To create the SMS alert destination:

In your Develop environment, click on Code Samples in the main left-hand navigation.
Select the Python, Destination, and Basic templates filters.
For Starter destination click Preview code.
Click Edit code.
Name the destination "CPU Alert SMS".
Select the input topic cpu-spike.
Click Save as Application.
In the project view click on main.py to edit it.

Replace all the code in main.py with the following:

import quixstreams as qx
import os
import pandas as pd

# Set this to True if you want to actually send an SMS (you'll need a free Vonage account)
send_sms_bool = False 
if send_sms_bool:
    import vonage # add vonage module to requirements.txt to pip install it
    vonage_key = os.environ["VONAGE_API_KEY"]
    vonage_secret = os.environ["VONAGE_API_SECRET"]
    to_number = os.environ["TO_NUMBER"]

    client = vonage.Client(key=vonage_key, secret=vonage_secret)
    sms = vonage.Sms(client)

# function to send an SMS
def send_sms(message):
    print("Sending SMS message to admin...")
    responseData = sms.send_message(
        {
            "from": "Vonage APIs",
            "to": to_number,
            "text": message,
        }
    )

    if responseData["messages"][0]["status"] == "0":
        print("Message sent successfully. Admin Alerted.")
    else:
        print(f"Message failed with error: {responseData['messages'][0]['error-text']}")
    return

client = qx.QuixStreamingClient()

topic_consumer = client.get_topic_consumer(topic_id_or_name = os.environ["input"],
                                        consumer_group = "empty-destination")

def on_dataframe_received_handler(stream_consumer: qx.StreamConsumer, df: pd.DataFrame):
    print('Spike dataframe received!')
    cpu_load = df['CPU_Load'][0]
    msg = f"Warning! CPU spike of {cpu_load} detected."
    if send_sms_bool is True:
        send_sms(msg)

def on_stream_received_handler(stream_consumer: qx.StreamConsumer):
    stream_consumer.timeseries.on_dataframe_received = on_dataframe_received_handler

topic_consumer.on_stream_received = on_stream_received_handler
print("Listening to streams. Press CTRL-C to exit.")
qx.App.run()

Send an SMS (optional)

This section is optional.

If you want to send an alert SMS follow these steps:

Change the variable send_sms_bool to True in your main.py.
In the Environment variables panel, click + Add. The Add Variable dialog is displayed.
Complete the information for the following environment variables (you obtain these from your Vonage developer dashboard):

Variable name Variable type

VONAGE_API_KEY text - hidden

VONAGE_API_SECRET text - hidden

TO_NUMBER text - hidden

Tip

You can select properties such as Text Hidden for variables that represent API secrets, keys, and passwords. If necessary, you can also make a variable required.

See also how to add environment variables.
You now need to add the vonage module to the requirements.txt file in your project. Click to open it and add a line for vonage. This ensures the module is built into the deployment.

Tag and deploy your SMS alert service

You can now tag and deploy your code:

Tag the project as sms-v1 and deploy as a service (watch the video if you're not sure how to do this).
Monitor the logs for the deployed process.

Generate an alert

Again generate a CPU spike by opening several large applications on your laptop. If you have SMS alert enabled, you'll receive an SMS. If not, you can check the logs.

Conclusion

You've now completed the Quix Tour. You've built a simple but complete stream processing pipeline.

Next steps

To continue your Quix learning journey, you may want to consider some of the following resources:

Variable name	Variable type
VONAGE_API_KEY	`text - hidden`
VONAGE_API_SECRET	`text - hidden`
TO_NUMBER	`text - hidden`