docs: adapt the documentation snapshot to the 0.9.0 release

The docs moved into docs/ on master describe features that landed after
0.9.0. Correct them so this branch documents the released agent:

- Remove the Node.js runtime metrics page and its menu, index, and README
  entries. The meter reporter and the SW_AGENT_*RUNTIME_METRICS* options
  arrive in #139 and #143, after 0.9.0.
- SW_AGENT_TRACE_TIMEOUT applies to trace report requests only; there is no
  meter or service management client in this release.
- The collector address is passed to gRPC as it is, so a comma-separated
  list of backend addresses is not supported.
- agent.flush() sends buffered trace segments only.
- Build guide: 0.9.0 has no unit test job and no tests/remote or
  tests/runtime; trace reporting lives in src/agent/protocol/grpc/.
- Pin the test workflow and package lock links to v0.9.0.

Verified against the v0.9.0 tree: every SW_* variable read by the source is
documented and nothing is documented that the release does not read.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
13 files changed
tree: 8e95348a031fec1d93eef3f86f1e8519535fd12d
  1. .claude/
  2. .github/
  3. .husky/
  4. dist/
  5. docs/
  6. scripts/
  7. src/
  8. tests/
  9. .asf.yaml
  10. .dockerignore
  11. .editorconfig
  12. .eslintrc.js
  13. .file-headerrc
  14. .gitignore
  15. .gitmodules
  16. .licenserc.yaml
  17. .prettierrc
  18. CHANGELOG.md
  19. CONTRIBUTING.md
  20. jest.config.js
  21. jest.setup.js
  22. LICENSE
  23. NOTICE
  24. package-lock.json
  25. package.json
  26. README.md
  27. tsconfig.json
README.md

Apache SkyWalking Node.js Agent

The Apache SkyWalking Node.js Agent reports distributed traces to an Apache SkyWalking OAP server. It instruments supported Node.js libraries without changes to their source code.

Build npm version GitHub stars

Requirements

Install

npm install skywalking-backend-js

Quick start

Start the agent before loading the modules that it must instrument:

import agent from 'skywalking-backend-js';

agent.start({
  serviceName: 'checkout-service',
  collectorAddress: '127.0.0.1:11800',
});

The same values can be set with environment variables:

export SW_AGENT_NAME=checkout-service
export SW_AGENT_COLLECTOR_BACKEND_SERVICES=127.0.0.1:11800

See Quick start for the full setup and a way to load the agent with Node.js --require.

Documentation

The documentation index includes:

  • setup and all configuration values;
  • tracing behavior and trace filtering;
  • supported library plugins and AWS SDK v2 behavior;
  • serverless and Webpack support;
  • build, test, plugin development, and release guides.

Main features

  • Automatic trace collection for Node.js HTTP, database, messaging, and framework libraries.
  • SkyWalking trace context transfer between supported services.
  • Optional wrappers for AWS Lambda and Azure Functions.

Contributing

Read Build and test before sending a change. Plugin authors should also read Plugin development.

Contact

  • Report Node.js Agent problems in the Apache SkyWalking issue tracker with Nodejs in the issue title.
  • Join the dev@skywalking.apache.org mailing list by sending a message to dev-subscribe@skywalking.apache.org.
  • Join the skywalking channel on Apache Slack.

License

Apache License 2.0