Java agent with Scala on Heroku

Heroku is a Platform as a Service (PaaS) solution for hosting web applications in various agent languages, including Scala. With New Relic, you can extend Heroku with metrics from New Relic APM, Browser, and Insights.

For non-Scala installations, see Java agent and Heroku.

Compatibility and requirements

1. Enable the New Relic add-on

After you ensure that you meet the requirements, enable the New Relic agent add-on in Heroku.

You must deploy your Java app to Heroku, following the Heroku instructions at least through the Deploy the app step, before you can enable the New Relic agent add-on.

  1. Log in to your Heroku account.
  2. From the New Relic APM Add-On Page, select a subscription plan.
  3. Select Install New Relic APM, and then select your target app from the dropdown.

Installing the add-on automatically creates a New Relic account and configures access for Heroku servers.

2. Configure your Heroku environment for New Relic

After you complete the requirements and enable the New Relic add-on, configure your Scala Heroku environment for New Relic:

  1. Edit your Procfile to point to the agent jar in your app's root folder. Replace the contents of the file, substituting X.Y.Z with the latest agent version:

    web: target/universal/stage/bin/play-getting-started -Dhttp.port=${PORT} -J-javaagent:/app/target/universal/stage/lib/com.newrelic.agent.java.newrelic-agent-X.Y.Z.jar -J-Dnewrelic.config.file=conf/newrelic.yml

    OR

    Identify the path to newrelic.jar with the JAVA_OPTS environment variable.

  2. Edit your build.sbt. Call the agent, substituting X.Y.Z with the latest Java agent version:

    Custom build.sbt
    name := """play-getting-started"""
    version := "1.0-SNAPSHOT"
    lazy val root = (project in file(".")).enablePlugins(PlayScala)
    scalaVersion := "2.11.7"
    libraryDependencies ++= Seq(
    jdbc,
    cache,
    "org.postgresql" % "postgresql" % "9.4-1201-jdbc41",
    ws
    )
    libraryDependencies <+= scalaVersion("org.scala-lang" % "scala-compiler" % _ )
    libraryDependencies ++= Seq("com.newrelic.agent.java" % "newrelic-agent" % "X.Y.Z")
    libraryDependencies ++= Seq("com.newrelic.agent.java" % "newrelic-api" % "X.Y.Z")
  3. Download a customized newrelic.yml file from your APM account settings:

    How to download a custom newrelic.yml
    1. Log in to dashboard.heroku.com.
    2. Select your app.
    3. Select Add-ons > New Relic APM.
    4. From the New Relic UI's account dropdown, select Account settings.
    5. In the Update your New Relic agent section, download the latest agent for your Java SE release.
    6. Unzip the downloaded file.
    7. Copy newrelic.yml to the scala-getting-started/conf directory:

  4. Edit newrelic.yml to customize the app_name setting with a descriptive app name.
  5. Also in newrelic.yml, add your license key to the license_key setting.

3. Push your changes and open the app

After you configure your Heroku environment for New Relic, push your changes and open the app to monitor it with New Relic.

  1. Push your changes to the dyno with this Heroku toolbelt command:

    git add .
    git commit -m 'YOUR COMMIT MESSAGE'
    git push heroku master
  2. Open your app in your browser with this Heroku toolbelt command:

    heroku open
  3. Generate some traffic to your app and wait a few minutes.
  4. Check your app's performance in Heroku by selecting your app and then selecting the New Relic add-on.

If no data appears or if you have problems, follow the troubleshooting tips.

Troubleshooting your installation

  • If you don't see the New Relic add-on after you generate traffic, go to Heroku, select Find More Add Ons, and add the New Relic APM add-on.
  • If no data appears after waiting a few minutes, see No data appears with Heroku (Java).

For more help

Additional documentation resources include:

Recommendations for learning more: