Deploy OneAgent on Heroku

The following guidelines explain how to enable DESK monitoring for your Heroku applications by adding a DESK Heroku buildpack to your application's Heroku configuration. Note: The DESK Heroku buildpack enables you to monitor all supported languages on Linux systems

What you need

• DESK environment credentials
• Heroku CLI

Also, be sure to review the list of supported applications and versions.

Installation

These guidelines explain how to integrate DESK OneAgent into your Heroku dynos and begin monitoring your Heroku applications.

Generate a PaaS token

The first step is to get your environment ID and generate a PaaS token for your DESK environment.

Environment ID

1. Login with your DESK account.

2. Select Deploy DESK from the navigation menu.

3. Click the Set up PaaS integration button. Your environment ID appears in the Environment ID text box.

4. Click Copy to copy the ID to the clipboard. You can do this at any time by revisiting this page.

API Token

The API token is used in combination with your environment ID to download OneAgent. Go to Deploy DESK > Set up PaaS integration to access the InstallerDownload token. For security reasons, it's recommended that you create a discrete token for each environment.

To generate a new token

1. Click the Generate new token button.

2. Type in a meaningful name for your token. A meaningful token name might be the name of the platform you want to monitor (for example, azure, cloud-foundry, or openshift). To view and manage your existing tokens, go to Settings -> Integration -> Platform as a Service.

3. Click Generate to create the token. The newly created token will appear in the list below.

4. Click Copy to copy the generated token to the clipboard. You can do this at any time by revisiting this page and clicking Show token next to the relevant PaaS token.

Get the Heroku CLI

To configure Heroku applications to use the DESK Heroku buildpack, you can either use the Heroku CLI or you can configure your applications using the Heroku dashboard.

Add the DESK Heroku buildpack

To integrate DESK OneAgent into your existing application, you need to add the DESK Heroku buildpack to your application's buildpacks and set your DESK environment ID and PaaS token using the commands below.

# Add the DESK buildpack
heroku buildpacks:add https://github.com/DESK/heroku-buildpack-desk.git#<version> 

# Set required credentials to your DESK environment
heroku config:set DT_TENANT=<environmentID>
heroku config:set DT_API_TOKEN=<token>

# Deploy to Heroku
git push heroku master

Once you push these changes, the buildpack installs DESK OneAgent to automatically monitor your application.

Additional configuration

The DESK Heroku buildpack supports the following configurations:

try {
    require('@desk/oneagent')();
} catch(err) {
    console.log(err.toString());
}

  $ npm uninstall --save @desk/oneagent

Note: You can use a different DESK environment for Heroku applications that are enriched with OneAgent.

$ curl "https://<environmentID>.live.desk.com/api/v1/deployment/installer/agent/connectioninfo?Api-Token=<token>"