Instale o agente Java em servidores de aplicativos e frameworks da JVM

Esta página aborda o caminho de instalação padrão para o agente Java do New Relic em qualquer servidor de aplicativos compatível ou framework baseado em JVM. Siga estas etapas para baixar o agente, configurá-lo e verificar se os dados estão fluindo para o New Relic.

Compatibilidade e requisitos

Suportado

Java 8, 11, 17, 21, 24, 25 e 26 (Java 7 suportado apenas no agente v6.5.4 e anteriores)
Linguagens baseadas na JVM: Java, Scala, Kotlin e Clojure
Servidores de aplicativos e frameworks: Tomcat, Spring Boot, JBoss/WildFly, Glassfish, Jetty, WebLogic, WebSphere, Grails, ColdFusion, Solr, Play, Resin, Tanuki Wrapper e Geronimo — consulte compatibilidade e requisitos para ver os intervalos de versões compatíveis
Qualquer processo da JVM que aceite um argumento -javaagent

Não suportado

Execução em conjunto com outros agentes APM — o agente Java não pode garantir o comportamento correto quando outro agente APM está ativo na mesma JVM

Você precisa

Uma conta New Relic e
Uma JVM com suporte a SSL SHA-2 (256 bits)
Permissão para editar os scripts de inicialização do seu servidor de aplicativos ou a configuração da JVM
Permissão para criar um diretório para armazenar os arquivos do agente

Instalar

Baixe o agente Java

Faça o download de newrelic-java.zip utilizando um destes métodos:

bash

$curl -O https://download.newrelic.com/newrelic/java-agent/newrelic-agent/current/newrelic-java.zip
$unzip newrelic-java.zip

Invoke-WebRequest -Uri https://download.newrelic.com/newrelic/java-agent/newrelic-agent/current/newrelic-java.zip -OutFile newrelic-java.zip
Expand-Archive -Path newrelic-java.zip -DestinationPath .

Faça o download de newrelic-java.zip na página de notas de versão do agente Java.

Após a descompactação, o diretório newrelic/ contém o jar do agente (newrelic.jar) e o arquivo de configuração (newrelic.yml) que você configurará nas próximas etapas.

Colocar os arquivos do agente

Crie um diretório permanente e mova os arquivos do agente para ele:

bash

