Использование API Java для мониторинга данных

Можно задать источник данных, чтобы использовать Java™ API для взаимодействия с длительно выполняющимся программой на платформе Java. Агент запускает программу при запуске и периодически с ним взаимодействует. При построении агента Agent Builder создает исходный код для программы. Вы должны настроить код, чтобы собирать нужные данные. В зависимости от кода источник данных может генерировать несколько наборов данных, которые могут содержать одну строку, несколько строк или данные о событии.

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

Используйте источник данных API Java и язык программирования Java для сбора данных, которые нельзя собрать при помощи других источников данных Agent Builder. Агент запускает программу Java и отправляет требование закрытия, когда программу нужно закрыть. Программа Java должна закрываться только по требованию.

Агент, содержащий группы атрибутов API Java, взаимодействует с процессом программы Java. Программа Java использует API клиента провайдера Java для взаимодействия с агентом. Информацию о API смотрите в Javadoc в Информационном центре Tivoli Monitoring. При помощи API Java можно
  • Соединиться с процессом агента и зарегистрировать группы атрибутов, поддерживаемые программой Java
  • Получить требование данных выборки и ответить на него
  • Асинхронно отправить данные для группы атрибутов, которая создает события
  • Отправить ошибку для группы атрибутов, в которой происходит сбой сбора данных
  • Поддержка групп атрибутов в подузлах с сконфигурированными экземплярами подузлов
  • Получить требование Выполнение действий и ответить на него

Для создания группы атрибутов, собирающей данные в программе Java и отправляющей данные посредством API Java, используйте описанную ниже процедуру. Процедура создает пример программы Java для последующего использования в качестве отправной точки программы Java.

