Nutmeg Pumpkin Macchiato

    @appsignal/nodejs
    TypeScript icon, indicating that this package has built-in type declarations

    2.4.2 • Public • Published

    @appsignal/nodejs

    npm (scoped) node-current (scoped)

    The core AppSignal for Node.js library.

    See also the mono repo README for more information.

    Installation

    First, sign up for an AppSignal account and run our automated install tool, which will install @appsignal/nodejs and any relevant integrations to your project:

    npx @appsignal/cli install

    You can also skip the automated tool and add @appsignal/nodejs to your package.json on the command line with npm/yarn:

    yarn add @appsignal/nodejs
    npm install --save @appsignal/nodejs

    Alternatively, you can manually add the @appsignal/nodejs package to your package.json. Then, run yarn install/npm install.

    Installing the AppSignal for Node.js integration builds a native extension. In order to compile it, macOS users will need to install the Xcode Developer Tools. Linux users will need the dependencies outlined here. Windows is not supported.

    You can then import and use the package in your bundle:

    const { Appsignal } = require("@appsignal/nodejs");
    
    const appsignal = new Appsignal({
      active: true,
      name: "<YOUR APPLICATION NAME>"
      pushApiKey: "<YOUR API KEY>"
    });
    
    // ...all the rest of your code goes here!

    In order to auto-instrument modules, the Appsignal module must be both required and initialized before any other package.

    Extension

    This package also contains the C++ extension, and the install script for the agent. The native extension is a bridge between the Node.js runtime and our agent.

    Keywords

    none

    Install

    npm i @appsignal/nodejs

    DownloadsWeekly Downloads

    4,770

    Version

    2.4.2

    License

    MIT

    Unpacked Size

    434 kB

    Total Files

    108

    Last publish

    Collaborators

    • as_unflxw
    • nchartiot
    • luismiramirez
    • matsimitsu
    • wesoudshoorn
    • jvanbaarsen
    • thijsc
    • tombruijn
    • jkreeftmeijer