search close

Heroku Install

access_time Updated Jun 29, 2022

The Signal Sciences agent can be deployed with Heroku. The installation process is compatible with any of the language buildpacks.

Installation

  1. Log in to Heroku.

    heroku login
  2. Add the Signal Sciences buildpack to your application settings.

    heroku buildpacks:add --index 1 https://dl.signalsciences.net/sigsci-heroku-buildpack/sigsci-heroku-buildpack_latest.tgz

    Note: The Signal Sciences buildpack must run first or before your application’s primary buildpack.

  3. In your Procfile file, add sigsci/bin/sigsci-start so it precedes your existing start command:

    web: sigsci/bin/sigsci-start YOUR-APPLICATION'S-START-COMMAND

    Example:

    web: sigsci/bin/sigsci-start node index.js
  4. Locate the Agent Keys for your Signal Sciences site:

    1. Log in to the Signal Sciences console.

    2. Select a site if you have more than one site.

    3. Click Agents in the navigation bar. The agents page appears.

    4. Click View agent keys. The agent keys window appears.

      The 'View agent keys' button.
    5. Copy the Agent Access Key and Agent Secret Key.

      The agent keys window.
  5. Add the Signal Sciences agent keys to your application’s environment variables.

    heroku config:set SIGSCI_ACCESSKEYID=access-key-goes-here
    heroku config:set SIGSCI_SECRETACCESSKEY=secret-key-goes-here
  6. Deploy your application. Heroku applications are typically deployed with the following commands:

    git add .
    git commit -m "my comment here"
    git push heroku master

Configuration

  • Each time you deploy your application, Heroku will automatically assign a new random name for the agent. An agent name for each deployment can be specified by setting the SIGSCI_SERVER_HOSTNAME environment variable:

    heroku config:set SIGSCI_SERVER_HOSTNAME=agent-name
  • Agent access logging can be enabled by setting the SIGSCI_REVERSE_PROXY_ACCESSLOG environment variable:

    heroku config:set SIGSCI_REVERSE_PROXY_ACCESSLOG /tmp/sigsci_access.log
  • The buildpack will install the latest version of the Signal Sciences agent by default. You can specify which agent version to install by setting the SIGSCI_AGENT_VERSION environment variable:

    heroku config:set SIGSCI_AGENT_VERSION=1.15.3

Additional configuration options are listed on the agent configuration page.