Incluir o agente Java com um argumento JVM

Este documento descreve como passar o argumento -javaagent para a JVM da sua framework. Esta etapa de instalação garante que o agente seja incluído no seu aplicativo. Para todos os servidores de aplicativos, certifique-se de transmitir o caminho completo para o arquivo newrelic.jar .

Este documento é simplesmente uma referência de como passar o argumento. Para obter procedimentos de instalação detalhados, consulte Instalação do agente Java.

ColdFusion

Para passar o argumento -javaagent no ColdFusion:

Inicie o servidor ColdFusion e navegue até o console de administração do ColdFusion.
No menu esquerdo, 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 o argumento -javaagent :
```
-javaagent:/full/path/to/newrelic.jar
```
Selecione Submit Changes e reinicie o servidor ColdFusion.

Geronimo

Para transmitir o argumento -javaagent no Geronimo, consulte o jar do agente New Relic na variável de ambiente JAVA_OPTS ao executar o comando de inicialização:

bash

$export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar" && geronimo run

Glassfish

Para passar o argumento -javaagent no Glassfish:

No console do Glassfish, selecione Application Server > JVM Settings > JVM options.
Na página de opções da JVM, selecione Add JVM option.
Adicione uma entrada para o argumento -javaagent :
```
-javaagent:/full/path/to/newrelic.jar
```
Salve e reinicie o Glassfish.

Se o Glassfish não iniciar, o argumento -javaagent pode não ter sido definido corretamente. É possível alterar os argumentos da JVM do servidor editando o arquivo domain.xml .

Importante

Um bug no Glassfish 2.1 impede que classes no carregador de classes de inicialização (o agente New Relic) usem a API de log Java. Isso parece ter sido corrigido nas versões 2.1.1 ou superiores.

Grails

Para passar o argumento -javaagent no Grails:

No seu aplicativo Grails, abra este arquivo com seu editor de texto:
```
grails-app/conf/BuildConfig.groovy
```

Adicione ou edite a linha de argumentos da JVM:

grails.tomcat.jvmArgs = ["-javaagent:/full/path/to/newrelic.jar"]

JBoss

Para passar o argumento -javaagent no JBoss:

Use o modo de domínio para o JBoss versões 6.x EAP e 7.0 AS ou superior:

Edite as propriedades da JVM para seu grupo de servidores, localizadas em:
```
domain/configuration/domain.xml
```
Modifique as propriedades para incluir o argumento -javaagent :
```
<server-group name="main-server-group" profile="full">
  <jvm name="default">
    <jvm-options>
      <option value="-javaagent:/full/path/to/newrelic.jar"/>
    </jvm-options>
  </jvm>
  ...
</server-group>
```
Cuidado
Um bug do JBoss em 7.0.2.Final e 7.1.0.Alpha1 não permite que opções de JVM sejam definidas em domain.xml. Se você encontrar esse problema, atualize seu servidor do aplicativo JBoss.

Use o modo autônomo para outras plataformas e versões:

Plataforma	Instruções
Unix/macOS com 6.x EAP ou 7.0.x AS e acima	Na parte inferior de `bin/standalone.conf`, adicione: `JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar"`
Windows com 6.x EAP ou 7.0.x AS ou superior	Em `bin/standalone.bat`, antes da linha: `set JBOSS_ENDORSED_DIRS=%JBOSS_HOME%\lib\endorsed` Adicionar: `set "JAVA_OPTS=-javaagent:C:/full/path/to/newrelic.jar %JAVA_OPTS%"`
Unix/macOS com 6.x ou anterior	Na parte inferior de `bin/run.conf`, adicione isto: `JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar"`
Windows com 6.x ou anterior	Em `bin/run.bat`, antes da linha: `set JBOSS_CLASSPATH=%RUN_CLASSPATH%` Adicionar: `set "JAVA_OPTS=-javaagent:C:/full/path/to/newrelic.jar %JAVA_OPTS%"`

Jetty

Para passar o argumento -javaagent no Jetty:

Play

Para passar o argumento -javaagent no Play:

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

Anexe o argumento -javaagent ao iniciar seu app Play:

bash

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

Comece com uma distribuição unzipped contendo o script start :
bash
```
$play clean dist && unzip target/directory/universal/*.zip
```
Anexe o argumento -J-javaagent ao iniciar seu app Play:
bash
```
$cd unzipped/folder; ./bin/scriptname -J-javaagent:/full/path/to/newrelic.jar
```
Dica
Para ativar o tempo de carregamento da página, consulte Instrumentação manual com Play 2.2.

Comece com uma distribuição unzipped contendo o script start :
bash
```
$activator clean dist && unzip target/directory/universal/*.zip
```

