@skbkontur/winston-kontur-logstashdeprecated

Winston logger transport for kontur elk

Usage no npm install needed!

<script type="module">
  import skbkonturWinstonKonturLogstash from 'https://cdn.skypack.dev/@skbkontur/winston-kontur-logstash';
</script>

README

Транспорт для winston в logstash контура

Пример использования

const winston = require('winston')
const KonturLogstash = require('winston-kontur-logstash')

let logger = null

function createLogger() {
  return new winston.Logger({
    transports: [
      new KonturLogstash({
        type: 'Expert.Node',
        serverName: 'http://elk-test:8080',
        path: '/logs/portal-expert-{date}',
        apiKey: 'ELK <apiKey, например portal-xxxxxxxxxxxx>'
      }),
      new winston.transports.Console({ colorize: true })
    ]
  })
}

function getLogger() {
  return logger || (logger = createLogger())
}

module.exports = { getLogger }

Настройки

type {string}

Поле которое будет записано в Identity в сообщение. По умолчанию 'Node.Winston.Kontur.Logstash'.

serverName {string}

Host инстанса ELK. По умолчанию 'elk-test'

path {string|required}

Путь индекса elk. В строку можно добавить токен {date} для индексирования по дням(он будет заменен на дату в формате YYYY.MM.DD).

apiKey {string|required}

Ключ Api к ELK. Пример: ELK <apiKey, например portal-xxxxxxxxxxxx>.

Режим отладки

У модуля существует режим отладки. Для этого вам необходимо в переменные окружения добавить значение DEBUG=winston-kontur-logstash*.

Пример того как вы можете запустить приложение с дебагом модуля @skbkontur/winston-kontur-logstash на windows:

set DEBUG=winston-kontur-logstash* && nodemon --inspect src