$mkdir -p /opt/newrelic
$mv newrelic/* /opt/newrelic/

Recomendamos /opt/newrelic no Linux/macOS ou C:\opt\newrelic no Windows. Certifique-se de que newrelic.jar não esteja no classpath do seu aplicativo ou em qualquer diretório listado em java.endorsed.dirs.

Passe o `-javaagent`

Adicione a flag -javaagent à configuração de inicialização da JVM do seu servidor de aplicativos, apontando para o caminho completo de newrelic.jar. O método difere por servidor — expanda o que corresponde ao seu ambiente:

Escolha o método para a configuração do seu Tomcat:

Crie CATALINA_BASE/bin/setenv.sh se não existir e, em seguida, adicione:

bash

$export CATALINA_OPTS="$CATALINA_OPTS -javaagent:/opt/newrelic/newrelic.jar"

Crie CATALINA_BASE/bin/setenv.bat se não existir e, em seguida, adicione:

SET "CATALINA_OPTS=%CATALINA_OPTS% -javaagent:C:\opt\newrelic\newrelic.jar"

Selecione Start > Apache Tomcat X.Y.Z > Configure Tomcat > Java.
Na caixa de texto Java Options, insira o argumento. Use barras normais / para o separador de caminho. Para o Tomcat 6, adicione uma quebra de linha após o argumento -javaagent.
```
-javaagent:/opt/newrelic/newrelic.jar
```
Selecione Apply e, em seguida, reinicie o Tomcat.

A versão do Apache Commons daemon (jsvc) incluída no Tomcat 6 não suporta o argumento -javaagent. Uma compilação a partir do código-fonte do trunk oferece suporte a isso por meio do prefixo -X. Consulte o relatório de bugs do Apache e o repositório de código-fonte do Apache Commons.

Editar domain/configuration/domain.xml e adicionar a opção -javaagent às opções da JVM do grupo de servidores:

<server-group name="main-server-group" profile="full">
    <jvm name="default">
        <jvm-options>
            <option value="-javaagent:/opt/newrelic/newrelic.jar"/>
        </jvm-options>
    </jvm>
</server-group>

Cuidado

Um bug do JBoss nas versões 7.0.2.Final e 7.1.0.Alpha1 impede que as opções da JVM sejam definidas em domain.xml. Atualize o servidor de aplicativos JBoss se encontrar este problema.

Plataforma	Instruções
Unix/macOS — JBoss 6.x EAP ou 7.0.x AS+	Na parte inferior de `bin/standalone.conf` , adicione: `JAVA_OPTS="$JAVA_OPTS -javaagent:/opt/newrelic/newrelic.jar"`
Windows — JBoss 6.x EAP ou 7.0.x AS+	Em `bin/standalone.bat` , antes de `set JBOSS_ENDORSED_DIRS` , adicione: `set "JAVA_OPTS=-javaagent:C:\opt\newrelic\newrelic.jar %JAVA_OPTS%"`
Unix/macOS — JBoss 6.x ou anterior	Na parte inferior de `bin/run.conf` , adicione: `JAVA_OPTS="$JAVA_OPTS -javaagent:/opt/newrelic/newrelic.jar"`
Windows — JBoss 6.x ou anterior	Em `bin/run.bat` , antes de `set JBOSS_CLASSPATH` , adicione: `set "JAVA_OPTS=-javaagent:C:\opt\newrelic\newrelic.jar %JAVA_OPTS%"`

Dica

O WildFly 11 ou superior exige etapas adicionais de instalação.

Editar domain/configuration/domain.xml e adicionar a opção -javaagent às opções da JVM do grupo de servidores:

<server-group name="main-server-group" profile="full">
    <jvm name="default">
        <jvm-options>
            <option value="-javaagent:/opt/newrelic/newrelic.jar"/>
        </jvm-options>
    </jvm>
</server-group>

Plataforma	Instruções
Unix/macOS	Na parte inferior de `bin/standalone.conf` , adicione: `JAVA_OPTS="$JAVA_OPTS -javaagent:/opt/newrelic/newrelic.jar"`
Windows	Em `bin/standalone.bat` , após `rem Setup JBoss specific properties` , adicione: `set "JAVA_OPTS=-javaagent:C:\opt\newrelic\newrelic.jar %JAVA_OPTS%"`

Plataforma

Instruções

Unix/macOS

Na parte inferior de

bin/standalone.conf

, adicione:

JAVA_OPTS="$JAVA_OPTS -javaagent:/opt/newrelic/newrelic.jar"

Windows

bin/standalone.bat

, após

rem Setup JBoss specific properties

, adicione:

set "JAVA_OPTS=-javaagent:C:\opt\newrelic\newrelic.jar %JAVA_OPTS%"

No console de administração do Glassfish, selecionar Application Server > JVM Settings > JVM Options.
Selecione Add JVM Option e adicione:
```
-javaagent:/opt/newrelic/newrelic.jar
```
Salve e reinicie o Glassfish.
Se o Glassfish não iniciar, o caminho -javaagent pode estar incorreto. Você também pode definir os argumentos da JVM editando domain.xml diretamente.
Importante
Um bug no Glassfish 2.1 impede que as classes no carregador de classes de inicialização usem a API de logging do Java. Isso foi corrigido na versão 2.1.1 e superiores.

Edite JAVA_OPTIONS no seu script jetty.sh:

bash

$export JAVA_OPTIONS="${JAVA_OPTIONS} -javaagent:/opt/newrelic/newrelic.jar"

Adicione ao seu arquivo de configuração start.ini:

-javaagent:/opt/newrelic/newrelic.jar

Edite startWebLogic.sh no diretório bin/ do domínio.

Perto do início do arquivo, adicione:

bash

$export JAVA_OPTIONS="$JAVA_OPTIONS -javaagent:/opt/newrelic/newrelic.jar"

Edite startWebLogic.bat no diretório bin/ do domínio.

Perto do início do arquivo, adicione:

set JAVA_OPTIONS=%JAVA_OPTIONS% -javaagent:"C:\opt\newrelic\newrelic.jar"

Para instâncias do servidor de administração, use as instruções para Linux/macOS ou Windows acima — não é possível configurar instâncias do servidor de administração por meio do console de administração.

Para instância de servidor gerenciado, utilize o console de administração:

Navegar para Environments > Servers > (selecionar um servidor) > Server Start > Arguments.
Adicionar:
```
-javaagent:/opt/newrelic/newrelic.jar
```
Salve e reinicie a instância do servidor.

No console de administração, selecione Servers > Application servers > (selecione um servidor) > Configuration > Service Infrastructure > Java and Process Management.
Selecione Process Definition > Additional Properties e, em seguida, selecione Java Virtual Machine.
No campo Generic JVM arguments, adicionar:
```
-javaagent:/opt/newrelic/newrelic.jar
```
Selecione Apply e, em seguida, Save.
Reinicie seu servidor.
Para mais informações, consulte a coleta de métrica do WebSphere PMI.

Adicione o agente a JAVA_OPTS ao executar o comando de inicialização:

bash

$export JAVA_OPTS="$JAVA_OPTS -javaagent:/opt/newrelic/newrelic.jar" && startup

Edite ${server.config.dir}/jvm.options.
Adicionar:
```
-javaagent:/opt/newrelic/newrelic.jar
```
Reinicie seu servidor.

bash

$grails -noreloading -javaagent:/opt/newrelic/newrelic.jar run-app

Em grails-app/conf/BuildConfig.groovy, adicione ou edite:

grails.tomcat.jvmArgs = ["-javaagent:/opt/newrelic/newrelic.jar"]

Iniciar o servidor ColdFusion e abrir o console de administração do ColdFusion.
No menu à esquerda, selecione SERVER SETTINGS > Java and JVM.
Se estiver usando a API do agente, especifique o caminho para newrelic-api.jar no campo ColdFusion Class Path.
No campo JVM Arguments, adicione:
```
-javaagent:/opt/newrelic/newrelic.jar
```
Selecione Submit Changes e, em seguida, reinicie o ColdFusion.

Adicione a propriedade -javaagent a bin/solr.in.sh:

bash

$SOLR_OPTS="$SOLR_OPTS -javaagent:/opt/newrelic/newrelic.jar"

Adicione o -javaagent antes de start.jar:

bash

$java -javaagent:/opt/newrelic/newrelic.jar -jar start.jar

Ao executar o Solr dentro de um servidor de aplicativos, siga as instruções para esse servidor de aplicativos (consulte as outras entradas nesta lista). Certifique-se também de que o JMX esteja habilitado. Se os dados do Solr não aparecerem no APM, consulte os procedimentos de resolução de problemas para dados do Solr.

bash

$play run your_app_name -javaagent:/opt/newrelic/newrelic.jar

Inicie com uma distribuição descompactada contendo o script start:
bash
```
$play clean dist && unzip dist/*.zip
```

Inicie com o argumento -javaagent:

bash

$cd unzipped/folder; chmod a+x start; ./start -javaagent:/opt/newrelic/newrelic.jar

Inicie com uma distribuição descompactada:

bash

$play clean dist && unzip target/directory/universal/*.zip

Use o prefixo -J-javaagent:

bash

$cd unzipped/folder; ./bin/scriptname -J-javaagent:/opt/newrelic/newrelic.jar

Inicie com uma distribuição descompactada:

bash

$activator clean dist && unzip target/directory/universal/*.zip

Use o prefixo -J-javaagent:

bash

$cd unzipped/folder; ./bin/scriptname -J-javaagent:/opt/newrelic/newrelic.jar

Se você usa o Typesafe Activator com o Play 2.4, adicione também em build.sbt:
```
javaOptions ++= Seq("-javaagent:/opt/newrelic/newrelic.jar")
```

Adicione à seção <jvm-args> em conf/resin.conf ou conf/resin.xml:

<jvm-arg>-javaagent:/opt/newrelic/newrelic.jar</jvm-arg>

O sistema de módulos do Java 9 pode causar NoClassDefFoundError: java/sql/SQLException se -javaagent for adicionado a conf/resin.conf ou conf/resin.xml. Em vez disso, use uma destas alternativas:

Opção 1 — Linha de comando:

bash

$java -javaagent:/opt/newrelic/newrelic.jar -jar lib/resin.jar start

Opção 2 — Edite bin/resin.sh, modificando:

bash

$exec $JAVA_EXE -javaagent:/opt/newrelic/newrelic.jar -jar lib/resin.jar $@

Em seguida, iniciar o Resin com ./bin/resin.sh start.

Em wrapper.conf, adicione uma nova opção wrapper.java.additional. Substitua XXX por um número não utilizado no arquivo:

wrapper.java.additional.XXX=-javaagent:/opt/newrelic/newrelic.jar

Dica

No Linux, não são necessárias aspas ao redor do caminho. Isso pode variar em outro sistema operacional.

Configurar

Edite newrelic/newrelic.yml e defina estes dois valores obrigatórios:

license_key: 'YOUR_LICENSE_KEY'
app_name: 'My Application'

O agente lê newrelic.yml do mesmo diretório que newrelic.jar na inicialização. Também é possível substituir qualquer configuração usando propriedades do sistema Java (por exemplo, -Dnewrelic.config.license_key=YOUR_KEY) ou variáveis de ambiente.

Ao usar o arquivo de configuração, restrinja as permissões de leitura/gravação apenas para o proprietário do processo do servidor de aplicativo:

bash

$chmod 600 /opt/newrelic/newrelic.yml

Consulte a configuração do agente Java para ver todas as opções disponíveis.

Verifique sua instalação

Reinicie seu servidor de aplicativo. Envie pelo menos dois requests, depois aguarde 2–3 minutos e o seu aplicativo aparecerá em APM & serviços.

Se nenhum dado aparecer após cinco minutos, consulte Nenhum dado aparece (Java).

Esta tradução de máquina é fornecida para sua comodidade.

Instale o agente Java em servidores de aplicativos e frameworks da JVM

Compatibilidade e requisitos

Suportado

Não suportado

Você precisa

Instalar

Baixe o agente Java

Colocar os arquivos do agente

Passe o `-javaagent`

Tomcat

Bota Primavera

JBoss/WildFly

Cuidado

WildFly (autônomo)

Dica

Glassfish

Importante

Jetty

WebLogic

WebSphere

Grails

ColdFusion

Solr

Play framework

Resin

Tanuki Wrapper (Java Service Wrapper)

Dica

Geronimo

Configurar

Verifique sua instalação

Esta tradução de máquina é fornecida para sua comodidade.

Instale o agente Java em servidores de aplicativos e frameworks da JVM

Compatibilidade e requisitos .css-21sua1{background:none;border:none;width:0;padding:0;}

Suportado

Não suportado

Você precisa

Instalar

Baixe o agente Java

Colocar os arquivos do agente

Passe o -javaagent

Bota Primavera

JBoss/WildFly

WildFly (autônomo)

Glassfish

Jetty

WebLogic

WebSphere

Grails

ColdFusion

Solr

Play framework

Resin

Tanuki Wrapper (Java Service Wrapper)

Geronimo

Configurar

Verifique sua instalação

Artigos relacionados

Compatibilidade e requisitos

Passe o `-javaagent`