This add-on is operated by Takipi, Inc.
Find root cause without sifting through logs
Last updated 11 April 2016
Table of Contents
Takipi is an add-on for seeing when and why your code breaks in production. Takipi shows you the errors that impact your users the most and gives you the actionable information you need to fix them. It works at the JVM level, without relying on log files.
Adding Takipi to a production application gives you the ability to:
Detect all types of errors: caught and uncaught exceptions, logged errors, logged warnings and HTTP errors.
Fix errors: see the code and variable state for your errors, right as if you were there when they happened
Reproduce errors: Takipi shows you the parameters that were entered into your code for simple error reproduction
Focus on critical errors before they impact users: filtering capabilities let you find errors from new deployments and uncover high priority issues
Takipi encrypts all the sensitive data using a symmetrical AES-256 encryption key generated upon provisioning.
Supported languages and frameworks
Takipi supports OpenJDK and HotSpot versions 6, 7 and 8 (64-bit only).
Takipi supports all JVM languages, including Java, Scala, Groovy, Clojure, and JRuby.
Provisioning the add-on
Takipi can be attached to a Heroku application via the CLI:
A list of all plans available can be found here.
$ heroku addons:create takipi -----> Adding takipi to sharp-mountain-4005... done, v18 (free)
Once Takipi has been added a
TAKIPI_SECRET_KEY setting will be available in the app configuration and will contain the encryption key used to encrypt the data between Heroku and Takipi. This can be confirmed using the
heroku config:get command.
$ heroku config:get TAKIPI_SECRET_KEY S0000#abcdefgh#ijklmnopqrstuvwxyz1234567890#0000
Before using Takipi you must set up the Takipi custom buildpack.
As part of working at the JVM level, Takipi runs as a Java agent and a native daemon collector process. As a result, in order to install Takipi as an add-on, you will need to add our custom buildpack as part of the Heroku build. More information about the Takipi architecture can be found here.
To set up the buildpack, enter the directory of your app and run:
$ heroku buildpacks:add https://github.com/takipi/heroku-buildpack-takipi
Connect Takipi Agent
In order to connect Takipi agent to your JVM you will need to tell the Java process to load the Takipi agent by using the argument:
web: java $JAVA_OPTS -agentlib:TakipiAgent -jar target/dependency/jetty-runner.jar --port $PORT target/*.war
Once the buildpack and Procfile are set, recompile your application (push a change).
Then once you have Takipi installed, just add
-agentlib:TakipiAgent as a JVM argument.
java -agentlib:TakipiAgent -jar sample-jar.jar
The Takipi agent will begin detecting errors in your JVM and sending them to your Takipi dashboard after the add-on is installed and connected, either locally or through the Heroku buildpack.
For more information on the features available within the Takipi dashboard please see the docs at docs.takipi.com.
The Takipi dashboard allows you to see all the errors that your app is generating. Filtering and alerting capabilities enable you to zoom in on the most critical errors, and workflow support like labels and integration with JIRA makes working and sharing with teammates a breeze.
The dashboard can be accessed via the CLI:
$ heroku addons:open takipi Opening takipi for sharp-mountain-4005…
or by visiting the Heroku Dashboard and selecting the application in question. Select Takipi from the Add-ons menu.
Migrating between plans
Users can migrate between plans if they wish to change their length of data retention or maximum dynos allowed. Migrating between plans is a simple process. Users will see the new plan go into effect for errors and exceptions generated after the change. Existing error information will not be affected. Use the
heroku addons:upgrade command to migrate to a new plan.
$ heroku addons:upgrade takipi:production -----> Upgrading takipi:production to sharp-mountain-4005... done, v18 ($149/mo) Your plan has been updated to: takipi:production
Removing the add-on
The Takipi add-on can be removed via the CLI.
This will destroy all associated data and cannot be undone!
$ heroku addons:destroy takipi -----> Removing takipi from sharp-mountain-4005... done, v20 (free)
All Takipi support and runtime issues should be submitted via one of the Heroku Support channels. Any non-support related issues or product feedback is welcome at our full support center or by e-mail.