nodejs-coralogix-sdk's Introduction

Coralogix Node.js SDK

Use coralogix-logger to easily send your logs to Coralogix's log analytics platform.

Table of Content

Prerequisites
Installation
Usage
- JavaScript
- TypeScript

Prerequisites

Before beginning you must have installed:

Node.js
npm

Installation

npm install --save coralogix-logger

Usage

JavaScript

var Coralogix = require("coralogix-logger");

// global confing for application name, private key, subsystem name
const config = new Coralogix.LoggerConfig({
    applicationName: "node tester",
    privateKey: "YOUR_PRIVATE_KEY",
    subsystemName: "node tester sub",
});

Coralogix.CoralogixLogger.config(config);

// create a new logger with category
const logger = new Coralogix.CoralogixLogger("My Category");

// create a log
const log = new Coralogix.Log({
    severity: Coralogix.Severity.info,
    className: "className",
    methodName: "methodName",
    text: "log data",
})
// semd log to coralogix
logger.addLog(log);

TypeScript

For using TypeScript sources you should clone this repository, because it's not included in npm distribution.

import {Log, Severity, CoralogixLogger, LoggerConfig} from "coralogix-logger";

// global confing for application name, private key, subsystem name 
const config = new LoggerConfig({
    applicationName: "node tester",
    privateKey: "YOUR_PRIVATE_KEY",
    subsystemName: "node tester sub",
});

CoralogixLogger.configure(config);

// create a new logger with category
logger: CoralogixLogger = new CoralogixLogger("My Category")

// create a log
const log = new Log({
    severity: Severity.info,           
    className: "className",
    methodName: "methodName",
    text: "log data",
})
// semd log to coralogix
logger.addLog(log);

Recommend Projects