loglit

loglit JS SDK

The easy, one-step way to capture JavaScript console logs.

Works in node.js and web browsers.

Note: loglit works by patching calls to the console api.

Get your loglit api key here.

Installation

CDN

A hosted version of loglit can be installed via a CDN:

<script src="https://www.loglit.com/loglit.js" data-key="YOUR_API_KEY"></script>

Package manager

# Node.js/Browser module usage
$ npm install loglit

# CLI usage
$ npm install -g loglit

JS SDK Usage

Node.js module usage

Calling startLogger will patch calls to console.\* apis and send the logs to the server where they can be viewed.

Examples

To get started call startLogger with your integration id which can be obtained from http://loglit.com.

Simple logs

import { startLogger } from "loglit";

// Get an integration id from: https://loglit.com
startLogger("YOUR-INTEGRATION-ID");

// Will be sent to https://loglit.com/[YOUR-INTEGRATION-ID]
console.info("Info message");
console.log("Hello, world!");

Specify log levels

You can change which log levels are tracked.

import { startLogger } from "loglit";

// Get an integration id from: https://loglit.com
startLogger("YOUR-INTEGRATION-ID", {
  levels: ["error", "warning"],
});

// Will be sent to https://loglit.com/[YOUR-INTEGRATION-ID]
console.error("something bad happened");
console.warn("watch out!");

// Will not be sent
console.info("info message");
console.log("thanks for reading this");
console.debug("hello, world!");

Prevent logging to console

Sometimes you will not want your logs to be sent to the browser console or STDOUT such as in a production environment.

import { startLogger } from "loglit";

// Get an integration id from: https://loglit.com
startLogger("YOUR-INTEGRATION-ID", {
  logToConsole: process.env.NODE_ENV !== "production",
});

// Will be sent to https://loglit.com/[YOUR-INTEGRATION-ID]
// but not logged to the console.
console.error("something bad happened");

Stopping

You can stop the logger which will restore the original console.* functions to their original values and stop tracking log messages.

import { startLogger, stopLogger } from "loglit";

// Get an integration id from: https://loglit.com
startLogger("YOUR-INTEGRATION-ID");

// Will be sent to loglit.com
console.info("Info message");

stopLogger();

// Will not be sent to loglit
console.log("I will not be sent");

Log levels

• debug
• info
• default
• warning
• error

Supported methods

• console.debug
• console.info
• console.log
• console.warn
• console.error

CLI Usage

The CLI library will read from STDIN or from arguments and log the result.

Pipeline usage

echo "test" | loglit

Arguments usage

loglit these are some test logs

Notes

• All arguments passed to console apis will have .toString() called on them.
• object types will be attempted to be json encoded and stored as entities.

Development

Make changes in src

Releasing a new version

npm run test
npm run build
npm publish