skywalking-agent-node v0.0.1

SkyWalking NodeJS Agent

SkyWalking-Agent-Node: The NodeJS Agent for Apache SkyWalking, an alternative to skywalking-nodejs, which provides the native tracing abilities for NodeJS backend project. This project is a fork of skywalking-nodejs and is based on opentelemetry-js instrumentations

SkyWalking: an APM(application performance monitor) system, especially designed for microservices, cloud native and container-based (Docker, Kubernetes, Mesos) architectures.

Quick start

Install Dependencies

npm install --save skywalking-agent-node

Instantiate Agent

// agent.js

"use strict";
const agent = require("skywalking-agent-node");

agent.start({
  //configurations
});

Run Your Application

node -r ./agent.js app.js

This will use default configurations to start the SkyWalking agent above, if you want to specify your own configurations, here are two methods.

1. Pass configuration values to agent.start method

Install Opentelemetry Instrumentations

npm install --save @opentelemetry/auto-instrumentations-node
npm install --save @opentelemetry/instrumentation-mysql2

Note: auto-instrumentations-node is a meta package from opentelemetry-js-contrib that provides a simple way to initialize multiple Node.js instrumentations.

// agent.js

"use strict";
const agent = require("skywalking-agent-node");
const { getNodeAutoInstrumentations } = require(
  "@opentelemetry/auto-instrumentations-node",
);
const { MySQL2Instrumentation } = require(
  "@opentelemetry/instrumentation-mysql2",
);
const instrumentations = getNodeAutoInstrumentations();
instrumentations.push(new MySQL2Instrumentation());

agent.start({
  serviceName: "my-service-name",
  serviceInstance: "my-service-instance-name",
  collectorAddress: "my.collector.address:port",
  instrumentations: instrumentations, // custom instrumentations if you needed
});

2. Use environment variables

The supported environment variables are as follows: