JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8810
  • Score
    100M100P100Q193847F
  • License

Agent for AppOptics APM

Package Exports

  • appoptics-apm

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (appoptics-apm) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

AppOptics APM

The appoptics-apm module provides AppOptics instrumentation for Node.js.

It has the ability to report performance metrics on an array of libraries, databases and frameworks.

It requires an AppOptics account to view metrics. Get yours; it's free.

Dependencies

The agent compiles a C++ addon during install, thus you’ll need to have the following on the system prior to installing the agent:

  • gcc version 4.7 and above
  • for node-gyp: make and python 2.x (version 2.7 is recommended)

Installation

The appoptics-apm module is available on npm and can be installed by navigating to your app root and running:

npm install --save appoptics-apm

The agent requires a service key, obtained from the AppOptics dashboard under "Organization Details", to connect to your account. This is set via the APPOPTICS_SERVICE_KEY environment variable, make sure it is available in the environment where your application is running:

export APPOPTICS_SERVICE_KEY="api-token-here:your-service-name"

Then, at the top of your main js file for your app, add this:

require('appoptics-apm')

Now restart your app and you should see data in your AppOptics dashboard in a minute or two.

Installation warning

appoptics-apm should be the first file required. If, for example, you are using the esm package to enable ES module syntax (import rather than require) and you use the following command to invoke your program node -r esm index.js then esm.js is loaded first and appoptics-apm is unable to instrument modules. You can use it, just make sure to require appoptics-apm first, e.g., node -r appoptics-apm -r esm index.js.

If you are using the custom instrumentation SDK then appoptics must be loaded in the code so that a reference to the SDK is obtained, like const ao = require('appoptics-apm'). It is still be possible to use the command line node -r appoptics-apm -r esm index.js; the require in the code will just get a reference to the results of the command line require.

Configuration

See the Configuration Guide

Upgrading

To upgrade an existing installation, navigate to your app root and run:

npm install --save appoptics-apm@latest

Adding Your Own Spans

Our GitHub repository hosts an overview and a complete API reference.

Support

If you find a bug or would like to request an enhancement, feel free to file an issue. For all other support requests, please email support@appoptics.com.

Contributing

You are obviously a person of great sense and intelligence. We happily appreciate all contributions to the oboe module whether it is documentation, a bug fix, new instrumentation for a library or framework or anything else we haven't thought of.

We welcome your PRs. We ask that any new instrumentation submissions have corresponding tests that accompany them. This way we won't break any of your additions when we (and others) make subsequent changes.

Developer Resources

We have made an effort to expose technical information to enable developers to contribute to the appoptics module for any that may wish to do so. Below is a good source of information and help for developers:

  • The AppOptics Knowledge Base has a large collection of technical articles or, if needed, you can submit a support request directly to the team.

If you have any questions or ideas, don't hesitate to contact us anytime.

Layout of the module

The oboe module uses a standard layout. Here are the notable directories.

lib/        # Span and Event constructors
lib/probes  # Auto loaded instrumentation
test/       # Mocha test suite

Compiling the C extension

This module utilizes a C++ node extension to interface with the liboboe.so library. liboboe is installed as part of the appoptics-bindings package which is a dependency of this package. It is used to report host and performance metrics to AppOptics servers.

If you would like to work with the C++ extension, clone the github appoptics-bindings-node repository and work with that.

License

Copyright (c) 2016, 2017, 2018 SolarWinds, LLC

Released under the Librato Open License