Heroku is platform as a service (PaaS) providing support for several programming languages. You can use Atatus APM with your Heroku apps. Atatus APM supports PHP, Java, Ruby, Python and Node.js languages.

Follow the below mentioned steps to install Atatus in Heroku Node.js app.

  1. From Heroku dashboard, select the relevant application you have created and choose Atatus from the add-on page. There are two ways to choose the add-on.

    • From UI, you can click on the Configure add-ons and then select the subscription plan.
    • From Command line
    copy
    icon/buttons/copy
        heroku addons:create atatus:$planlevel
    
  2. Go to Atatus dashboard by clicking on the Atatus add-on and navigate to the Settings » Account Settings » License Keys in Atatus and copy the Atatus APM License key.

  3. From your terminal, go to your Node.js app directory and set the license key and application name in heroku config as follows.

    copy
    icon/buttons/copy
    heroku config:set ATATUS_APP_NAME='Node.js App'
    
    heroku config:set ATATUS_LICENSE_KEY='Your APM License Key'
    
    copy
    icon/buttons/copy
    # Verify config
    heroku config
    
  4. Install the Node.js agent and save it to your package.json.

    copy
    icon/buttons/copy
    npm install atatus-nodejs --save
    
  5. Include Atatus to the first line of the main module of your application.

    Option 1: CommonJS (require)

    copy
    icon/buttons/copy
    var atatus = require('atatus-nodejs');
    atatus.start();
    

    Option 2: ES Modules (Babel, TypeScript)

    copy
    icon/buttons/copy
    import atatus from "atatus-nodejs/start";
    // startMonitor is different from "start" function. It is used only when you are using Babel(Typescript) or ES6.
    atatus.startMonitor();
    
  6. Run the following commands to commit the changes.

    copy
    icon/buttons/copy
    git add .
    git commit -m "Add Atatus Agent"
    git push heroku main && heroku logs --tail
    
  7. Access your server from your web app or mobile app or curl. You will visualize your application's metrics within minutes.