@logdash/js-sdk

logdash - JS SDK

Logdash is a zero-config observability platform. This package serves an javascript interface to use it.

Pre-requisites

Setup your free project in less than 2 minutes at logdash.io

Installation

npm install @logdash/js-sdk

Logging

import { createLogDash } from '@logdash/js-sdk';

const { logger } = createLogDash({
	// optional, but recommended to see your logs in the dashboard
	apiKey: '<your-api-key>',
});

logger.info('Application started successfully');
logger.error('An unexpected error occurred');
logger.warn('Low disk space warning');

Metrics

import { createLogDash } from '@logdash/js-sdk';

const { metrics } = createLogDash({
	// optional, but recommended as metrics are only hosted remotely
	apiKey: '<your-api-key>',
});

// to set absolute value
metrics.set('users', 0);

// to modify existing metric
metrics.mutate('users', 1);

View

To see the logs or metrics, go to your project dashboard

Configuration

Parameter	Required	Default	Description
apiKey	no	-	Api key used to authorize against logdash servers. If you don't provide one, logs will be logged into local console only
host	no	-	Custom API host, useful with self-hosted instances
verbose	no	-	Useful for debugging purposes

License

This project is licensed under the MIT License.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

Support

If you encounter any issues, please open an issue on GitHub or let us know at [e-mail].