Anexe o argumento -J-javaagent ao iniciar seu app Play:

bash

$cd unzipped/folder; ./bin/scriptname -J-javaagent:/full/path/to/newrelic.jar

Se você usa o Typesafe Activator com o Play 2.4, adicione esta linha ao seu build.sbt:
```
javaOptions ++= Seq("-javaagent:/full/path/to/newrelic.jar")
```

Resin

Java 8

Opção 1: adicione o argumento javaagent por meio da propriedade jvmargs no arquivo resin.properties do servidor:
```
jvm_args  : -javaagent:/full/path/to/newrelic.jar
```
Opção 2: Especifique o argumento -javaagent adicionando-o à seção <jvm-args> no arquivo conf/resin.conf ou conf/resin.xml :
```
<jvm-arg>-javaagent:/full/path/to/newrelic.jar</jvm-arg>
```

Java 9 or higher

O sistema de módulos introduzido no Java 9 pode levar à exceção NoClassDefFoundError: java/sql/SQLException se a propriedade -javaagent for adicionada aos arquivos conf/resin.conf ou conf/resin.xml . Se você estiver usando Java 9 ou superior, certifique-se de que a propriedade -javaagent não esteja incluída nesses arquivos.

O Resin pode ser executado em Java 9 ou superior, com o agente Java usando uma das seguintes opções:

Opção 1: adicione o argumento javaagent por meio da propriedade jvmargs no arquivo resin.properties do servidor:
```
jvm_args  : -javaagent:/full/path/to/newrelic.jar
```
O servidor Resin pode então ser executado com ./bin/resin.sh start.
Opção 2: execute o jar de Resin com a propriedade -javaagent na linha de comando:
```
java -javaagent:/path/to/newrelic.jar -jar lib/resin.jar start
```

Importante

O agente não funcionará com Resin no Windows ao usar Java 9 ou superior.

Solr

Para passar o argumento -javaagent no Solr:

Bota Primavera

Para transmitir o argumento -javaagent no Spring Boot, adicione-o à linha de comando na qual você inicia seu aplicativo. Certifique-se de adicioná-lo antes do argumento -jar :

bash

$java -javaagent:/full/path/to/newrelic.jar -jar app.jar

Invólucro Tanuki

Para passar o argumento -javaagent no Tanuki Wrapper, adicione uma opção de wrapper wrapper.conf. Na linha abaixo, substitua XXX por um número não utilizado neste arquivo:

wrapper.java.additional.XXX=-javaagent:/full/path/to/newrelic.jar

Dica

Em sistemas Linux, não são necessárias aspas ao configurar esse valor. Este comportamento pode variar em outros sistemas operacionais.

Tomcat

Para passar o argumento -javaagent no Tomcat:

Crie um script CATALINA_BASE/bin/setenv.sh se ainda não existir. Configure seu script setenv.sh para usar o agente New Relic usando a variável de ambiente CATALINA_OPTS :

bash

$export CATALINA_OPTS="$CATALINA_OPTS -javaagent:/full/path/to/newrelic.jar"

Crie um script CATALINA_BASE/bin/setenv.bat se ainda não existir. Configure seu script setenv.bat para usar o agente New Relic usando a variável de ambiente CATALINA_OPTS :

SET "CATALINA_OPTS=%CATALINA_OPTS% -javaagent:/full/path/to/newrelic.jar"

Dica

Recomendamos que você não defina nenhuma variável neste script. Em vez disso, coloque-os em um script setenv.sh em CATALINA_BASE/bin para manter suas personalizações separadas.

Configure seu arquivo catalina.sh para usar o agente New Relic usando a variável de ambiente JAVA_OPTS :

bash

$export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar"

Dica

Recomendamos que você não defina nenhuma variável neste script. Em vez disso, coloque-os em um script setenv.bat em CATALINA_BASE/bin para manter suas personalizações separadas.

Se você usar catalina.bat para lançar o Tomcat, defina a variável JAVA_OPTS próximo ao topo do arquivo:

SET JAVA_OPTS=%JAVA_OPTS% -javaagent:/full/path/to/newrelic.jar

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

A versão do daemon Apache Commons (jsvc) incluída no Tomcat 6 não suporta o argumento -javaagent usado pelo New Relic. No entanto, uma construção do daemon jsvc a partir da origem do tronco suportará o argumento -javaagent por meio do prefixo -X . Veja o bug do Apache rastreando o problema.

Há uma correção no repositório de origem do Apache Commons. Para maiores informações:

Consulte a documentação do repositório fonte do Apache.
Vá diretamente para o repositório de origem SVN.

WebLogic

Para passar o argumento -javaagent no WebLogic:

Edite seu arquivo startWebLogic.sh , localizado no diretório bin do domínio.

Perto do início do arquivo, adicione:

bash

$export JAVA_OPTIONS="$JAVA_OPTIONS -javaagent:/full/path/to/newrelic.jar"

Para instância do servidor de administração, siga as instruções do Linux/macOS ou Windows. Você não pode usar o console de administração para instalar a instância do servidor de administração.

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

No console de administração, navegue até Environments > Servers > (select a server) > Server Start > Arguments.
De Arguments, adicione:
```
-javaagent:/full/path/to/newrelic.jar
```
Salve a página e reinicie a instância do servidor.

WebSphere

Para transmitir o argumento -javaagent no WebSphere:

No console de administração, selecione Servers > Application servers > (select a server) > Configuration > Service Infrastructure > Java and Process Management.
Selecione Process Definition > Additional Properties e depois selecione Java Virtual Machine.
No campo Generic JVM arguments , adicione o argumento -javaagent para seu arquivo newrelic.jar :
```
-javaagent:/full/path/to/newrelic.jar
```
Selecione Apply e depois selecione Save.
Reinicie seu servidor.

Para obter informações adicionais, consulte a documentação sobre coleta de métricas do WebSphere PMI.

Comunidade WebSphere

Para transmitir o argumento -javaagent no WebSphere Community Edition, consulte o jar do agente New Relic na variável de ambiente JAVA_OPTS ao executar o comando de inicialização:

bash

$export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar" && startup

Perfil do WebSphere Liberty

Para transmitir o argumento -javaagent no WebSphere Liberty Profile:

Edite ${server.config.dir}/jvm.options.
Adicione o argumento -javaagent para apontar para seu arquivo newrelic.jar :
```
-javaagent:/full/path/to/newrelic.jar
```
Reinicie seu servidor.

Wildfly

Para passar o argumento -javaagent no Wildfly (se estiver usando o Wildfly 11 ou superior, consulte instruções adicionais de instalação):

Edite as propriedades da JVM para seu grupo de servidores, localizadas em:
```
domain/configuration/domain.xml
```

Modifique as propriedades para incluir o argumento -javaagent :

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

Plataforma	Instruções
Unix ou macOS	Na parte inferior de `bin/standalone.conf`, adicione: `JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar"`
Windows	Em `bin/standalone.bat`, encontre esta linha: `rem Setup JBoss specific properties` Em seguida, adicione: `set "JAVA_OPTS=-javaagent:C:/full/path/to/newrelic.jar %JAVA_OPTS%"`

Plataforma

Instruções

Unix ou macOS

Na parte inferior de bin/standalone.conf, adicione:

JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/newrelic.jar"

Windows

Em bin/standalone.bat, encontre esta linha:

rem Setup JBoss specific properties

Em seguida, adicione:

set "JAVA_OPTS=-javaagent:C:/full/path/to/newrelic.jar %JAVA_OPTS%"

Outros servidores de aplicativos

O agente Java da New Relic funciona em qualquer servidor de aplicativos compatível. Se o seu servidor de aplicativos não estiver listado neste documento, siga os procedimentos padrão para que seu servidor de aplicativos passe esse argumento para a JVM antes do jar do aplicativo:

-javaagent:/full/path/to/newrelic.jar

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

Incluir o agente Java com um argumento JVM

ColdFusion .css-21sua1{background:none;border:none;width:0;padding:0;}

Geronimo

Glassfish

Importante

Grails

Passe com guerra de corrida

JBoss

Definido com modo de domínio (6.x EAP e 7.0 AS)

Definir com modo autônomo (outras versões)

Jetty

Se você definir exec em jetty.sh

Se você definir exec em start.ini

Play

Play 1.2.4

Play 2.0

Play 2.2

Play 2.3, 2.4 e 2.5

Resin

Importante

Solr

Solr autônomo 5.x ou superior

Solr autônomo 4.x ou inferior

Servidor de aplicativos Solr

Bota Primavera

Invólucro Tanuki

Dica

Tomcat

Com setenv.sh

Com setenv.bat

Com catalina.sh (NÃO RECOMENDADO)

Com catalina.bat (NÃO RECOMENDADO)

Com Windows

Com o daemon Apache Commons

WebLogic

Servidores de administração em Linux ou macOS

Servidores de administração no Windows

Instância de servidor gerenciado

WebSphere

Comunidade WebSphere

Perfil do WebSphere Liberty

Wildfly

Definir com modo de domínio

Definir com modo autônomo

Outros servidores de aplicativos

ColdFusion

Se você definir exec em `jetty.sh`

Se você definir exec em `start.ini`