Экспорт данных Интернета вещей в веб-перехватчик

Статья
05/24/2023

В этой статье описывается настройка экспорта данных для отправки данных в веб-перехватчик.

Используйте эту возможность для непрерывного экспорта отфильтрованных и обогащенных данных IoT из приложения IoT Central. Экспорт данных позволяет отправлять изменения практически в реальном времени в другие компоненты облачного решения для получения когнитивных аналитических сведений по принципу "теплого пути", а также для хранения.

Например, доступны следующие возможности:

Непрерывно экспортируйте данные телеметрии, изменения свойств, подключение устройств, жизненный цикл устройства, жизненный цикл шаблона устройства и данные журнала аудита в формате JSON практически в реальном времени.
фильтровать потоки данных для экспорта данных, соответствующих пользовательским условиям;
обогащать потоки данных с помощью пользовательских значений и значений свойств с устройства;
Преобразуйте потоки данных для изменения их фигуры и содержимого.

Совет

При включении экспорта данных вы получаете данные только начиная с этого момента. Чтобы сохранить больше исторических данных, включайте экспорт непрерывных данных заранее. Чтобы вручную экспортировать данные из времени отключения экспорта данных, см. инструкции по использованию REST API IoT Central для запроса устройств.

Примечание.

В некоторых случаях для экспорта сообщений может потребоваться до 60 секунд. Это время измеряется, когда IoT Central получает сообщение от базового Центра Интернета вещей до момента доставки сообщения в конечную точку назначения.

Необходимые компоненты

Чтобы использовать функции экспорта данных, необходимо иметь разрешение на экспорт данных.

Настройка назначения экспорта веб-перехватчика

Для назначений веб-перехватчика IoT Central экспортирует данные практически в режиме реального времени. Данные в тексте сообщения имеют тот же формат, что и для Центров событий и служебной шины.

Создание назначения веб-перехватчика

Вы можете экспортировать данные в общедоступную конечную точку веб-перехватчика HTTP. Тестовую конечную точку веб-перехватчика можно создать с помощью RequestBin. RequestBin регулирует запросы при достижении предельного числа запросов:

Перейдите к RequestBin.
Выберите "Создать requestBin".
Войдите с помощью одного из доступных методов.
Скопируйте URL-адрес requestBin, который вы используете при тестировании экспорта данных.

Чтобы создать назначение azure Data Обозреватель в IoT Central на странице экспорта данных:

Нажмите кнопку + New destination (Создать назначение).
Выберите веб-перехватчик в качестве типа назначения.
Вставьте URL-адрес обратного вызова для конечной точки веб-перехватчика. При необходимости можно настроить авторизацию веб-перехватчика и добавить пользовательские заголовки.
- Для OAuth2.0 поддерживается только поток предоставления учетных данных клиента. При сохранении назначения IoT Central взаимодействует с поставщиком OAuth для получения маркера авторизации. Этот маркер присоединен к заголовку Authorization для каждого сообщения, отправленного в это назначение.
- Для маркера авторизации можно указать значение маркера, которое напрямую подключено к заголовку Authorization для каждого сообщения, отправленного в это назначение.
Выберите Сохранить.

Пример конфигурации OAuth 2.0

В этом примере показано, как настроить назначение веб-перехватчика для использования приложения-функции Azure, защищенного с помощью входа Microsoft Entra:

Параметр	Пример	Примечания.
Тип назначения	Веб-перехватчик
URL-адрес обратного вызова	`https://myapp.azurewebsites.net/api/HttpExample`	URL-адрес функции.
Авторизация	OAuth 2.0
URL-адрес токена	`https://login.microsoftonline.com/your-tenant-id/oauth2/v2.0/token`	URL-адрес, используемый для получения маркера. Это значение можно найти в приложении-функции: проверка подлинности > конечной точки > поставщика > удостоверений Майкрософт OAuth 2.0 (версия 2)
Client ID	`your-client-id`	Идентификатор клиента приложения-функции. Это значение можно найти в приложении-функции: проверка подлинности > идентификатора приложения поставщика > удостоверений Майкрософт (клиента)
Секрет клиента	`your-client-secret`	Секрет клиента приложения-функции. Это значение можно найти в приложении-функции: проверка подлинности > сертификатов поставщика > удостоверений Майкрософт и секретов
Аудитория	Н/П	Пусто, если вы используете приложение-функцию.
Область	`https://your-client-id/.default`	Область маркера. Для приложения-функции используйте значение идентификатора клиента.**
Тип контента запроса токена	Автоматически

Для других назначений веб-перехватчика могут потребоваться разные значения для этих параметров.

Настройка экспорта данных

Теперь, когда у вас есть назначение для экспорта данных, настройте экспорт в приложении IoT Central:

Войдите в приложение IoT Central.
На панели слева выберите элемент Экспорт данных.

Совет

Если вы не видите элемент Экспорт данных на панели слева, у вас нет разрешений на настройку экспорта данных в приложении. Обратитесь к администратору, чтобы настроить экспорт данных.
Выберите + Новый экспорт.
Введите отображаемое имя для нового экспорта и убедитесь, что экспорт данных включен.

Выберите тип данных для экспорта. В следующей таблице перечислены поддерживаемые типы данных.

Тип данных	Description	Формат данных
Телеметрия	Экспорт сообщений телеметрии с устройств практически в реальном времени. Каждое экспортированное сообщение содержит полное содержимое исходного сообщения устройства в нормализованном виде.	Формат сообщения телеметрии
Изменения свойств	Экспорт изменений в свойствах устройства и облака практически в реальном времени. Для свойств устройств, доступных только для чтения, экспортируются изменения в сообщаемых значениях. Для свойств, доступных для чтения и записи, экспортируются и сообщаемые, и требуемые значения.	Формат сообщения об изменении свойства
Взаимодействие устройств	Экспорт подключенных и отключенных устройств.	Формат сообщения о подключении устройства
Жизненный цикл устройства	Экспорт событий регистрации, удаления, подготовки, включения, отключения устройств, а также событий displayNameChanged и deviceTemplateChanged.	Формат сообщения об изменениях жизненного цикла устройства
Жизненный цикл шаблона устройства	Экспорт опубликованных изменений шаблонов устройств, включая создание, обновление и удаление.	Формат сообщения об изменениях жизненного цикла шаблона устройства
Журналы аудита	Журналы обновлений, инициированных пользователем, для сущностей в приложении. Дополнительные сведения см. в статье "Использование журналов аудита для отслеживания действий в приложении IoT Central"	Формат сообщения журнала аудита

При необходимости добавьте фильтры, чтобы уменьшить объем экспортируемых данных. Есть несколько типов фильтров, доступных для каждого типа экспорта данных:

Тип данных	Доступные фильтры
Телеметрия	Фильтрация по имени, идентификатору и шаблону устройства, а также при имитации устройства. Фильтрация потока, чтобы он содержал только данные телеметрии, соответствующие условиям фильтра. Фильтрация потока, чтобы он содержал только данные телеметрии с устройств со свойствами, соответствующими условиям фильтра. Фильтруйте поток, чтобы содержать только данные телеметрии с свойствами сообщения, которые соответствуют условию фильтра. Свойства сообщения (также известные как свойства приложения) отправляются в контейнер пар "ключ-значение" для каждого сообщения телеметрии. Чтобы создать фильтр свойств сообщения, введите искомый ключ свойства сообщения и укажите условие. Экспортируются только сообщения телеметрии со свойствами, соответствующими заданному условию фильтра. Дополнительные сведения о свойствах приложений из документов Центра Интернета вещей
Изменения свойств	Фильтрация по имени, идентификатору и шаблону устройства, а также при имитации устройства. Фильтрация потока, чтобы он содержал только изменения свойств, соответствующие условиям фильтра.
Взаимодействие устройств	Фильтрация по имени устройства, идентификатору устройства, шаблону устройства, организациям и, если устройство имитируется Фильтрация потока, чтобы он содержал только изменения с устройств со свойствами, соответствующими условиям фильтра.
Жизненный цикл устройства	Фильтрация по имени, идентификатору и шаблону устройства, а также при имитации, включении и подготовке устройства. Фильтрация потока, чтобы он содержал только изменения с устройств со свойствами, соответствующими условиям фильтра.
Жизненный цикл шаблона устройства	Фильтрация по шаблону устройства
Журналы аудита	Н/П

При необходимости обогатите экспортированные сообщения с дополнительными метаданными пары "ключ-значение". Следующие обогащения доступны для экспорта данных телеметрии, изменений свойств, подключений устройства и жизненного цикла устройства:
- Пользовательская строка: добавляет пользовательскую статическую строку к каждому сообщению. Введите любой ключ и строковое значение.
- Свойство, которое добавляется в каждое сообщение:
  - Метаданные устройства, такие как имя устройства, имя шаблона устройства, включено, организации, подготовленные и имитированные.
  - Текущее свойство сообщаемого устройства или значение облачного свойства для каждого сообщения. Если экспортированное сообщение отправлено с устройства, у которого нет указанного свойства, экспортированное сообщение не получает обогащения.