Процедура

  1. На странице Начальный источник данных агента или Положение источника данных щелкните по Пользовательские программы в области Категории данных мониторинга.
  2. В области Источники данных нажмите API Java.
  3. Нажмите кнопку Далее.
  4. Задайте имя группы атрибутов на странице Информация о API Java.
  5. Введите текст справки для группы атрибутов.
  6. Выберите одну из следующих опций группы атрибутов: Создает одну строку данных, Может создавать несколько строк данныхилиСоздает события. От этого выбора зависит образец программы Java, который создается в конце работы мастера. Дополнительную информацию смотрите в разделе Отправка данных.
  7. Необязательно: Нажмите Дополнительно, чтобы изменить дополнительные свойства группы атрибутов. Опция Дополнительно доступна, если для этой группы атрибутов выбрано Может создавать несколько строк данных или Создает события.
  8. Нажмите кнопку Далее.
  9. На странице Информация об атрибутах задайте первый атрибут для группы атрибутов. Более подробную информацию о создании атрибутов смотрите в разделе Создание атрибутов.
  10. Выберите Добавить дополнительные атрибуты и нажмите Далее, чтобы добавить в агент другие атрибуты. Ссылки на атрибуты включаются в образец программы Java, который создается в конце работы мастера.
  11. Нажмите кнопку Далее.
  12. На странице Информация о глобальном источнике данных API Java задайте имя класса и имя файла JAR.

    Имя класса - это полное имя класса, главный метод которого вызывается при запуске Java. Пример программы Javaсоздается с главным методом Java в этом классе.

    Файл JAR - это архив, содержащий классы Java, которые составляют программу Java. Файл JAR упаковывается и устанавливается вместе с агентом.

  13. Необязательно: На странице Информация о глобальном источнике данных API Java можно задать в разделе Коды ошибок коды ошибок, которые может отправлять программа Java. Программа Java отправляет эти коды ошибок, если ему не удается собрать данные.
    Ограничение: Максимальная длина кода ошибки - 256 символов. Можно использовать только буквы ASCII, цифры и символы подчеркивания. Пробелы не допускаются.
    1. Нажмите Добавить в разделе Коды ошибок.
    2. Задайте выводимое значение в окне Определение кода ошибки API Java.
    3. Задайте внутреннее значение. Внутреннее значение должно быть целым числом от 1 000 до 2 147 483 647.
    4. Задайте для каждой ошибки текст сообщения. Можно выбрать текст, который вы вводили ранее, выбрав его в списке. Нажмите OK, чтобы вернуться на страницу Информация о глобальном источнике данных API Java.
      Сообщение записывается в файл журнала агента.
    5. Если подходящего текста сообщения нет, то нажмите Обзор, чтобы задать текст сообщения.
      Появится окно (список) Сообщения. Сообщения, заданные в агенте, будут появляться в окне сообщений. Пока заданных сообщений нет, список будет пустым. Вы можете выбрать Изменить, чтобы модифицировать заданное сообщение, или Удалить, чтобы удалить одно или несколько заданных сообщений.
    6. В окне Сообщения (список) нажмите Добавить, чтобы открыть окно Определение сообщения. В окне Определение сообщения можно ввести текст с объяснением значения нового сообщения и выбрать тип сообщения.
      Прим.: Идентификатор сообщения генерируется автоматически.
    7. Нажмите кнопку ОК.
    8. Откроется окно Сообщения (список) с новым сообщением. Нажмите OK, чтобы проверить сообщение и вернуться на страницу Информация о глобальном источнике данных API Java.
  14. Необязательно: В разделе Дополнительные файлы страницы Информация о глобальном источнике данных API Java можно добавить файлы, которые будут упакованы с агентом и скопированы в систему агента при установке агента. Файл JAR API клиента провайдера Java здесь не указан: он будет автоматически скопирован в систему агента. В столбце Тип файла описано, как будет использоваться каждый файл. Три возможных способа использования описаны в следующей таблице (Табл. 1). Нажмите Правка, чтобы изменить импортированные файлы. Более подробную информацию смотрите в разделе Правка определения файла команды.
    Табл. 1. Типы файлов для дополнительных файлов
    Тип файлов Описание
    Выполняемый Выберите эту опцию, чтобы включить в агент выполняемый файл. Агент не использует этот файл, но он находится в пути для использования программой Java.
    Библиотека Выберите эту опцию, чтобы включить в агент библиотеку. Агент не использует этот файл, но он находится в пути библиотек для использования программой Java.
    Ресурс Java Выберите эту опцию, чтобы включить в агент ресурсы Java. Агент не использует этот файл, но он находится в пути классов для использования программой Java.
    Прим.: Если в Agent Builder добавлен дополнительный файл ресурса Java, то он автоматически добавляется в путь классов проекта. Компилятор Java использует дополнительный файл для разрешения всех ссылок кода на классы в ресурсе.
    Информацию о том, где установлены дополнительные файлы, смотрите в разделе Новые файлы в системе.
  15. Необязательно: Создайте фильтр, который ограничивает данные, возвращаемые группой атрибутов, если данные - это данные выборки. Чтобы создать фильтр, щелкните по Дополнительно.
    Прим.: Данные будут данными выборки, если вы не выбрали Создает события на странице Информация о API Java.
    Дополнительную информацию о фильтрации данных в группах атрибутов смотрите в разделе Фильтрация групп атрибутов.
  16. Необязательно: Добавьте свойства конфигурации в подузел.
    Если этот источник данных добавляется в подузел, то открывается страница Переопределения конфигурации подузла, чтобы можно было добавить в подузел свойства конфигурации. Для создаваемого примера программы Java в подузле должно быть хотя бы одно свойство конфигурации. Нужно задать хотя бы одно свойство конфигурации, так как пример использует свойство конфигурации, чтобы отличить один экземпляр подузла от другого.
  17. Выполните одно из следующих действий:
    1. Если вы используете мастер Агент, то нажмите Далее. Завершите работу в мастере, как требуется.
    2. В ином случае нажмите Готово, чтобы сохранить источник данных и открыть редактор агентов. Затем выберите в главном меню пункты Файл > Сохранить.
    В этой точке Agent Builder создает исходный код для программы мониторинга. Этот код расположен в подкаталоге src каталога проекта. Отредактируйте этот код, чтобы создать вашу программу мониторинга.

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

Выберите на странице Параметры API Java правильные операционные системы. Это нужно сделать, если эта группа атрибутов и программа Java работают не в тех операционных системах, которые заданы для агента. Чтобы открыть эту страницу, нажмите Параметры API Java в представлении схемы или нажмите Глобальные параметры в редакторе агентов на любой странице группы атрибутов API Java.

Прим.: Коды ошибок и дополнительные файлы можно изменить в разделах Коды ошибок и Дополнительные файлы страницы Параметры API Java.