Countly NodeJS SDK

This repository contains the Countly NodeJS SDK, which can be integrated into NodeJS running device or server. The Countly NodeJS SDK is intended to be used with Countly Lite, Countly Flex or Countly Enterprise.

What is Countly?

Countly is a product analytics solution and innovation enabler that helps teams track product performance and customer journey and behavior across mobile, web, and desktop applications. Ensuring privacy by design, Countly allows you to innovate and enhance your products to provide personalized and customized customer experiences, and meet key business and revenue goals.

Track, measure, and take action - all without leaving Countly.

• Questions or feature requests? Join the Countly Community on Discord
• Looking for the Countly Server? Countly Server repository
• Looking for other Countly SDKs? An overview of all Countly SDKs for mobile, web and desktop

Integrating Countly SDK in your projects

For a detailed description on how to use this SDK check out our documentation.

For information about how to add the SDK to your project, please check this section of the documentation.

You can reach minimal integration info for your project from this section of the documentation.

For an example integration of this SDK, you can have a look here.

This SDK supports the following features:

• Analytics
• User Profiles
• Crash Reports
• A/B Testing
• Performance Monitoring

Security

Security is very important to us. If you discover any issue regarding security, please disclose the information responsibly by sending an email to security@count.ly and not by creating a GitHub issue.

Badges

If you like Countly, why not use one of our badges and give a link back to us so others know about this wonderful platform?

<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/dark.svg" alt="Countly - Product Analytics" /></a>

<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/light.svg" alt="Countly - Product Analytics" /></a>

How can I help you with your efforts?

Glad you asked! For community support, feature requests, and engaging with the Countly Community, please join us at our Discord Server. We're excited to have you there!

Also, we are on Twitter and LinkedIn if you would like to keep up with Countly related updates.

24.10.2

• Added timezone support for server

24.10.1

• Added a new method set_id(newDeviceId) for managing device ID changes according to the device ID Type
• Added DeviceIdType enums to be used to evaluate the device ID type.
• Added reserved keys for user properties

24.10.0

• Default max segmentation value count changed from 30 to 100
• Mitigated an issue where SDK could create an unintended dump file
• Added a new init time config option (conf.storage_type) which can make user set the SDK storage option:
  • File Storage
  • Memory Only Storage
• Added a new init time config option (conf.custom_storage_method) which enables user to provide custom storage methods

22.06.0

• Fixed a bug where remote config requests were rejected
• Fixed a bug where empty storage object did cause some issues

22.02.0

• !! Major breaking change !! Device ID provided during the init will be ignored if a device ID was provided previously
• Added a new init time flag which erases the previously stored device ID. This allows to set new device ID during init
• Added a call to get the device ID type of the user
• Added a call to get the device ID of the user
• Now it appends the device ID type with each request

21.11.0

• !! Major breaking change !! Changing device ID without merging will now clear the current consent. Consent has to be given again after performing this action.
• ! Minor breaking change ! Multiple values now have a default limit adjustable at initialization:
  • Maximum size of all string keys is now 128 characters by default.
  • Maximum size of all values in key-value pairs is now 256 characters by default.
  • Maximum amount of segmentation in one event is mow 30 key-value pairs by default.
  • Maximum amount of breadcrumbs that can be recorded at once is now 100 by default.
  • Maximum stack trace lines per thread is now 30 by default.
  • Maximum stack trace line length is now 200 by default.
• ! Minor breaking change ! After initialization, the logging/debugging mode can only be changed with Countly.setLoggingEnabled instead of Countly.debug now.
• When recording internal events with 'add_event', the respective feature consent will now be checked instead of just the 'events' consent.
• Fixed a bug where the SDK throws a Bulk user storage exception due to a missing folder
• Increased the default max event batch size to 100.
• Logs are now color coded and indicate log levels.

20.11

• Add javascript flag to reported errors
• Added explicit remote-config consent
• Async writes with queue and lock
• Fixed bulk example
• Stricter Eslint rules

20.04

• Add basic performance trace reporting option
• Add method to report feedback directly without dialog (for custom UI)
• Allow providing custom segments for view tracking

19.08

• Allow overriding http options for each separate request to use proxy and other options

19.02

• Add remote config support
• Handle http request fail correctly
• Report unhandled rejections too

18.08

• Add crash log breadcrumb limit
• Allow unsetting custom property
• Empty event queue (into request queue) on device_id change (if user is not merged on server)
• Fixed consent check in Bulk Users
• Fixed consent check in Countly
• Fixed log for timed events
• Fixed logging in Bulk Users

18.04

• Add GDPR compliant consent management
• Allow providing path to storing internal data as initial configuration option
• Generate docs for CountlyBulk api
• Git ignore internally stored files

17.09

• Added bulk request processor for server to server data flow
• Synchronized persistent storage in some cases

17.05

• Do not override provided metrics
• Improved comments and docs

16.12.1

• Some minor changes

16.12

• Added new configuration options, as session_update and max_events, force_post
• Automatic switch to POST if amount of data can't be handled by GET
• Correctly handle ending session on device_id change without merge
• Additional checks preventing possible crashes
• Use unique millisecond timestamp for reporting

16.06

• First official release compatible with Countly Server 16.06 functionalities