Настройте назначение экспорта:

Выберите +Назначение , чтобы добавить место назначения, которое вы уже создали или нажмите кнопку "Создать новую".
Чтобы преобразовать данные перед экспортом, нажмите кнопку +Преобразовать. Дополнительные сведения см. в статье "Преобразование данных в приложении IoT Central" для экспорта.
Выберите +Назначение , чтобы добавить до пяти назначений в один экспорт.
Завершив настройку экспорта, нажмите кнопку Сохранить. Через несколько минут ваши данные будут отображаться в выбранном назначении.

Мониторинг экспорта

На странице экспорта данных в IoT Central можно проверка состояние экспорта. Вы также можете использовать Azure Monitor , чтобы узнать, сколько данных вы экспортируете и какие-либо ошибки экспорта. Вы можете получить доступ к метрикам экспорта и работоспособности устройств в диаграммах в портал Azure с помощью REST API, запросов в PowerShell или Azure CLI. Сейчас в Azure Monitor можно отслеживать следующие метрики экспорта данных:

число сообщений, входящих в экспорт до применения фильтров;
число сообщений, прошедших через фильтры;
число сообщений, успешно экспортированных в назначения.
Количество обнаруженных ошибок.

Дополнительные сведения см. в статье Мониторинг работоспособности приложения.

Форматы данных

В следующих разделах описываются форматы экспортированных данных:

Формат телеметрии

Каждое экспортированное сообщение содержит нормализованную форму полного сообщения, отправленного устройством в тексте сообщения. Сообщение представлено в формате JSON и кодируется как UTF-8. В каждом сообщении содержатся следующие сведения:

applicationId: идентификатор приложения IoT Central.
messageSource: источник сообщения — telemetry.
deviceId: идентификатор устройства, с которого было отправлено сообщение телеметрии.
schema: имя и версия схемы полезных данных.
templateId: идентификатор шаблона устройства, назначенного устройству.
enqueuedTime: время, в течение которого IoT Central получил это сообщение.
enrichments: все обогащения, настроенные для экспорта.
module: модуль IoT Edge, который отправил это сообщение. Это поле отображается только в том случае, если сообщение поступило из модуля IoT Edge.
component: компонент, который отправил это сообщение. Это поле отображается только в том случае, если возможности, отправленные в сообщении, были смоделированы как компонент в шаблоне устройства.
messageProperties: другие свойства, отправляемые устройством с сообщением. Эти свойства иногда называют свойствами приложения. Дополнительные сведения см. в документах Центра Интернета вещей.

Свойства сообщения

Сообщения телеметрии имеют свойства для метаданных, а также полезные данные телеметрии. В предыдущем фрагменте показаны примеры системных сообщений, таких как deviceId и enqueuedTime. Дополнительные сведения о свойствах системных сообщений см. в разделе Системные свойства сообщений Центра Интернета вещей D2C.

Свойства можно добавить в сообщения телеметрии, если необходимо добавить пользовательские метаданные в сообщения телеметрии. Например, необходимо добавить отметку времени при создании сообщения устройством.

В следующем фрагменте кода показано, как добавить свойство iothub-creation-time-utc в сообщение при его создании на устройстве:

Внимание

Такая метка времени должна быть в формате UTC без сведений о часовом поясе. Например, 2021-04-21T11:30:16Z использовать можно, а 2021-04-21T11:30:16-07:00 — нет.

async function sendTelemetry(deviceClient, index) {
  console.log('Sending telemetry message %d...', index);
  const msg = new Message(
    JSON.stringify(
      deviceTemperatureSensor.updateSensor().getCurrentTemperatureObject()
    )
  );
  msg.properties.add("iothub-creation-time-utc", new Date().toISOString());
  msg.contentType = 'application/json';
  msg.contentEncoding = 'utf-8';
  await deviceClient.sendEvent(msg);
}

private static void sendTemperatureTelemetry() {
  String telemetryName = "temperature";
  String telemetryPayload = String.format("{\"%s\": %f}", telemetryName, temperature);

  Message message = new Message(telemetryPayload);
  message.setContentEncoding(StandardCharsets.UTF_8.name());
  message.setContentTypeFinal("application/json");
  message.setProperty("iothub-creation-time-utc", Instant.now().toString());

  deviceClient.sendEventAsync(message, new MessageIotHubEventCallback(), message);
  log.debug("My Telemetry: Sent - {\"{}\": {}°C} with message Id {}.", telemetryName, temperature, message.getMessageId());
  temperatureReadings.put(new Date(), temperature);
}

