Zidium

Пользовательские проверки выполняет ваше приложение, и через Api присылает в Zidium результат.

Прежде чем реализовывать пользовательскую проверку, посмотрите — нет ли такого функционала среди Системных проверок. Системные проверки использовать легче, для них не нужно писать никакого кода.

Подробнее о принципах работы проверок читайте в статье Проверки (принцип работы)

Для отправки пользовательской проверки используйте следующий код:

// Получим проверку, если её ещё нет, то проверка будет создана автоматически
var unitTest = component.GetOrCreateUnitTestControl("CookieTransportService.DataCollectionTest");
// Отправим проверку, актуальную 10 минут
unitTest.SendResult(UnitTestResult.Success, TimeSpan.FromMinutes(10), "Приложение работает нормально");

В этом примере предполагается, что вы уже получили и запомнили компонент в переменной component. Как это сделать, читайте в разделе Компоненты (How To).

Вы можете сохранить unitTest где-то в своём приложении, чтобы не получать проверку заново при каждой отправке результата.

Чтобы отправлять результат, нужно сначала создать тип проверки и саму проверку.

Для создания или получения типа проверки выполните POST-запрос:

Url запроса

http://ИмяВашегоАккаунта.api.zidium.net/1.0/GetOrCreateUnitTestType

Тело запроса
{
    "Token": {
        "SecretKey": "caf508d2-XXXX-XXXX-XXXX-6a2ef73a2b49"
    },
    "Data": {
        "SystemName": "CustomUnitTestType",
    }
}

Здесь:

  • Token — раздел с токеном авторизации. В нём:
    • SecretKey — секретный ключ аккаунта, посмотрите в личном кабинете;
  • Data — раздел с данными типа проверки. В нём:
    • SystemName — системное имя типа проверки. Если вы не знаете, что указать, используйте "CustomUnitTestType".

В ответ возвратится сообщение следующего формата:

{
    "Data": {
        "Id": "fc72502c-f7d5-4ac4-8425-ea0fda94b5e8",
        "SystemName": "CustomUnitTestType",
        "DisplayName": "CustomUnitTestType",
        "IsSystem": false
    },
    "Code": 10
}

Нужно убедиться, что Code равно 10, что означает успешное выполнение. Из ответа нужно взять и сохранить Id, это Id типа проверки, который потребуется на следующем шаге для получения проверки.

Для создания или получения проверки выполните POST-запрос:

Url запроса

http://ИмяВашегоАккаунта.api.zidium.net/1.0/GetOrCreateUnitTest

Тело запроса
{
    "Token": {
        "SecretKey": "caf508d2-XXXX-XXXX-XXXX-6a2ef73a2b49"
    },
    "Data": {
        "ComponentId": "11111111-2222-3333-4444-555555555555",
        "UnitTestTypeId":"fc72502c-f7d5-4ac4-8425-ea0fda94b5e8",
        "SystemName": "CookieTransportService.DataCollectionTest"}
}

Здесь:

  • Token — раздел с токеном авторизации. В нём:
    • SecretKey — секретный ключ аккаунта, посмотрите в личном кабинете;
  • Data — раздел с данными типа проверки. В нём:
    • ComponentId — Id компонента, для которого создаётся проверка. Его можно посмотреть в личном кабинете на странице компонента;
    • UnitTestTypeId — Id типа проверки, из ответа на предыдущем шаге;
    • SystemName — системное имя проверки, должно быть уникальным.

В ответ возвратится сообщение следующего формата:

{
    "Data": {
        "Id": "c40b3723-7952-4592-a184-c62d890fa5aa",
        "TypeId": "fc72502c-f7d5-4ac4-8425-ea0fda94b5e8",
        "SystemName": "CookieTransportService.DataCollectionTest",
        "DisplayName": "CookieTransportService.DataCollectionTest"
    },
    "Code": 10
}

Нужно убедиться, что Code равно 10, что означает успешное выполнение. Из ответа нужно взять и сохранить Id, это Id проверки, который потребуется на следующем шаге для отправки результата. Однажды получив Id проверки, вы можете сохранить его где-то в своём приложении, чтобы не получать проверку каждый раз при отправке результата.

Для отправки результата пользовательской проверки выполните POST-запрос:

Url запроса

http://ИмяВашегоАккаунта.api.zidium.net/1.0/SendUnitTestResult

Тело запроса
{
    "Token": {
        "SecretKey": "caf508d2-XXXX-XXXX-XXXX-6a2ef73a2b49"
    },
    "Data": {
        "UnitTestId": "c40b3723-7952-4592-a184-c62d890fa5aa",
        "Result": "Success",
        "Message": "Приложение работает нормально",
        "ActualIntervalSeconds": 600
    }
}

Здесь:

  • Token — раздел с токеном авторизации. В нём:
    • SecretKey — секретный ключ аккаунта, посмотрите в личном кабинете;
  • Data — раздел с данными проверки. В нём:
    • UnitTestId — Id проверки, для которой отправляется результат, из ответа на предыдущем шаге;
    • Result — результат проверки, может быть Success, Warning, Alarm;
    • Message — текст результата проверки;
    • ActualIntervalSeconds — интервал актуальности в секундах.

В примере мы задали интервал актуальности равным 10 минутам. Если в течении 10 минут Zidium не получит новый результат этой проверки от приложения, то будет считаться, что ваше приложение больше не работает правильно, и цвет проверки поменяется на красный. Если вы не хотите такого поведения, то можете указать заведомо большой интервал актуальности.

Подробнее о работе с проверками читайте в разделе Проверки.