Google Git
Sign in
apache / skywalking-nodejs / 78d3a2a330c1f2d7589ff5cf937a40493b8c9f0d
commit78d3a2a330c1f2d7589ff5cf937a40493b8c9f0d[log] [tgz]
authorTomasz Pytel <tompytel@gmail.com>Fri Feb 26 23:03:09 2021 -0300
committerGitHub <noreply@github.com>Sat Feb 27 10:03:09 2021 +0800
tree8652a57a96e997897bb9218694a6d995b6bce9d1
parent1b9d8d77d66850cc73153e7b28257e78264ee063 [diff]
Add PgPlugin - PosgreSQL (#31)
20 files changed
tree: 8652a57a96e997897bb9218694a6d995b6bce9d1
  1. .github/
  2. dist/
  3. docs/
  4. scripts/
  5. src/
  6. tests/
  7. protocol
  8. .asf.yaml
  9. .dockerignore
  10. .editorconfig
  11. .gitignore
  12. .gitmodules
  13. .prettierrc
  14. CHANGELOG.md
  15. jest.config.js
  16. jest.setup.js
  17. LICENSE
  18. NOTICE
  19. package-lock.json
  20. package.json
  21. README.md
  22. tsconfig.json
  23. tslint.json
README.md

SkyWalking NodeJS Agent

SkyWalking-NodeJS: The NodeJS Agent for Apache SkyWalking, which provides the native tracing abilities for NodeJS backend project.

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

GitHub stars Twitter Follow

Build npm version

Install SkyWalking NodeJS package from npmjs

$ npm install --save skywalking-backend-js

Set up NodeJS Agent

SkyWalking NodeJS SDK requires SkyWalking backend (OAP) 8.0+ and NodeJS >= 10.

import agent from 'skywalking-backend-js';

agent.start();

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

  • Pass those values to agent.start method, such as:
agent.start({
  serviceName: 'my-service-name',
  serviceInstance: 'my-service-instance-name',
  collectorAddress: 'my.collector.address:port',
});

note that all options given (including empty/null values) will override the corresponding default values, e.g. agent.start({ collectorAddress: '' }) will override the default value of collectorAddress to empty string, causing errors like DNS resolution failed.

  • Use environment variables.

The supported environment variables are as follows:

Environment VariableDescriptionDefault
SW_AGENT_NAMEThe name of the serviceyour-nodejs-service
SW_AGENT_INSTANCEThe name of the service instanceRandomly generated
SW_AGENT_COLLECTOR_BACKEND_SERVICESThe backend OAP server address127.0.0.1:11800
SW_AGENT_AUTHENTICATIONThe authentication token to verify that the agent is trusted by the backend OAP, as for how to configure the backend, refer to the yaml.not set
SW_AGENT_LOGGING_LEVELThe logging level, could be one of CRITICAL, FATAL, ERROR, WARN(WARNING), INFO, DEBUGINFO
SW_IGNORE_SUFFIXThe suffices of endpoints that will be ignored (not traced), comma separated.jpg,.jpeg,.js,.css,.png,.bmp,.gif,.ico,.mp3,.mp4,.html,.svg
SW_TRACE_IGNORE_PATHThe paths of endpoints that will be ignored (not traced), comma separated``
SW_SQL_PARAMETERS_MAX_LENGTHThe maximum string length of SQL parameters to log512
SW_AGENT_MAX_BUFFER_SIZEThe maximum buffer size before sending the segment data to backend'1000'

Supported Libraries

There are some built-in plugins that support automatic instrumentation of NodeJS libraries, the complete lists are as follows:

LibraryPlugin Name
built-in http and https modulehttp / https
expressexpress
axiosaxios
mysqlmysql
pgpg

Compatible Libraries

The following are packages that have been tested to some extent and are compatible because they work through the instrumentation of an underlying package:

LibraryUnderlying Plugin Name
requesthttp / https
request-promisehttp / https
koahttp / https

Contact Us

License

Apache 2.0