private async Task SendTemperatureTelemetryAsync()
{
  const string telemetryName = "temperature";

  string telemetryPayload = $"{{ \"{telemetryName}\": {_temperature} }}";
  using var message = new Message(Encoding.UTF8.GetBytes(telemetryPayload))
  {
      ContentEncoding = "utf-8",
      ContentType = "application/json",
  };
  message.Properties.Add("iothub-creation-time-utc", DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ssZ"));
  await _deviceClient.SendEventAsync(message);
  _logger.LogDebug($"Telemetry: Sent - {{ \"{telemetryName}\": {_temperature}°C }}.");
}

async def send_telemetry_from_thermostat(device_client, telemetry_msg):
    msg = Message(json.dumps(telemetry_msg))
    msg.custom_properties["iothub-creation-time-utc"] = datetime.now(timezone.utc).isoformat()
    msg.content_encoding = "utf-8"
    msg.content_type = "application/json"
    print("Sent message")
    await device_client.send_message(msg)

Формат изменения свойства

Каждое сообщение или запись представляет одно изменение в свойствах устройства или облака. В экспортированном сообщении содержатся следующие сведения:

applicationId: идентификатор приложения IoT Central.
messageSource: источник сообщения — properties.
messageType: cloudPropertyChange, devicePropertyDesiredChange или devicePropertyReportedChange.
deviceId: идентификатор устройства, с которого было отправлено сообщение телеметрии.
schema: имя и версия схемы полезных данных.
enqueuedTime: время, в течение которого IoT Central обнаружила это изменение.
templateId: идентификатор шаблона устройства, назначенного устройству.
properties: массив измененных свойств, включая имена измененных свойств и значений. Сведения о компоненте и модуле включаются в том случае, если свойство моделируется внутри компонента или модуля IoT Edge.
enrichments: все обогащения, настроенные для экспорта.

Формат изменения подключения устройства

Каждое сообщение или запись представляет событие подключения с одного устройства. В экспортированном сообщении содержатся следующие сведения:

applicationId: идентификатор приложения IoT Central.
messageSource: источник сообщения — deviceConnectivity.
messageType: connected или disconnected.
deviceId: идентификатор измененного устройства.
schema: имя и версия схемы полезных данных.
templateId: идентификатор шаблона устройства, назначенного устройству.
enqueuedTime: время, когда это изменение произошло в IoT Central.
enrichments: все обогащения, настроенные для экспорта.

Формат изменения жизненного цикла устройства

Каждое сообщение или запись представляет одно изменение для одного устройства. В экспортированном сообщении содержатся следующие сведения:

applicationId: идентификатор приложения IoT Central.
messageSource: источник сообщения — deviceLifecycle.
messageType: тип произошедшего изменения. Одно из значений: registered, deleted, provisioned, enabled, disabled, displayNameChanged или deviceTemplateChanged.
deviceId: идентификатор измененного устройства.
schema: имя и версия схемы полезных данных.
templateId: идентификатор шаблона устройства, назначенного устройству.
enqueuedTime: время, когда это изменение произошло в IoT Central.
enrichments: все обогащения, настроенные для экспорта.

Формат изменения жизненного цикла шаблона устройства

Каждое сообщение или запись представляет одно изменение в одном опубликованном шаблоне устройства. В экспортированном сообщении содержатся следующие сведения:

applicationId: идентификатор приложения IoT Central.
messageSource: источник сообщения — deviceTemplateLifecycle.
messageType: created, updated или deleted.
schema: имя и версия схемы полезных данных.
templateId: идентификатор шаблона устройства, назначенного устройству.
enqueuedTime: время, когда это изменение произошло в IoT Central.
enrichments: все обогащения, настроенные для экспорта.

Формат журналов аудита

Каждое сообщение журнала аудита представляет собой изменение, инициированное пользователем, на сущность, доступную для аудита, в приложении IoT Central. В экспортированном сообщении содержатся следующие сведения:

actor: сведения о пользователе, который изменил сущность.
applicationId: идентификатор приложения IoT Central.
messageSource: источник сообщения — audit.
messageType: тип произошедшего изменения. Одно из: updated, created, deleted.
updated: имеется только в том updatedслучаеmessageType. Дополнительные сведения об обновлении.
resource: сведения об измененной сущности.
schema: имя и версия схемы полезных данных.
deviceId: идентификатор измененного устройства.
enqueuedTime: время, когда это изменение произошло в IoT Central.
enrichments: все обогащения, настроенные для экспорта.

Следующие шаги

Теперь, когда вы знаете, как экспортировать в служебная шина, рекомендуемый следующий шаг — узнать, как экспортировать в Центры событий.