This is a downloadable TraceView cartridge for Application Performance Monitoring on OpenShift.
This downloadable cartridge installs the base TraceView libraries required to properly instrument your OpenShift application.
This is currently a work in progress. Currently, you can fully instrument your Ruby applications on OpenShift by using a combination of this cartridge and the TraceView oboe gem. Other language variations coming soon.
It's required that before installation of the cartridge, that you add your TraceView Access Key to your OpenShift application.
Make sure you have a TraceView account already setup. If not, you can quickly sign up for a free tracing account.
Once you have your TraceView account, you can retrieve your Access Key on your dashboard.
Add your Access Key to your OpenShift Application by setting an environment variable with the rhc set-env command as follows:
rhc set-env TRACEVIEW_ACCESS_KEY=Your_Access_Key -a Your_App_Name
Make sure to replace Your_Access_Key and Your_App_Name with the appropriate values.
Once this is done, you can add the downloadable cartridge to your OpenShift application via web browser or command line.
On your OpenShift application page, click on the link ...see the entire list of cartridges you can add at the bottom of the page. This brings you to a list of installable cartridges. At the bottom of the page, you will see an area to Install your own catridge as follows:
Insert the URL of the raw catridge manifest file on Github and click Next:
https://raw.githubusercontent.com/appneta/openshift-cartridge-traceview/master/metadata/manifest.yml
From there, you will be taken to a confirmation page. Click Add Cartridge to confirm the installation.
To install the catridge using the rhc command via the command-line, run the following:
rhc cartridge-add https://raw.githubusercontent.com/appneta/openshift-cartridge-traceview/master/metadata/manifest.yml -a My_App_Name
Make sure to replace My_App_Name with the actual OpenShift application name.
If at anytime you wish to remove the cartridge, it can be done with:
rhc cartridge-remove traceview -a My_App_Name
Congratulations, the TraceView cartridge for OpenShift should now be installed. If, by chance you received any errors or warnings during this process please let us know by contacting us through our support portal or on IRC @ #appneta on Freenode. We appreciate all feedback!
Once the cartridge has been installed, you can instrument your Ruby applications by simply adding the oboe gem to your application as detailed in the oboe-ruby README.
Note: Make sure that you install the Ruby gem after you add the TraceView cartridge to your application. If you
fail to do this in this order, the gem will fail to build the bundled c-extension. In this case, a gem pristine oboe
will force the gem to search for a re-link to the TraceView libraries.