# sbis3-elastic-logger

> nmp module that sends data to Elastic service

Latest version **1.0.2** (published 2015-05-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install sbis3-elastic-logger
pnpm add sbis3-elastic-logger
yarn add sbis3-elastic-logger
bun add sbis3-elastic-logger
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2015-05-07 |
| First published | 2015-04-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Artem Oborevich |
| Maintainers | farewell7117 |
| Keywords | sbis3, elastic, logger |

## Links

- npm: https://www.npmjs.com/package/sbis3-elastic-logger
- Repository: git@git.sbis.ru:root/sbis3-elastic-logger
- npm.io page: https://npm.io/package/sbis3-elastic-logger

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.0.2 (latest) — 2015-05-07
- 1.0.1 — 2015-04-27
- 1.0.0 — 2015-04-27

## README

npm module "sbis3-elastic-logger"

Имеет 2 public метода в качестве своего API:

• init(addresser, config)

        инициализирует "sbis3-elastic-logger"

        объект "addresser" - (отправитель) адрес сервера, который шлет данный в Elastic. Имеет следующие поля:

        ► host

        ► port

        объект "config" - (получатель) адреса серверов Elastic. Имеет следующие поля:
        
        ► host (можно указать несколько хостов через запятую)

        ► port

• log(record)

        делает запись в журнал Elastic

Пример:

    // подключаем модуль
    var elasticLogger = require('sbis3-elastic-logger');

    // собираем данные о нашем сервере
    var addresser = {
      host: host,
      port: port
    };

    // инициализируем модуль
    elasticLogger.init(addresser, configs.elasticLogger);

    elasticLogger.on('error', function(e) {
        // серьезная ошибка в работе модуля
    });

    elasticLogger.on('formatException', function(e) {
        // неправильный формат объекта "record"
        // e.invalidField - имя невалидного поля
    });

    // создаем объект в формате Elastic
    var record = {
        timestamp: Date.now() / 1000,
        _uuid: headers['X-Uniq-ID'],
        short_message: 'BL call',
        level: 6,
        _depth: headers['X-Depth'],
        _method: 'ПроверкаПрав.AccessAreasList'
    };

    // делаем запись
    elasticLogger.log(record);

Объект "record" - это специальный объект, содержащий поля Elastic, оговоренные документацией.

Следующие поля будут добавлены автоматически модулем при разборе и проверке "record":

• host
        будет взят из объекта "addresser", полученного при инициализации "sbis3-elastic-logger"

• _memory

• _src_pid

---
_Source: https://npm.io/package/sbis3-elastic-logger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._