Просмотр кода страницы Режим скрипта HTTP-мониторинга

В дополнение к настройке в пользовательском интерфейсе (визуальный режим), вы можете использовать '''режим скрипта''' для настройки ваших '''HTTP-мониторов'''. В этом режиме вы можете получить доступ к базовому скрипту '''JSON''' вашего монитора. Если вы опытный пользователь Синтетического мониторинга, это значительно облегчит вам жизнь и позволит ускорить создание и управление мониторами. Используйте редактор скриптов для быстрого поиска определенных событий (шагов) или адаптации локаторов по всему скрипту.

Вы не ограничены только одним режимом — вы можете переключаться между режимами пользовательского интерфейса и скриптом, выбрав '''Визуальный режим / Режим скрипта'''.

== Доступ к скрипту ==
Чтобы редактировать '''HTTP-монитор''' в '''режиме скрипта''':

# Перейдите в раздел '''Синтетика''' и выберите просмотр мониторов в режиме списка.
# Установите '''флажок''' рядом с монитором, который вы хотите редактировать > выберите '''Редактировать''' в левом нижнем углу.
# Выберите вкладку '''HTTP-запросы''' в настройках монитора слева.
# Выберите '''Режим скрипта''' вверху.

== Редактировать скрипт ==
Вы можете загрузить скрипт ('''Загрузить как скрипт .json''') или просто скопировать его из редактора и редактировать в текстовом редакторе по вашему выбору. Однако вы также можете редактировать скрипт непосредственно в браузере. Это дает следующие преимущества:

* '''Автозаполнение''' — просто нажмите Ctrl+Пробел, чтобы увидеть список предложений.
* '''Подсветка синтаксиса''' - упрощает написание кода скрипта.
* '''Мгновенная проверка ошибок''' — редактор мгновенно показывает предупреждение о любой ошибке в скрипте. Наведите курсор на ошибку, чтобы увидеть, что не так, и получить предложение по ее исправлению. Вы не сможете сохранить изменения, пока код не будет свободен от ошибок.

Обратите внимание, что вам необходимо экранировать все специальные символы и переносить строки с помощью обратной косой черты (например, новая строка — <code>\n</code>, двойные кавычки — <code>\"</code>, а табуляция — <code>\t</code>).

== Структура скрипта ==

=== Параметры скрипта ===

==== Основной объект скрипта ====
Содержит скрипт монитора.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|version
|string
|Версия скрипта — используйте значение здесь <code>1.0</code>.
|необходимый
|-
|requests
|Array of:
request
|Список HTTP-запросов, которые должен выполнить монитор
Запросы выполняются в том порядке, в котором они указаны в скрипте.
|необходимый
|}

==== Объект <code>request</code> ====
Содержит параметры HTTP-запроса.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|description
|string
|Краткое описание события, которое будет отображаться в веб-интерфейсе.
|необязательный
|-
|url
|string
|URL для проверки
|необходимый
|-
|method
|string
|HTTP-метод запроса
|необходимый
|-
|requestBody
|string
|Тело HTTP-запроса — необходимо экранировать все символы JSON.
Устанавливается в значение null, если метод запроса — GET, HEAD или OPTIONS.
|необязательный
|-
|validation
|requestValidation
|Конфигурация проверки запроса
Проверка помогает вам убедиться, что ваш HTTP-монитор загружает ожидаемый контент.
|необязательный
|-
|configuration
|requestConfiguration
|Настройка монитора
|необязательный
|-
|preProcessingScript
|string
|Скрипт , выполненный до запроса
Необходимо экранировать все символы JSON и переносить строки с помощью <code>/n</code>.
|необязательный
|-
|postProcessingScript
|string
|Скрипт , выполненный после запроса
Необходимо экранировать все символы JSON и переносить строки с помощью <code>/n</code>.
|необязательный
|}

==== Объект <code>requestValidation</code> ====
Содержит конфигурацию проверки для запроса.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|rules
|Array of:
validationRule
|Список правил проверки
|необязательный
|}
Для проверки '''HTTP-монитора''' оцениваются следующие типы правил (см. validationRule):

* Проверка кода статуса ответа
* Проверка текста, при которой тело ответа проверяется на наличие строки текста или регулярного выражения.
* Проверка срока действия SSL-сертификата

Это означает, что монитор не будет работать, если хотя бы одно из этих правил со знаком <code>passIfFound</code> = <code>false</code> будет выполнено или хотя бы одно правило со знаком <code>passIfFound</code> = <code>true</code> не будет выполнено.

Монитор будет успешно выполнен, если все правила со знаком <code>passIfFound</code> = <code>false</code> не выполнены и все правила со знаком <code>passIfFound</code> = <code>true</code>  выполнены.

==== Объект <code>validationRule</code> ====
Содержит правило проверки.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|type
|string
|Тип правила — возможные значения:

* <code>patternConstraint</code> — выполняет простое сопоставление контента.
* <code>regexConstraint</code> — интерпретирует соответствие содержимого как регулярное выражение .
* <code>httpStatusesList</code> — проверяет список кодов статуса HTTP.
* <code>certificateExpiryDateConstraint</code> — проверяет, находится ли срок действия сертификата в пределах указанного количества дней.
|необходимый
|-
|passIfFound
|boolean
|Условие проверки:

* <code>true</code> — проверка считается успешной, если указанный контент/элемент найден.
* <code>false</code> — проверка не пройдена, если указанный контент/элемент найден.

Всегда указывайте <code>false</code> для отказа монитора <code>certificateExpiryDateConstraint</code>, если срок действия SSL-сертификата находится в пределах указанного количества дней.
|необходимый
|-
|value
|string
|Содержание, которое нужно искать
|необходимый
|}

==== Объект <code>requestConfiguration</code> ====
Содержит настройку монитора.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|userAgent
|string
|[https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/User-Agent Пользовательский агент запроса]
|необязательный
|-
|acceptAnyCertificate
|boolean
|Принимать любой (<code>true</code>) или только доверенный (<code>false</code>) SSL-сертификат.

Если установлено значение <code>false</code>, то монитор даст сбой из-за недействительных сертификатов SSL.

Если не задано <code>false</code>, используется опция.
|необязательный
|-
|followRedirects
|boolean
|Следуйте (<code>true</code>) или не следуйте (<code>false</code>) перенаправлениям.
Если установлено значение <code>false</code>, перенаправления регистрируются как успешные запросы с кодом ответа <code>3xx</code>.

Если не задано <code>false</code>, используется опция.
|необязательный
|-
|requestHeaders
|Array of:
requestHeader
|Список дополнительных заголовков для запроса
По умолчанию установлен только заголовок User-Agent. 

Вы не можете установить или изменить этот заголовок здесь. Используйте <code>userAgent</code> для этого поля.
|необязательный
|}

==== Объект<code>requestHeader</code> ====
Содержит HTTP-заголовок запроса.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|name
|string
|Ключ заголовка
|необходимый
|-
|value
|string
|Значение заголовка
|необходимый
|}

=== Модель скрипта ===
Это модель скрипта JSON, показывающая все возможные элементы. Его нужно настроить, чтобы использовать как настоящий скрипт. Чтобы увидеть пример скрипта реального монитора, вы можете проверить любой существующий HTTP-монитор в режиме скрипта.
{| class="wikitable"
|{

  "version": "1.0",

  "requests": [

    {

      "description": "string",

      "url": "string",

      "method": "POST",

      "requestBody": "{\n\"customParameter1\": \"customValue1\",\n\"customParameter2\": true,\n\"customParameter3\": 452\n}",

      "validation": {

        "rules": [

          {

            "type": "patternConstraint",

            "passIfFound": true,

            "value": "string"

          },

          {

            "type": "regexConstraint",

            "passIfFound": true,

            "value": "string"

          }

        ],

        "rulesChaining": "or"

      },

      "configuration": {

        "userAgent": "string",

        "acceptAnyCertificate": false,

        "followRedirects": true,

        "requestHeaders": [

          {

            "name": "string",

            "value": "string"

          }

        ]

      },

      "preProcessingScript": "string",

      "postProcessingScript": "string"

    }

  ]

}
|}