https://github.com/coralogix/nodejs-coralogix-sdk

Coralogix NodeJS SDK
https://github.com/coralogix/nodejs-coralogix-sdk

coralogix javascript logger logging nodejs sdk

Last synced: 9 months ago
JSON representation

Coralogix NodeJS SDK

• Host: GitHub
• URL: https://github.com/coralogix/nodejs-coralogix-sdk
• Owner: coralogix
• License: apache-2.0
• Created: 2018-07-07T11:38:44.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-07-23T13:15:22.000Z (almost 2 years ago)
• Last Synced: 2025-08-04T07:36:33.041Z (11 months ago)
• Topics: coralogix, javascript, logger, logging, nodejs, sdk
• Language: TypeScript
• Homepage: https://coralogix.com/integrations/coralogix-nodejs-integration/
• Size: 524 KB
• Stars: 6
• Watchers: 44
• Forks: 11
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

          
# Coralogix Node.js SDK

[![npm](https://img.shields.io/npm/v/coralogix-logger.svg)](https://www.npmjs.com/package/coralogix-logger)

[![license](https://img.shields.io/github/license/coralogix/nodejs-coralogix-sdk.svg)](https://raw.githubusercontent.com/coralogix/nodejs-coralogix-sdk/master/LICENSE)

[![node](https://img.shields.io/node/v/coralogix-logger.svg)](https://www.npmjs.com/package/coralogix-logger)

[![npm](https://img.shields.io/npm/dt/coralogix-logger.svg)](https://www.npmjs.com/package/coralogix-logger)

[![Build Status](https://travis-ci.org/coralogix/nodejs-coralogix-sdk.svg?branch=master)](https://travis-ci.org/coralogix/nodejs-coralogix-sdk)

[![codecov](https://codecov.io/gh/coralogix/nodejs-coralogix-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/coralogix/nodejs-coralogix-sdk)

[![Maintainability](https://api.codeclimate.com/v1/badges/474f12c23edee33936b9/maintainability)](https://codeclimate.com/github/coralogix/python-coralogix-sdk/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/474f12c23edee33936b9/test_coverage)](https://codeclimate.com/github/coralogix/python-coralogix-sdk/test_coverage)

[![GitHub issues](https://img.shields.io/github/issues/coralogix/nodejs-coralogix-sdk.svg)](https://github.com/coralogix/nodejs-coralogix-sdk/issues)

[![GitHub pull requests](https://img.shields.io/github/issues-pr/coralogix/nodejs-coralogix-sdk.svg)](https://github.com/coralogix/nodejs-coralogix-sdk/pulls)

[![GitHub contributors](https://img.shields.io/github/contributors/coralogix/nodejs-coralogix-sdk.svg)](https://github.com/coralogix/nodejs-coralogix-sdk/graphs/contributors)

-----

Use *coralogix-logger* to easily send your logs to [Coralogix's](http://www.coralogix.com) log analytics platform.

## Table of Content

* [Prerequisites](#prerequisites)

* [Installation](#installation)

* [Usage](#installation)

    * [JavaScript](#javascript)

    * [TypeScript](#typescript)

## Prerequisites

Before beginning you must have installed:

* Node.js

* npm

## Installation

```sh

npm install --save coralogix-logger

```

## Usage

### JavaScript

```js

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.configure(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",

})

// send log to coralogix

logger.addLog(log);

```

### TypeScript

For using *TypeScript* sources you should clone this repository, because

it's not included in *npm* distribution.

```typescript

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",

})

// send log to coralogix

logger.addLog(log);

```