Register

First, please visit the Trace website, and register with the TRACE-IT beta key: https://trace-app.risingstack.com/register.

Create an account

Once you are registered, you can log in with the provided credentials. Here look for the account creation page and create an account. With each account, there is an apiKey associated - you will need this when installing the Trace collector.

For each account, you can invite multiple users, so can they interact with Trace as well. To do so, first they have to register, and then you can add existing users to the account (currently a user can be logged in only from one device).

Install Trace

To make the most of Trace, please install Trace at all your Node.js based microservices:

npm i @risingstack/trace --save

Besides this, you have to include Trace as the first line of your application:

var trace = require('@risingstack/trace');

The last thing you have to do is to add a config file for Trace in the root of your project with the name trace.config.js. A sample file can look like this:

var config = {};
 
config.appName = 'Users';
 
config.ignoreHeaders = {
  'user-agent': ['007']
};
 
config.reporter = require('@risingstack/trace/lib/reporters').trace.create({
 apiKey: '1234',
 appName: config.appName
});
 
module.exports = config;

Here please pay special attention to the ignoreHeaders option. With this, you can specify which requests should not be accounted. This can be extremely useful if you want to filter out the noise generated by your health checks for example.

Also, the appName is pretty important as well - in the Trace application your services will appear using this name.

For more info, please visit: https://www.npmjs.com/package/@risingstack/trace

Seeing your data

To be able to take a look at your topology, initially it may take a couple of minutes until they show up, so don't panic :)

Need help?

Ping Gergely at gergely@risingstack.com any time if you have any questions!