ClientConfigurationProperties | acklo Node.js SDK docs

Properties for configuring an acklo client instance.

example

{
  applicationKey: "[YOUR APPLICATION KEY]",
  environmentName: "development"
}

Hierarchy

ClientConfigurationProperties

Index

Properties

applicationKey

applicationKey: string

Your application's unique key. This is used to identify this application by the SDK.

This value can also be configured by setting the ACKLO_APPLICATION_KEY environment variable.

autoTags

autoTags: boolean

Set to true to automatically add some useful tags to your instance (e.g. the hostname of the server your instance is running on, as returned by os.hostname()).

default: true

environmentName

environmentName: string

The name of your application's environment. This is used to identify which environment your application is running in. Common environments are local (for local development), staging (for a staging environment), and production (for a production environment).

This value can also be configured by setting the ACKLO_ENVIRONMENT_NAME environment variable.

logLevel

logLevel: LogLevel

The log level that the acklo SDK should use.

Possible values are off, error, info, debug.

A guideline for what kind of messages should be expected at each level is:

off - no logs.
error - only errors get logged (e.g. failure to establish a connection to the acklo service).
info - informational messages get logged (e.g. successfully connected to the acklo service).
debug - verbose debugging messages get logged (e.g. the SDK's has sent a heartbeat to the acklo service).

This value can also be configured by setting the ACKLO_LOG_LEVEL environment variable.

default: info