README.md

# skywalking-nodejs

<img src="https://skywalkingtest.github.io/page-resources/3.0/skywalking.png" alt="Sky Walking logo" height="90px" align="right" />

skywalking-nodejs is the Node.js agent for [Apache SkyWalking(Incubating) APM](https://github.com/apache/incubator-skywalking).

[![Build Status](https://travis-ci.org/OpenSkywalking/skywalking-nodejs.svg?branch=master)](https://travis-ci.org/OpenSkywalking/skywalking-nodejs)

## Quick Start

### Installation
Add the skywalking-nodejs module as a dependency to your application:
> npm install skywalking-nodejs --save

### Initialization
It’s important that the agent is started before you require any other modules in your Node.js application. and you should
require and start the agent in your application’s main file.

```javascript
require('skywalking-nodejs').start({
    // Application code is showed in sky-walking-ui. Suggestion: set an unique name for each application, one
    // application's nodes share the same code.
    // this value cannot be empty.
    applicationCode: 'test',
    // Collector agent_gRPC/grpc service addresses.
    // default value: localhost:11800
    directServers: 'localhost:11800'
});
```

## Contribution
Welcome and highly value any suggestion. Join our [gitter room](https://gitter.im/openskywalking/Lobby).

## License
[Apache 2.0](LICENSE.md)