Мониторинг кода возврата команды

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

Об этой задаче

Код возврата могут возвратить созданный пользователем сценарий, исполняемый файл, запрос или системная команда. Код возврата команды - это специфичный для программы механизм, позволяющий определить доступность программы или отслеживаемой системы. Агент выполняет указанную команду и определяет состояние программы или отслеживаемой системы, проанализировав код возврата.

Команда должна представлять уникальный код возврата для каждого описательного состояния. Кроме того, команда должна задавать сообщение, используемое агентом для каждого из кодов возврата. Команда может использовать переменные среды и конфигурации в созданном пользователем сценарии, исполняемом файле, запросе или системной команде. Команда не может использовать переменные среды или конфигурации в вызове командной строки команды, за исключением переменных AGENT_BIN_DIR, AGENT_ETC_DIR, AGENT_LIB_DIR, CANDLE_HOME и CANDLEHOME.

Процедура

  1. На странице Начальный источник данных агента или Положение источника данных выберите Команда или сценарий в области Категории данных мониторинга.
  2. В области Источники данных выберите Код возврата команды.
  3. Нажмите кнопку Далее.
  4. На странице Код возврата команды области Информация о коде возврата укажите выводимое имя.
  5. Выполните следующие действия, чтобы задать и описать строки команд,которые будет использовать код возврата команды.
    Прим.: Задайте команду для каждой операционной системы, поддерживаемой агентом. Команды могут использоваться совместно, но общий набор операционных систем для всех команд должен быть эквивалентен набору операционных систем, поддерживаемых агентом.
    1. В области Команды окна Код возврата команды нажмите Добавить, чтобы открыть окно Информация о команде.
    2. Введите командную строку и выберите операционную систему в списке, находящемся в области Операционная система окна Информация о команде.
      Прим.:
      1. В случае команды Windows нужно ввести полное имя команды. Например, command_to_run.bat, а не просто command_to_run.
      2. Заключите имя в кавычки, чтобы оно не анализировалось интерпретатором команд. Например, введите this is a test.batargument, а не this is a test.bat argument.
      3. Вы можете щелкнуть по команде и нажать кнопку Изменить, чтобы ее изменить, или Удалить, чтобы ее удалить.
    3. Нажмите Добавить в области Коды возврата окна Информация о команде.
    4. Выберите код возврата в списке, показанном в окне Определение кода возврата.

      Для кодов возврата теста можно назначить следующие состояния:

      • ALREADY_RUNNING
      • DEPENDENT_NOT_RUNNING
      • GENERAL_ERROR
      • NOT_RUNNING
      • OK
      • PREREQ_NOT_RUNNING
      • WARNING

    5. Введите числовое значение для выбранного вами типа кода возврата.
      Значение кода возврата - это целое число, которое задает код возврата для кода возврата команды. Для совместимости с разными операционными системами используйте значения кодов возврата в пределах 0 - 255. Если команда будет работать только в Windows, то значение кода возврата может лежать в диапазоне -2147483648 - 2147483647.
    6. Задайте сообщение для каждого кода возврата, чтобы сообщение и код возврата можно было показать вместе. Щелкните по Обзор, чтобы задать текст сообщения.
      Сообщения, заданные в агенте, будут появляться в окне сообщений. Откроется окно Сообщения (список).
      Прим.:
      1. Можно выбрать текст, который вы вводили ранее, выбрав его в списке текстов сообщений, а не использовать функцию Browse. После этого переходите к шагу 5k.
      2. Пока заданных сообщений нет, список будет пустым. Вы можете выбрать Изменить, чтобы модифицировать заданное сообщение, или Удалить, чтобы удалить одно или несколько заданных сообщений.
    7. В окне Сообщения (список) нажмите Добавить.
      Откроется окно Определение сообщения.
      Прим.: Идентификатор сообщения генерируется автоматически.
    8. Введите в поле Текст сообщения текст, описывающий смысл нового сообщения.
    9. Нажмите кнопку ОК.
      Откроется окно Сообщения (список) с новым сообщением.
    10. Чтобы проверить сообщение и сделать его постоянным, выберите его в списке и нажмите кнопку ОК.
      Новый тип кода возврата, значение и текст будут показаны в окне Определение кода возврата.
    11. Если вы хотите, чтобы этот код возврата использовался другими командами в другой операционной системе, то выберите Глобальный код возврата применяется ко всем командам. Если вы хотите, чтобы этот код возврата использовался только этой командой, то оставьте выбранной опцию Локальный код возврата применяется только к данной команде.
    12. Нажмите OK в окне Определение кода возврата.
    13. Прежде чем вы закроете окно Информация о команде, задайте, как минимум, два кода возврата. Один код возврата указывает, что проблем с доступностью нет, а второй означает ошибку. Если вы хотите добавить еще один код возврата, то вернитесь к шагу c.
    14. Необязательно: В окне Информация о команде области Файлы команд нажмите Добавить, чтобы выбрать для выполнения агентом один или несколько сценариев или исполняемых файлов.
      Эти файлы копируются в папку проекта агента в подкаталог scripts/операционная_система, где операционная_система - это переменная, зависящая от сделанного выбора в области Операционные системы окна Информация о команде. Эти файлы упаковываются и распределяются вместе с агентом. Чтобы изменить определение существующего файла команды или исходного файла команды после копирования его в проект, выберите файл и нажмите Правка. Смотрите (Правка определения файла команды).
    15. Нажмите OK в окне Информация о команде.
      Прим.: В таблице командных файлов можно задать все внешние файлы, которые вы хотите включить в пакет агента. Эти файлы копируются в каталог проекта и упаковываются вместе с агентом для распространения.
  6. Если есть другие коды возврата, которые еще не заданы, то задайте и опишите глобальные коды возврата, которые может использовать код возврата команды.
    1. Щелкните по Добавить в области Глобальные коды возврата страницы Код возврата команды.
      Прим.: Коды возврата, заданные здесь - это глобальные коды. Это значит, что они применимы для всех команд, заданных для кода возврата команды. Они не используются кодами возвратов команд. Кроме того, можно задать коды возврата при вводе информации команды. Заданные здесь коды возврата могут быть глобальными или локальными. Локальные коды возврата применяются только с данной конкретной командой. Эта иерархия полезна, если у вас есть код возврата, одинаковый для всех операционных систем. Например, код возврата 0 означает, что все работает правильно. Вы можете определить этот код на глобальном уровне, после чего все заданные команды будут интерпретировать его одним и тем же образом. Если ни одна из других операционных систем не возвращает 5, то код возврата 5 можно задать только для команды Windows. Если вы зададите на локальном уровне команды код возврата, который был задан на глобальном уровне, то будет использоваться код, заданный на уровне команды. Этот метод позволяет переопределить код возврата в той или иной операционной системе. Например, во всех операционных системах UNIX код возврата 2 означает одно и то же, но в Windows этот код означает что-то другое. Можно задать код возврата 2 на глобальном уровне, как ожидаемое значение для операционных систем UNIX. Потом вы можете переопределить значение кода возврата 2 для команды в Windows на уровне этой команды в Windows.
    2. Выберите код возврата в списке, показанном в окне Определение кода возврата.

      Для кодов возврата теста можно назначить следующие состояния:

      • ALREADY_RUNNING
      • DEPENDENT_NOT_RUNNING
      • GENERAL_ERROR
      • NOT_RUNNING
      • OK
      • PREREQ_NOT_RUNNING
      • WARNING
    3. Введите числовое значение для выбранного вами типа кода возврата. Значение кода возврата - это целое число, которое задает код возврата для кода возврата команды.
    4. Нажмите Обзор, чтобы задать текст сообщения и связанное с ним пояснение. Для каждого кода возврата нужно задать сообщение, чтобы сообщение и код возврата были показаны вместе.

      Сообщения, заданные в агенте, будут появляться в окне Сообщения.

      Прим.:
      1. Пока заданных сообщений нет, список будет пустым. Вы можете выбрать Изменить, чтобы модифицировать заданное сообщение, или Удалить, чтобы удалить одно или несколько заданных сообщений.
      2. Можно выбрать текст, который вы вводили ранее, выбрав его в списке Текст сообщения, а не использовать функцию Обзор. После этого переходите к шагу 6h.
    5. В окне Сообщения (список) нажмите Добавить, чтобы открыть окно Определение сообщения, в котором можно ввести текст с объяснением значения нового сообщения.
    6. Нажмите кнопку ОК.
    7. Откроется окно Сообщения (список) с новым сообщением. Чтобы проверить сообщение и сделать его постоянным, выберите его в списке и нажмите кнопку ОК.
    8. Когда новый текст, тип и значение появятся в окне Определение кода возврата, нажмите кнопку ОК.
    9. После того, как вы завершили определение кодов возврата и команд для всех поддерживаемых операционных систем, выполните на странице Код возврата команды одно из следующих действий:
      • Если вы используете Мастер по созданию агентов, то нажмите кнопку Далее или по Готово, чтобы сохранить источник данных и открыть Редактор агентов.
      • Если вы используете Мастер по созданию компонентов агентов, то щелкните по нажмите кнопку Готово, чтобы вернуться в Редактор агентов.

Дальнейшие действия

Если вы хотите использовать данные из этого источника данных в сводной панели сводки IBM® Cloud Application Performance Management, необходимо создать отфильтрованный набор данных (группу атрибутов) на основании набора данных Доступность и сконфигурировать его для предоставления одной строки. Используйте поле ИМЯ, чтобы выбрать строку для вашего процесса.

В новой отфильтрованной группе атрибутов выберите поле Состояние и укажите значения серьезности для него.