Usar a API Java para monitorar dados

É possível definir uma origem de dados para usar a API Java™ para interagir com um aplicativo de longa execução na plataforma Java. O agente inicia o aplicativo na inicialização e interage periodicamente com ele. Ao construir o agente, o Agent Builder cria o código-fonte para o aplicativo. Deve-se customizar o código para reunir os dados corretos. Dependendo do código, o código-fonte pode produzir vários conjuntos de dados que podem contém uma única linha, várias linhas ou dados de evento.

Sobre Esta Tarefa

Use a origem de dados da API Java e a linguagem de programação Java para coletar os dados que não podem ser coletados usando outras origens de dados do Agent Builder. O agente inicia o aplicativo Java e envia uma solicitação de encerramento no momento de encerrar. O aplicativo Java deve sair apenas quando for solicitado que isso seja feito.

Um agente contendo os grupos de atributos da API Java faz interface com o processo de aplicativo Java. O aplicativo Java usa a API do Cliente de Provedor Java para fazer interface com o agente. Para obter informações sobre a API, consulte o Javadoc no Tivoli Monitoring Knowledge Center. Usando a API Java, você pode:
  • Conecte-se ao processo do agente e registre para grupos de atributos suportados pelo aplicativo Java
  • Receber e responder uma solicitação de dados amostrados
  • Enviar dados no modo assíncrono para um grupo de atributos que produz eventos
  • Enviar um erro para um grupo de atributos em que a coleção de dados é falha
  • Suportar grupos de atributos em subnós com instâncias de subnós configurados
  • Receber e responder uma solicitação Executar Ação

Use o procedimento a seguir para criar um grupos de atributos que coleta dados em um aplicativo Java e o envia usando a API Java. O procedimento mostra como criar um aplicativo Java de amostra a ser usado como um ponto de início para o seu aplicativo Java.

