Provisionar o Agente Java do APM

Você pode continuar a provisionar o software do agente Java do APM após concluir o download do agente Java do APM.

Faça o seguinte:

  1. Conecte-se ao host no qual o servidor de aplicativos está instalado e copie o arquivo de software do Agente Java do APM que você fez download para qualquer local preferencial.

    Faça log-in como o mesmo usuário que instalou o servidor de aplicativos e certifique-se de que o usuário do servidor de aplicativos tem permissões de leitura e gravação no diretório para o qual o agente Java do APM foi submetido a download ou copiado.

  2. Certifique-se de estar conectado como o usuário que instalou o servidor de aplicativos e navegue até o diretório no qual você fez download ou copiou o software do agente Java do APM. Observe que você deve ter permissões de leitura e gravação no diretório que hospeda o agente Java do APM.
  3. Revise os argumentos obrigatórios a seguir que devem ser especificados para provisionar um Agente Java do APM.
    • -service-name: O nome do serviço que está sendo monitorado. Esse argumento permite filtrar por serviço e exibir rastreamentos na interface do usuário do Trace Explorer.
    • -destination: O diretório de destino no qual o Agente Java do APM será provisionado. Idealmente, essa deve ser uma variável definida como parte das tarefas de pré-requisitos para apontar para o diretório de destino do servidor de aplicativos. Por exemplo, $DOMAIN_HOME para a localização do Domínio do Oracle WebLogic Server. Para microsserviços, o diretório de destino pode ser o diretório home padrão ou qualquer diretório vazio.
    • -private-data-key: A chave de instalação do agente usada pelos agentes Java do APM (dataKey privada), que é gerada quando o domínio do APM é criado.
    • -data-upload-endpoint: O URL dataUploadEndpoint que é gerado quando o domínio do APM é criado.

    Para obter mais informações sobre dataKey e dataUploadEndpoint privados, consulte Obter Ponto Final de Upload de Dados e Chaves de Dados.

    Você pode especificar argumentos adicionais ao provisionar o agente Java do APM. Para obter informações sobre esses argumentos e os cenários nos quais eles são úteis, consulte Especificar Argumentos de Proxy.

    Para exibir as informações de ajuda do argumento provision-agent, execute o seguinte:

    java -jar ./apm-java-agent-installer-<version>.jar provision-agent -help

    Para obter detalhes, consulte Informações de uso da ajuda.

  4. Forneça o agente especificando os argumentos obrigatórios descritos na etapa anterior e executando o seguinte comando java:
    java -jar ./apm-java-agent-installer-<version>.jar provision-agent -service-name=<Name of the Service> -destination=<Destination_Directory> -private-data-key=<Agent installation key generated during APM domain creation> -data-upload-endpoint=<dataUploadEndpoint URL generated during APM domain creation>
    

    Veja um exemplo:

    java -jar ./apm-java-agent-installer-1.1.jar provision-agent -service-name=apm_service -destination=$DOMAIN_HOME -private-data-key=IMWJ5UN2C6YOLQSUZ5Q7IGN3QACF4AZD -data-upload-endpoint=https://dataUploadEndpoint.com
    
    Ao executar o comando java, se o agente Java do APM for provisionado com sucesso:
    • A mensagem Action [provision-agent] completed successfully é exibida.
    • O diretório oracle-apm-agent é criado no diretório de destino. Por exemplo, $DOMAIN_HOME/oracle-apm-agent.

      O diretório oracle-apm-agent deve conter o seguinte:

      • bin: Contém o iniciador do agregador.
      • bootstrap: Contém os arquivos .jar de inicialização do agente que serão usados pelo comando -javaagent para implantar o agente Java do APM.
      • config: Contém os arquivos de configuração globais, que podem ser editados. Este diretório contém:
        • O arquivo AgentConfig.properties, que contém argumentos de configuração do agente Java do APM.
        • O arquivo ProbeConfig.acml, que contém as informações de configuração relacionadas às sondagens.
      • install: Contém o diretório <release-version>/config, que tem os binários do agente Java do APM e os arquivos de configuração padrão. Observe que os arquivos deste diretório não devem ser alterados.
      • version: O arquivo de versão que tem informações sobre a versão e a data de ativação da release do agente Java do APM.

    Se o comando java terminar e o agente Java do APM não for provisionado com sucesso, você poderá revisar os detalhes do erro no arquivo ApmAgentInstall.log e no log de saída do servidor de aplicativos para corrigir o problema.

Informações de Uso da Ajuda

Para exibir as informações de ajuda e uma lista de opções disponíveis ao provisionar o agente, use a opção -help.

java -jar ./apm-java-agent-installer-<version>.jar provision-agent -help

Exemplo:

java -jar ./apm-java-agent-installer-<version>.jar provision-agent -help

Usage: 
apm-java-agent-installer-<version>.jar provision-agent [options ...] 

options:
   -service-name=<service name>
       (Required) Name of the service being monitored.

   -destination=<path>
       (Required) Path to create Agent home directory. The Agent software will be
       deployed to a 'oracle-apm-agent' sub-directory in the specified path.

   -private-data-key=<private_data_key>
       (Required) APM Agent private
      data key for Appserver Agents. This property
       is required for the APM Agent to connect to the Oracle APM Cloud, and it
       is specific to your APM Cloud Domain.

   -data-upload-endpoint=<https://host:port>
            (Required) Endpoint of Oracle APM Cloud. This property is required for the
            APM Agent to connect to the Oracle APM Cloud, and it is specific to your
            APM Cloud Domain.

   -enable-browser-agent-injection
       Enables the APM Agent to automatically inject the browser agent into HTML
       pages.  Make sure '-public-data-key' is also set, otherwise injection will
       not be enabled until one is provided.

   -public-data-key=<public_data_key>
       APM Agent public data key for Appserver Agents. This property is required
       for the injected browser agent to connect to the Oracle APM Cloud, and it
       is specific to your APM Cloud Domain.

   -activation-date=<YYYY-MM-DD>
       To stage newly installed Agent, and defer Agent running until Appserver
       restart on or later than specified date.

   -property=<key=value>
       Agent specific (i.e. starting with 'com.oracle.apm.agent') configuration
       properties. Multiple instances of -property can be specified.
       Alternatively, you can add these properties to the
       "AgentConfig.properties" file located in the Agent config directory
       (oracle-apm-agent/config/<version>).

   -overwrite
       Overwrite Agent deployment.

 Example:
   - Deploy Agent to user home directory      
      provision-agent -service-name=myservice -destination=/home/user
                      -private-data-key=12345 -data-upload-endpoint=https://<endpoint>
   - Deploy Agent to user home directory with additional properties
       provision-agent -service-name=myservice -destination=/home/user
                       -private-data-key=12345 -data-upload-endpoint=https://<endpoint>
                       -property=com.oracle.apm.agent.logging.level=WARNING
Observação

Como alternativa, você pode usar o assistente Instalar agente do APM para obter ajuda com o download, o provisionamento e a implantação do agente do APM. Você pode encontrá-lo na parte superior da página Fazer Download de agentes do APM.