Skip to main content

Heroku

Heroku is a platform as a service (PaaS) that enables developers to build, run, and operate applications entirely in the cloud. This integration allows you to send logs and metrics from your Heroku applications to your Logz.io account.

Logs​

Set up a Heroku log drain​

Before you begin, you'll need: Heroku CLI

Enable the runtime metrics​

Optional - run the following command to include application run time metrics in your logs (for example, http status code, customer's IP, and more):

heroku labs:enable log-runtime-metrics -a <<HEROKU-APP-NAME>>

Set up the log drain in Heroku CLI​

Run this command in the command line.

heroku drains:add "https://<<LISTENER-HOST>>:8081?token=<<LOG-SHIPPING-TOKEN>>" -a <<HEROKU-APP-NAME>>

Replace <<LOG-SHIPPING-TOKEN>> with the token of the account you want to ship to.

Replace <<LISTENER-HOST>> with the host for your region.

Replace <<HEROKU-APP-NAME>> with the name of the app in Heroku.

You can add custom fields to each log message, allowing you to identify different Heroku apps and filter your data in Logz.io. To do this, add &<<KEY>>=<<VALUE>> to the end of the Logz.io URL.

For example:

heroku drains:add "https://<<LISTENER-HOST>>:8081?token=<<LOG-SHIPPING-TOKEN>>&<<KEY>>=<<VALUE>>" -a <<HEROKU-APP-NAME>>

Check Logz.io for your logs​

Give your logs some time to get from your system to ours, and then open Open Search Dashboards to confirm you're shipping logs.

If you still don't see your logs, see log shipping troubleshooting.

Metrics​

Before you begin, you'll need:

note

Project's GitHub repo

note

All commands in these instructions should be run from your Heroku app directory.

Download the Telegraf configuration file​


wget -O telegraf.conf https://raw.githubusercontent.com/logzio/heroku-buildpack-telegraf/master/telegraf.conf

Enable environment variable​


heroku labs:enable runtime-dyno-metadata -a <<HEROKU_APP_NAME>>

heroku config:set LOGZIO_LISTENER=https://<<LISTENER-HOST>>:8053   

heroku config:set LOGZIO_TOKEN=<<PROMETHEUS-METRICS-SHIPPING-TOKEN>>

git add .

git commit -m "Telegraf config" 

git push heroku main

Replace the placeholders to match your specifics. (They are indicated by the double angle brackets << >>):

  • Replace <<LISTENER-HOST>> with the Logz.io Listener URL for your region, configured to use port 8052 for http traffic, or port 8053 for https traffic.
  • Replace <<PROMETHEUS-METRICS-SHIPPING-TOKEN>> with a token for the Metrics account you want to ship to. Look up your Metrics token.
  • Replace <<HEROKU_APP_NAME>> with the name of your Heroku app

Add the buildpack to the list of your Heroku buildpacks​


heroku buildpacks:add --index 1 https://github.com/logzio/heroku-buildpack-telegraf.git

git commit --allow-empty -m "Rebuild slug"

git push heroku main

Check Logz.io for your metrics​

Give your data some time to get from your system to ours, then log in to your Logz.io Metrics account, and open the Logz.io Metrics tab.