Procedimento

  1. Na página Origem de Dados Inicial do Agente ou na página Local da Origem de Dados, clique em Programas Customizados na área Categorias de Dados de Monitoramento.
  2. Na área Origens de Dados, clique em API Java.
  3. Clique em Avançar.
  4. Na página Informações da API Java, insira um nome de grupo de atributos.
  5. Insira um texto de ajuda para o grupo de atributos.
  6. Selecione se o grupo de atributos Produz uma única linha de dados, Pode produzir mais de uma linha de dados ou Produz eventos. Essa escolha afeta o aplicativo Java de amostra criado ao final do assistente. Para obter mais informações, consulte Enviando Dados.
  7. Opcional: Clique em Avançado para modificar as propriedades avançadas para o grupo de atributos. Avançado está disponível ao selecionar que o grupo de atributos Pode produzir mais de uma linha de dados ou Produz eventos.
  8. Clique em Avançar.
  9. Na página Informações do Atributo, especifique o primeiro atributo para o grupo de atributos. Para obter informações adicionais sobre a criação dos atributos, consulte (Criando Atributos).
  10. Selecione Incluir Atributos Adicionais e clique em Avançar para incluir outros atributos no agente. Referências aos atributos são incorporadas no aplicativo Java de amostra que é criado no final do assistente.
  11. Clique em Avançar.
  12. Na página Informações Globais da Origem de Dados da API Java, insira um nome de Classe e um nome de arquivo JAR.

    O nome de classe é um nome de classe completo cujo método main é chamado quando o Java é iniciado. O aplicativo Java de amostra é criado com o método Java principal nessa classe.

    O arquivo JAR é o archive que contém as classes Java que constituem o aplicativo Java. O arquivo JAR é empacotado e instalado com o agente.

  13. Opcional: Na página Informações Globais da Origem de Dados da API Java, seção Códigos de Erro, defina os códigos de erro que o aplicativo Java pode enviar. Esses códigos de erro são enviados pelo aplicativo Java quando não puder coletar os dados.
    Restrição: Um código de erro possui um limite de 256 caracteres. Apenas letras, dígitos e sublinhados ASCII são permitidos. Não são permitidos espaços.
    1. Clique em Incluir na seção Códigos de Erros.
    2. Na janela Definição de Código de Erro da API Java, insira um valor de exibição.
    3. Insira um valor de interno. O valor interno deve ser um número inteiro de 1.000 a 2.147.483.647.
    4. Defina um texto de mensagem para cada erro. É possível usar o texto de mensagem que foi inserido anteriormente selecionando-o da lista. Clique em OK para retornar à página Informações Globais de Fonte de Dados Java API.
      A mensagem é registrada no arquivo de log do agente.
    5. Se nenhum texto de mensagem adequado estiver disponível, clique em Procurar para configurar o texto da mensagem.
      A janela Mensagens (lista) é exibida. A janela de mensagens lista mensagens que são definidas no agente. Até definir as mensagens, a lista permanece em branco. É possível usar Editar para alterar uma mensagem definida e Remover para excluir uma ou mais mensagens que você definiu.
    6. Na janela Mensagens (lista), clique em Incluir para ver uma janela Definição de Mensagem. Na janela Definição de Mensagem, você pode digitar o texto que descreve o significado da nova mensagem e selecionar o tipo de mensagem.
      Nota: O identificador de mensagens é automaticamente gerado para você.
    7. Clique em OK.
    8. A janela Mensagens (lista) é exibida com a nova mensagem. Para verificar a mensagem e retornar à página Informações Globais de Fonte de Dados Java API, clique em OK.
  14. Opcional: Na seção Arquivos Suplementares da página Informações Globais da Origem de Dados da API Java, você pode incluir os arquivos que são compactados com o agente e copiados para o sistema de agente na instalação do agente. O arquivo JAR da API do cliente do provedor Java não é listado aqui; ele é copiado automaticamente para o sistema do agente. A coluna Tipo de Arquivo descreve como é esperado que cada arquivo seja usado. Três possíveis usos são descritos na tabela a seguir: (Tabela 1). Clique em Editar para editar o arquivo de importado. Para obter mais informações, consulte (Editando uma definição de arquivo de comando).
    Tabela 1. Tipos de arquivos para arquivos complementares
    Tipo de arquivo Descrição
    Executável Selecione esta opção se desejar incluir um arquivo executável com o agente. O agente não usa esse arquivo, mas ele está no caminho para que o aplicativo Java use.
    Biblioteca Selecione esta opção se você incluir uma biblioteca com o agente. O agente não usa esse arquivo, mas está no caminho da biblioteca para que o aplicativo Java use.
    Recurso Java Selecione esta opção para incluir recursos Java com o agente. O agente não usa esse arquivo, mas ele está no caminho da classe para que o aplicativo Java use.
    Nota: Quando um arquivo complementar de recursos Java é incluído no Agent Builder, o arquivo é incluído automaticamente no caminho de classe do projeto. O compilador Java usa o arquivo complementar para resolver quaisquer referências que seu código possua para as classes no recurso.
    Para obter informações sobre onde os Arquivos Suplementares estão instalados com o agente, consulte (Novos Arquivos em Seu Sistema).
  15. Opcional: Crie um filtro para limitar os dados retornados por este grupo de atributos, se os dados são amostrados. Crie um filtro clicando em Avançado.
    Nota: Os dados são de amostra se você não selecionou Produz eventos na página de Informações de API Java.
    Para obter informações adicionais sobre filtragem de dados de um grupo de atributos, consulte Filtrando Grupos de Atributos
  16. Opcional: Inclua propriedades de configuração para o subnó.
    Se estiver incluindo esta origem de dados em um subnó, a página Substituições de Configuração de Subnó é mostrada para que seja possível incluir propriedades de configuração no subnó. Pelo menos uma propriedade de configuração é necessária sob o subnó para que o aplicativo Java de amostra a ser criado. Pelo menos uma propriedade de configuração é necessária, pois a amostra usa uma propriedade de configuração para distinguir uma instância de subnó da outra.
  17. Execute uma das seguintes etapas:
    1. Se estiver usando o assistente de Agente, clique em Avançar. Complete o assistente conforme necessário.
    2. Caso contrário, clique em Concluir para salvar a origem de dados e abrir o Agent Editor. Em seguida, no menu principal, selecione Arquivo > Salvar.
    Neste ponto, o Agent Builder cria o código-fonte para o aplicativo de monitoramento. O código está localizado no subdiretório src do diretório do projeto. Edite este código para criar seu aplicativo de monitoramento.

O que Fazer Depois

Selecione os sistemas operacionais na página configurações de API Java. Faça essa seleção se este grupo de atributos e o aplicativo Java forem executados em sistemas diferentes do sistema operacional definido para o agente. Para abrir esta página, clique em Configurações API Java na visualização da estrutura de tópicos ou clique em Configurações Globais no Agent Editor em qualquer página do grupo de atributos API Java.

Nota: Os códigos de erro e arquivos complementares podem ser atualizados posteriormente nas seções Códigos de Erro e Arquivos Complementares da página Configurações da API Java.