[Yandex Cloud documentation](../../index.md) > [Monium](../index.md) > Metrics > [Tutorials](index.md) > Sensor reading monitoring and event notifications # Monitoring sensor readings and event notifications {% note warning %} Yandex IoT Core is no longer available to new users. Current users can create resources until November 1, 2026. Afterwards, the service will go read-only and cease to operate on December 1, 2026. For more information on the timing and procedure, see [Service shutdown](../../iot-core/sunset.md). {% endnote %} In this tutorial, you will set up monitoring and notifications for changes in readings of the sensors connected to [Yandex IoT Core](../../iot-core/index.md). To emulate sensors, we will use [Yandex Cloud Functions](../../functions/index.md). If you have any connected sensors, use them. You do not need to create or configure [VMs](../../compute/concepts/vm.md), as all steps in this tutorial are entirely based on serverless computing in Cloud Functions. The source code for this guide is available on [GitHub](https://github.com/yandex-cloud-examples/yc-server-room-iot-monitoring). To configure monitoring of sensor readings in the server room: 1. [Get your cloud ready](#before-you-begin). 1. [Create the required Yandex IoT Core resources](#resources-step). 1. [Create a device emulator in Cloud Functions](#emulator-step). 1. [Set up sensor reading monitoring](#configure-monitoring). If you no longer need the resources you created, [delete them](#cleanup). ## Get your cloud ready {#before-you-begin} Sign up for Yandex Cloud and create a [billing account](../../billing/concepts/billing-account.md): 1. Navigate to the [management console](https://console.yandex.cloud) and log in to Yandex Cloud or create a new account. 1. On the **[Yandex Cloud Billing](https://center.yandex.cloud/billing/accounts)** page, make sure you have a billing account linked and it has the `ACTIVE` or `TRIAL_ACTIVE` [status](../../billing/concepts/billing-account-statuses.md). If you do not have a billing account, [create one](../../billing/quickstart/index.md) and [link](../../billing/operations/pin-cloud.md) a cloud to it. If you have an active billing account, you can create or select a [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) for your infrastructure on the [cloud page](https://console.yandex.cloud/cloud). [Learn more about clouds and folders here](../../resource-manager/concepts/resources-hierarchy.md). ### Required paid resources {#paid-resources} The support cost includes: * Fee for the number of Yandex IoT Core messages (see [Yandex IoT Core pricing](../../iot-core/pricing.md)). * Fee for the number of [function](../../functions/concepts/function.md) invocations in Cloud Functions (see [Yandex Cloud Functions pricing](../../functions/pricing.md)). * Fee for logging user [metrics](../../monitoring/concepts/data-model.md#metric) via the [Monium.Metrics](../../monitoring/index.md) API (see [Monium.Metrics pricing](../../monitoring/pricing.md)). ### Create service accounts {#create-sa} 1. [Create](../../iam/operations/sa/create.md) a service account named `my-emulator-function-service-account` for data sending. [Assign](../../iam/operations/sa/assign-role-for-sa.md) the `functions.functionInvoker` and `iot.devices.writer` [roles](../../iam/concepts/access-control/roles.md) to it. 1. [Create](../../iam/operations/sa/create.md) a service account named `my-metrics-function-service-account` for data processing. [Assign](../../iam/operations/sa/assign-role-for-sa.md) the `functions.functionInvoker` and `editor` [roles](../../iam/concepts/access-control/roles.md) to it. ## Create the required Yandex IoT Core resources {#resources-step} [Registry](../../iot-core/concepts/index.md#registry) and [device](../../iot-core/concepts/index.md#device) are the main Yandex IoT Core components for exchanging data and commands. Devices can only exchange data if created in the same registry. ### Create a registry and set up username and password authentication {#registry-step} {% list tabs group=instructions %} - Management console {#console} 1. In the [management console](https://console.yandex.cloud), select the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) you are using to complete this tutorial. 1. Navigate to **IoT Core**. 1. Click **Create registry**. 1. In the **Name** field, enter a name for the registry, e.g., `my-registry`. 1. In the **Password** field, set a password for registry access. To create a password, you can use [this password generator](https://passwordsgenerator.net/). {% note info %} Save the password as you will need it for [authentication](../../iot-core/concepts/authorization.md). {% endnote %} 1. Click **Create**. {% endlist %} ### Create a device and set up username and password authentication {#device-step} {% list tabs group=instructions %} - Management console {#console} 1. In the [management console](https://console.yandex.cloud), select the folder you are using to complete this tutorial. 1. Navigate to **IoT Core**. 1. Select the registry you created in the previous step. 1. Select **Devices** in the left-hand menu. 1. Click **Add device**. 1. In the **Name** field, enter a device name, e.g., `my-device`. 1. In the **Password** field, set a password for device access. To create a password, you can use [this password generator](https://passwordsgenerator.net/). {% note info %} Save the password as you will need it for [authentication](../../iot-core/concepts/authorization.md). {% endnote %} 1. Optionally, add an alias: 1. Click **Add alias**. 1. Fill in the fields: enter an alias, e.g., `events`, and the [topic](../../iot-core/concepts/topic/index.md) type after `$devices/{id}`, e.g., `events`. You can now use the `events` alias instead of the `$devices/{id}/events` topic. 1. Repeat these steps for each alias you add. 1. Click **Create**. 1. Repeat these steps for each device you create. {% endlist %} ## Create a device emulator in Cloud Functions {#emulator-step} The emulator sends data from device sensors and processes data for monitoring and [alerts](../../monitoring/concepts/alerting/alert.md). ### Create a function to emulate sending data from the device {#emulation-function} {% list tabs group=instructions %} - Management console {#console} 1. In the [management console](https://console.yandex.cloud), select the folder you are using to complete this tutorial. 1. Navigate to **Cloud Functions**. 1. Create a function: 1. Click **Create function**. 1. In the **Name** field, enter a name for the function, e.g., `my-device-emulator-function`. 1. Click **Create**. 1. Create a function version: 1. In the **Editor** window that opens, select `Node.js 18`. 1. Disable **Add files with code examples**. 1. Click **Continue**. 1. In the **Code source** field, select `Code editor`. 1. Click **Create file**: * File name: `device-emulator.js`. * File contents: Function code from [GitHub](https://github.com/yandex-cloud-examples/yc-server-room-iot-monitoring/blob/master/device-emulator.js). 1. Similarly, create a file named `package.json` with the following contents: ```json { "name": "my-app", "version": "1.0.0", "dependencies": { "yandex-cloud": "*" } } ``` 1. In the **Entry point** field, specify `device-emulator.handler`. 1. Under **Parameters**, specify: * **Timeout**: `10`. * **Memory**: `128 MB`. * **Service account**: `my-emulator-function-service-account`. * **Environment variables**: Key | Description | Value :--- | :--- | :--- `HUMIDITY_SENSOR_VALUE` | Baseline humidity sensor reading | `80.15` `TEMPERATURE_SENSOR_VALUE` | Baseline temperature sensor reading | `25.25` `RACK_DOOR_SENSOR_VALUE` | Rack door sensor reading | `False` `ROOM_DOOR_SENSOR_VALUE` | Server room door sensor reading | `False` `SMOKE_SENSOR_VALUE` | Smoke sensor reading | `False` `WATER_SENSOR_VALUE` | Water sensor reading | `False` `IOT_CORE_DEVICE_ID` | ID of the device you created. | See the [management console](https://console.yandex.cloud),
Yandex IoT Core `DEVICE_ID` | Custom device name | It is specified by the user. 1. Click **Save changes**. {% endlist %} ### Test the emulation function {#test-emulation-function} Optionally, to get detailed information from the sensors, [subscribe](../../iot-core/operations/subscribe.md#one-device) the registry to the Yandex IoT Core device [topic](../../iot-core/concepts/topic/index.md). {% list tabs group=instructions %} - CLI {#cli} If you do not have the Yandex Cloud CLI yet, [install and initialize it](../../cli/quickstart.md#install). Run this command: ```bash yc iot mqtt subscribe \ --username \ --password \ --topic '$devices//events' \ --qos 1 ``` Where: * `--username` and `--password`: Credentials for authentication with a username and password. * `--topic`: Device topic for sending data or topic alias. * `--qos`: Quality of service (QoS). The command should keep running until the test is complete. {% endlist %} {% list tabs group=instructions %} - Management console {#console} 1. In the [management console](https://console.yandex.cloud), select the folder you are using to complete this tutorial. 1. Navigate to **Cloud Functions**. 1. Select the `my-device-emulator-function` function. 1. In the left-hand menu, select **Testing**. 1. In the **Version tag** list, select `$latest`, which is the most recently created function. 1. Click **Run test**. If the function runs successfully, the **Done** field will show **Function status** and the **Function output** field, the following result: ```json { "statusCode" : 200 } ``` If you subscribed to the Yandex IoT Core device topic, you will get the following JSON strings in your terminal: ```json { "DeviceId":"my-device-id", "TimeStamp":"2024-06-14T15:29:59Z", "Values":[ {"Type":"Float","Name":"Humidity","Value":"80.84"}, {"Type":"Float","Name":"Temperature","Value":"25.46"}, {"Type":"Bool","Name":"Water sensor","Value":"False"}, {"Type":"Bool","Name":"Smoke sensor","Value":"False"}, {"Type":"Bool","Name":"Room door sensor","Value":"False"}, {"Type":"Bool","Name":"Rack door sensor","Value":"False"} ] } ``` {% endlist %} ### Create a trigger to invoke the function once per minute {#minute-trigger} {% list tabs group=instructions %} - Management console {#console} 1. In the [management console](https://console.yandex.cloud), select the folder you are using to complete this tutorial. 1. Navigate to **Cloud Functions**. 1. In the left-hand panel, select **Triggers**. 1. Click **Create trigger**. 1. In the **Name** field, enter a name for the trigger, e.g., `my-emulator-function-trigger`. 1. In the **Type** field, select `Timer`. 1. In the **Cron expression** field, enter `* * * * ? *` (invoke once per minute). 1. Under **Function settings**, enter the parameters previously set for the function: * **Function**: `my-device-emulator-function` * **Function version tag**: `$latest` * **Service account**: `my-emulator-function-service-account` 1. Optionally, configure the **Repeat request settings** and **Dead Letter Queue settings** sections to protect data against loss. * **Repeat request settings** enable automatic retries if the current function invocation fails. * **Dead Letter Queue settings** enable redirecting messages that consumers failed to process in regular [queues](../../message-queue/concepts/queue.md). You can configure a standard message queue as a DLQ. If you do not have a message queue yet, [create one in Yandex Message Queue](../../message-queue/operations/message-queue-new-queue.md). 1. Click **Create trigger**. {% endlist %} ### Create a function to process incoming data {#processing-function} {% list tabs group=instructions %} - Management console {#console} 1. In the [management console](https://console.yandex.cloud), select the folder you are using to complete this tutorial. 1. Navigate to **Cloud Functions**. 1. In the left-hand panel, select **Functions**. 1. Create a function: 1. Click **Create function**. 1. In the **Name** field, enter a name for the function, e.g., `my-monitoring-func`. 1. Click **Create**. 1. Create a function version: 1. In the **Editor** window that opens, select `Python 3.12`. 1. Disable **Add files with code examples**. 1. Click **Continue**. 1. In the **Code source** field, select `Code editor`. 1. Click **Create file**: * File name: `monitoring.py`. * File contents: Function code from [GitHub](https://github.com/yandex-cloud-examples/yc-server-room-iot-monitoring/blob/master/monitoring.py). Within this function, the `makeAllMetrics` method handles the processing of data to send to the monitoring service. If you want to add or remove parameters, make changes to this method. 1. In the **Entry point** field, specify `monitoring.msgHandler`. 1. Under **Parameters**, specify: * **Timeout**: `10`. * **Memory**: `128 MB`. * **Service account**: `my-metrics-function-service-account`. * **Environment variables**: Key | Description | Value :--- | :--- | :--- `VERBOSE_LOG` | Enabling or disabling data logging | `True` `METRICS_FOLDER_ID` | ID of the folder where you deployed the services and for which you will create a dashboard in Monium.Metrics. | See the [management console](https://console.yandex.cloud). 1. Click **Save changes**. {% endlist %} ### Test the data processing function {#test-processing-function} {% list tabs group=instructions %} - Management console {#console} 1. In the [management console](https://console.yandex.cloud), select the folder you are using to complete this tutorial. 1. Navigate to **Cloud Functions**. 1. Select the `my-monitoring-func` function. 1. In the left-hand menu, select **Testing**. 1. In the **Version tag** list, select `$latest`, which is the most recently created function. 1. In the **Payload** field, paste the following data: ```json { "messages": [ { "event_metadata": { "event_id": "160d239876d9714800", "event_type": "yandex.cloud.events.iot.IoTMessage", "created_at": "2020-05-08T19:16:21.267616072Z", "folder_id": "b112345678910" }, "details": { "registry_id": "are1234567890", "device_id": "are0987654321", "mqtt_topic": "$devices/are0987654321/events", "payload": "eyJWYWx1ZXMiOiBbeyJUeXBlIjogIkZsb2F0IiwgIlZhbHVlIjogIjI1Ljc0IiwgIk5hbWUiOiAiSHVtaWRpdHkifSwgeyJUeXBlIjogIkZsb2F0IiwgIlZhbHVlIjogIjgwLjY1IiwgIk5hbWUiOiAiVGVtcGVyYXR1cmUifSwgeyJUeXBlIjogIkJvb2wiLCAiVmFsdWUiOiAiRmFsc2UiLCAiTmFtZSI6ICJXYXRlciBzZW5zb3IifSwgeyJUeXBlIjogIkJvb2wiLCAiVmFsdWUiOiAiRmFsc2UiLCAiTmFtZSI6ICJTbW9rZSBzZW5zb3IifSwgeyJUeXBlIjogIkJvb2wiLCAiVmFsdWUiOiAiRmFsc2UiLCAiTmFtZSI6ICJSb29tIGRvb3Igc2Vuc29yIn0sIHsiVHlwZSI6ICJCb29sIiwgIlZhbHVlIjogIkZhbHNlIiwgIk5hbWUiOiAiUmFjayBkb29yIHNlbnNvciJ9XSwgIlRpbWVTdGFtcCI6ICIyMDIwLTA1LTIxVDIzOjEwOjE2WiIsICJEZXZpY2VJZCI6ICIwZTNjZTFkMC0xNTA0LTQzMjUtOTcyZi01NWM5NjEzMTk4MTQifQ==" } }] } ``` 1. Click **Run test**. If the function runs successfully, the **Done** field will show **Function status** and the **Function output** field, the following result: ```json { "statusCode" : 200 , "headers" : { "Content-Type" : "text/plain" }, "isBase64Encoded" : false } ``` {% endlist %} ### Create a trigger to invoke the data processing function on a signal {#signal-trigger} The trigger will invoke the function when a message appears in the [device topic](../../iot-core/concepts/topic/devices-topic.md). {% list tabs group=instructions %} - Management console {#console} 1. In the [management console](https://console.yandex.cloud), select the folder you are using to complete this tutorial. 1. Navigate to **Cloud Functions**. 1. In the left-hand panel, select **Triggers**. 1. Click **Create trigger**. 1. In the **Name** field, enter a name for the trigger, e.g., `my-monitoring-func-trigger`. 1. In the **Type** field, select `IoT Core (device)`. 1. Under **IoT Core message settings**, enter the parameters previously set for the registry and device: * **Registry**: `my-registry`. * **Device**: `my-device`. * **MQTT topic**: `$devices//events`, where `` is the device ID in **Yandex IoT Core**. 1. Under **Function settings**, enter the parameters previously set for the function: * **Function**: `my-monitoring-func`. * **Function version tag**: `$latest`. * **Service account**: `my-metrics-function-service-account` 1. Optionally, configure the **Repeat request settings** and **Dead Letter Queue settings** sections to protect data against loss. * **Repeat request settings** enable automatic retries if the current function invocation fails. * **Dead Letter Queue settings** enable redirecting messages that consumers failed to process in regular [queues](../../message-queue/concepts/queue.md). You can configure a standard message queue as a DLQ. If you do not have a message queue yet, [create one in Yandex Message Queue](../../message-queue/operations/message-queue-new-queue.md). 1. Click **Create trigger**. All data from the device will be automatically sent to **Monium.Metrics**. {% endlist %} ## Set up sensor reading monitoring {#configure-monitoring} [Monium.Metrics](../../monitoring/index.md) dashboards are used to monitor sensor readings. The controller sends readings to the server every 60 seconds using MQTT. When they reach the specified limits, Monium.Metrics sends notifications to users. {% cut "Data transmission format" %} ```json { "DeviceId":"e7a68b2d-464e-4222-88bd-c9e8********", "TimeStamp":"2020-05-21T10:16:43Z", "Values":[{ "Type":"Float", "Name":"Humidity", "Value":"12.456" }, { "Type":"Float", "Name":"Temperature", "Value":"-23.456" }, { "Type":"Bool", "Name":"Water sensor", "Value":"false" }, { "Type":"Bool", "Name":"Smoke sensor", "Value":"false" }, { "Type":"Bool", "Name":"Room door sensor", "Value":"true" }, { "Type":"Bool", "Name":"Rack door sensor", "Value":"false"} ] } ``` {% endcut %} Set up sensor reading monitoring: create [charts](../../monitoring/concepts/visualization/widget.md#chart) on the [dashboard](../../monitoring/concepts/visualization/dashboard.md), [notification channel](../../monitoring/concepts/alerting/notification-channel.md), and [alert](../../monitoring/concepts/alerting/alert.md). ### Create a dashboard {#create-dashboard} {% list tabs group=instructions %} - Monium.Metrics UI {#console} 1. In the [management console](https://console.yandex.cloud), select the folder you are using to complete this tutorial. 1. Navigate to **Monitoring**. 1. Navigate to the **Dashboards** tab. 1. Click **Create**. 1. At the top right, click **Save**. 1. In the window that opens, enter a name for the dashboard and click **Save**. {% endlist %} ### Create charts {#create-diagrams} Create a temperature variation chart: {% list tabs group=instructions %} - Monium.Metrics UI {#console} 1. In the [management console](https://console.yandex.cloud), select the folder you are using to complete this tutorial. 1. Navigate to **Monitoring**. 1. Navigate to the **Dashboards** tab. 1. Next to the dashboard name, click ![image](../../_assets/console-icons/ellipsis.svg) and select **Edit**. 1. In the bottom section, click **Graph**. 1. Create a query for the chart: 1. In the query editor, click ![image](../../_assets/console-icons/plus.svg). 1. In the list of services (**service=**), select `Custom Metrics`. 1. In the list of chart types (**name=**), select `Temperature`, which is room temperature. 1. In the **device_id=** list, select the ID of the device for which you want to create a chart. 1. At the top right, click **Save**. Create other charts in a similar way: * `Humidity`: Room air humidity. * `Water sensor`: Water on the floor (yes/no). * `Smoke sensor`: Smoke in the room (yes/no). * `Room door sensor`: Room door state (open/closed). * `Rack door sensor`: Server rack door state (open/closed). The dashboard is available to all Yandex Cloud users with the `viewer` role via the link. You can customize it, zoom in or out, and enable or disable auto-refresh. {% endlist %} ### Test the charts on the dashboard {#test-dashboard} If you change the baselines in the environment variables of the emulation function, you will see these changes in the charts. {% list tabs group=instructions %} - Management console {#console} 1. In the [management console](https://console.yandex.cloud), select the folder you are using to complete this tutorial. 1. Navigate to **Cloud Functions**. 1. Select the `my-device-emulator-function` function. 1. Click the **Editor** tab. 1. Change some original variable values as you like under **Environment variables** in the **Value** field at the bottom of the window. Key | Original value | New value :--- | :--- | :--- `HUMIDITY_SENSOR_VALUE` | `80.15` | `40` `TEMPERATURE_SENSOR_VALUE` | `25.25` | `15` `RACK_DOOR_SENSOR_VALUE` | `False` | `True` `ROOM_DOOR_SENSOR_VALUE` | `False` | `True` `SMOKE_SENSOR_VALUE` | `False` | `True` `WATER_SENSOR_VALUE` | `False` | `True` 1. Click **Save changes** and wait for the operation to complete. {% endlist %} {% list tabs group=instructions %} - Monium.Metrics UI {#console} 1. In the [management console](https://console.yandex.cloud), select the folder you are using to complete this tutorial. 1. Navigate to **Monitoring** and see how the chart indicators have changed. {% endlist %} ### Create a notification channel {#create-channel} Customize a list of recipients and select a notification method. {% list tabs group=instructions %} - Monium.Metrics UI {#console} 1. In the [management console](https://console.yandex.cloud), select the folder you are using to complete this tutorial. 1. Navigate to **Monitoring**. 1. Navigate to the **Notification channels** tab. 1. Click **Create channel**. 1. In the **Name** field, specify a name for the channel, e.g., `my-message-channel`. 1. From the **Method** list, select `Email`. You can also set up notifications through text messages, push, or Telegram. 1. In the **Recipients** list, select an account. You can select multiple recipients for notifications. You can specify the accounts of users having access to your [cloud](../../resource-manager/concepts/resources-hierarchy.md#cloud) as recipients. Learn more about how to add users to Yandex Cloud [here](../../organization/operations/add-account.md). 1. Click **Create**. {% endlist %} ### Create an alert {#create-alerts} Create an alert based on the room temperature sensor readings and connect the created notification channel to it. Monium.Metrics will send this alert to the recipients if the temperature sensor in the server room shows a certain temperature within a certain period (`5 minutes`): * `50 degrees`: `Warning` alert. * `70 degrees`: `Alarm` alert (critical value). {% list tabs group=instructions %} - Monium.Metrics UI {#console} 1. In the [management console](https://console.yandex.cloud), select the folder you are using to complete this tutorial. 1. Navigate to **Monitoring**. 1. Click **Create alert**. 1. In the **Name** field, enter a name for the alert. 1. Under **Alert configuration**, click ![image](../../_assets/console-icons/plus.svg) and fill out the fields: 1. In the list of services (**service=**), select `Custom Metrics`. 1. In the list of alert types (**name=**), select `Temperature`. 1. In the **device_id=** list, select the ID of the device for which you want to create an alert. 1. Under **Alert conditions**, set the alert trigger conditions: 1. In the **Aggregation function** list, select `Average`. 1. In the **Comparison function** list, select `Greater than`. 1. In the **Warning** field, enter `50`. 1. In the **Alarm** field, enter `70`. 1. In the **Evaluation window** list, select `5 minutes`. 1. Under **Notifications**, click **Edit**, and then **Add**. 1. In the window that opens, select `my-message-channel` in the **Notification method** field and click **Add**. 1. At the bottom of the window, click **Create**. {% endlist %} You can create and configure alerts for any metric in Monium.Metrics. Once you complete this tutorial: * You will be able to monitor sensor readings on the charts. * If sensor readings reach the specified limits, you will receive notifications. ## How to delete the resources you created {#cleanup} To stop paying for the resources you created: * [Delete the registry in Yandex IoT Core](../../iot-core/operations/registry/registry-delete.md). * [Delete the device in Yandex IoT Core](../../iot-core/operations/device/device-delete.md). * [Delete the functions in Cloud Functions](../../functions/operations/function/function-delete.md). * [Delete the triggers invoking functions in Cloud Functions](../../functions/operations/trigger/trigger-delete.md). * [Delete the dashboard in Monium.Metrics](../../monitoring/operations/dashboard/delete-dashboard.md). * [Delete the alert in Monium.Metrics](../../monitoring/operations/alert/delete-alert.md). * Delete the [notification channel](../../monitoring/concepts/alerting/notification-channel.md) in Monium.Metrics.