Skip to content

Latest commit

 

History

History
215 lines (151 loc) · 9.91 KB

README.md

File metadata and controls

215 lines (151 loc) · 9.91 KB
Raw

Monti APM - Performance Monitoring for Meteor

Github Workflow Status

Monti APM - Performance Monitoring for Meteor

This package is based on meteorhacks/kadira.

Getting started

  1. Create an account at https://montiapm.com
  2. From the UI, create an app. You'll get an AppId and an AppSecret.
  3. Run meteor add montiapm:agent in your project
  4. Configure your Meteor app with the AppId and AppSecret by adding the following code snippet to a server/monti.js file:
Meteor.startup(function() {
  Monti.connect('<AppId>', '<AppSecret>');
});

Now you can deploy your application and it will send information to Monti APM. Wait up to one minute and you'll see data appearing in the Monti APM Dashboard.

Compatibility

montiapm:agent is compatible with:

  • Meteor 1.4.3.2 and newer
  • Internet Explorer 9 and newer web browsers
  • Can be used with Monti APM or the open sourced version of Kadira, though many new features are not supported by Kadira

Features that require a newer version of Meteor are only enabled when using a supported version. For example, monitoring incoming HTTP requests is automatically enabled when the app uses Meteor 1.7 or newer.

Auto Connect

Your app can connect to Monti APM using environment variables or Meteor.settings.

Using Meteor.settings

Use the following settings.json file with your app:

{
  ...
  "monti": {
    "appId": "<appId>",
    "appSecret": "<appSecret>"
  }
  ...
}

The run your app with meteor --settings=settings.json.

Using Environment Variables

Export the following environment variables before running or deploying your app:

export MONTI_APP_ID=<appId>
export MONTI_APP_SECRET=<appSecret>

Error Tracking

Monti APM comes with built in error tracking solution for Meteor apps. It has been enabled by default. Uncaught errors, unhandled promise rejections and errors logged by Meteor are automatically tracked.

To manually track an error, you can use Monti.trackError:

try {
  functionThatCouldFail();
} catch (err) {
  Monti.trackError(err);
}

Monti APM can use source maps to show where in the original code the error occurred. Learn more in our docs.

Options

The Monti APM agent can be configured by

  • environment variables, prefixed with either MONTI_ or KADIRA_
  • settings.json in the monti or kadira object. Options other than appId and appSecret should be in monti.options or kadira.options.
  • code with Monti.connect('app id', 'app secret', options)

You should use the same method that you used to give the agent the app id and secret.

List of Options

Name Environment Variable Default Description
appId APP_ID none
appSecret APP_SECRET none
enableErrorTracking OPTIONS_ENABLE_ERROR_TRACKING true Enable sending errors to Monti APM
disableClientErrorTracking OPTIONS_DISABLE_CLIENT_ERROR_TRACKING false Disable sending client errors to Monti APM
endpoint OPTIONS_ENDPOINT https://engine.montiapm.com Monti / Kadira engine url
hostname OPTIONS_HOSTNAME Server's hostname What the instance is named in Monti APM
uploadSourceMaps UPLOAD_SOURCE_MAPS true Enables sending source maps to Monti APM to improve error stack traces
recordIPAddress RECORD_IP_ADDRESS 'full' Set to 'full' to record IP Address, 'anonymized' to anonymize last octet of address, or 'none' to not record an IP Address for client errors
eventStackTrace EVENT_STACK_TRACE false If true, records a stack trace when an event starts. Slightly decreases server performance.
disableNtp OPTIONS_DISABLE_NTP false Disable NTP time synchronization used to get the accurate time in case the server or client's clock is wrong
stalledTimeout STALLED_TIMEOUT 1800000 (30m) Timeout used to detect when methods and subscriptions might be stalled (have been running for a long time and might never return). The value is in milliseconds, and can be disabled by setting it to 0
proxy OPTIONS_PROXY none Allows you to connect to Monti APM using a proxy
disableInstrumentation DISABLE_INSTRUMENTATION false Disables recording most metrics and traces. Can be configured using Meteor.settings, or by env variable

Traces

The agent collects traces of methods and publish functions. Every minute, it sends the outlier traces to Monti APM for you to view.

By default, it tracks events for:

  • method/pubsub start
  • wait time
  • uncaught errors
  • db
  • http
  • email
  • async (time between the fiber yielding and running again)
  • method/pubsub complete

Time between an event ending and the next event starting becomes a compute event.

The agent records up to one level of nested events.

You can add custom events to the traces to time specific code or events, or to provide more details to the trace.

const event = Monti.startEvent('event name', {
  details: true
});

// After code runs or event happens
Monti.endEvent(event, {
  additionalDetails: true
});

You can use any name you want. The second parameter is an object with data that is shown to you in the Monti APM UI. The data objects from starting and ending the event are merged together.

Please note that the total size of all traces uploaded per server every 20 seconds is limited (usually around 5mb), and if it is too large the traces and metrics are not stored. Avoid having 1,000's of custom events per trace or adding very large data objects.

Filtering Trace Data

The agent stores user ids, queries, arguments, and other data with each trace to help you fix performance issues and errors. If your app deals with sensitive information, you can use filters to limit what is sent.

Add a filter with:

Monti.tracer.addFilter((eventType, data, { type: traceType, name: traceName }) => {
  if (
    // traceType can be 'method', 'sub', or 'http'
    traceType === 'method' &&
    // traceName has the method or publication name. For http traces
    // it is '<http method>-<route name>', for example 'POST-/user/:id'.
    traceName === 'account.setPassword' &&
    // The eventType can be start, db, http, email, wait, async,
    // custom, fs, error, or complete.
    eventType === 'start'
  ) {
    // data is the object shown in Monti APM when clicking "Show More" in a trace.
    // What is in data depends on the event type.
    delete data.params;
  }

  return data;
});

Monti.tracer.addFilter((eventType, data) => {
  if (eventType === 'db') {
    delete data.selector;
  }

  return data;
});

Some objects are turned into a JSON string before being stored in the trace. To remove the content of a field from these objects, you can use:

Monti.tracer.redactField('apiKey');

Monti.tracer.redactField('authorization');

The value of the field is changed to Monti: redacted.

The fields are redacted from:

  • headers in traces for incoming HTTP requests
  • params sent when calling a method or subscribing to a publication
  • body of incoming http requests, when the body is JSON

By default, the password field is redacted.

Development

Tests:

npm run test

# Run tests for specific Meteor version
npm run test -- --release 1.8.1

Lint

Make sure you install the dev dependencies first with npm install.

npm run lint