![](\"https://raw.githubusercontent.com/rudderlabs/rudder-sdk-js/develop/assets/rs-logo-full-light.jpg\"){kind=logo}
\n \n\n \n \n \n
The Customer Data Platform for Developers
\n\n\n \n Website\n ·\n Documentation\n ·\n Community Slack\n \n
\n\n---\n\n# RudderStack Node.js SDK\n\nThe RudderStack Node.js SDK lets you track your customer event data from your Node.js applications and send it to your specified destinations.\n\nRefer to the [**documentation**](https://www.rudderstack.com/docs/stream-sources/rudderstack-sdk-integration-guides/rudderstack-node-sdk/) for more details.\n\n## Installing the SDK\n\nRun the following command to install the Node.js SDK via **npm**:\n\n```bash\n$ npm install @rudderstack/rudder-sdk-node\n```\n\n## Using the SDK\n\nTo create a global RudderStack client object and use it for the subsequent event calls, run the following snippet:\n\n```javascript\nconst Analytics = require('@rudderstack/rudder-sdk-node');\n\nconst client = new Analytics(WRITE_KEY, {\n dataPlaneUrl: DATA_PLANE_URL, // default: https://hosted.rudderlabs.com\n});\n```\n\n## SDK Initialization Options\n\nBelow parameters are optional and can be passed during SDK initialization.\n\n| Name | Type | Default value | Description |\n| :--------------------- | :------- | :------------------------------ | :------------------------------------------------------------------------------------------------ |\n| `dataPlaneUrl` | String | `https://hosted.rudderlabs.com` | The data plane URL. |\n| `path` | String | `/v1/batch` | Path to batch endpoint. |\n| `flushAt` | Number | 20 | The number of events to be flushed when reached this limit. |\n| `flushInterval` | Number | 10000 | The maximum timespan (in milliseconds) after which the events from the in-memory queue is flushed |\n| `maxQueueSize` | Number | 460800(500kb) | Maximum payload size of a batch request |\n| `maxInternalQueueSize` | Number | 20000 | The maximum length of the in-memory queue |\n| `logLevel` | String | 'info' | Log level. `Ex: 'debug', 'error'` |\n| `axiosConfig` | Object | N/A | Axios config |\n| `axiosInstance` | Object | N/A | Axios instance |\n| `axiosRetryConfig` | Object | N/A | Axios retry configuration |\n| `retryCount` | Number | 3 | Number of times requests will be retried by axios if failed |\n| `errorHandler` | Function | N/A | A function that will be called if request to server failed |\n| `gzip` | Boolean | true | Whether to compress request with gzip or not |\n\n## Supported calls\n\nRefer to the [**SDK documentation**](https://www.rudderstack.com/docs/stream-sources/rudderstack-sdk-integration-guides/rudderstack-node-sdk/) for more information on the supported calls.\n\n## Initializing the SDK for data persistence\n\n> **This is a beta feature. Contact us on our [Community Slack](https://rudderstack.com/join-rudderstack-slack-community) in case you face any issues.**\n\nRudderStack has a data persistence feature to persist the events in Redis, leading to better event delivery guarantees. Also, the SDK can retry event delivery multiple times as the queue is maintained in a different process space(Redis).\n\n| To use this feature, you will need to host a Redis server and use it as the intermediary data storage queue. |\n| :----------------------------------------------------------------------------------------------------------- |\n\nA sample SDK initialization is shown below:\n\n```\nconst client = new Analytics(\n \"write_key\",\n {\n dataPlaneUrl: DATA_PLANE_URL // default: https://hosted.rudderlabs.com with default path set to /v1/batch\n flushAt: