Merge pull request #25 from JaniAnttonen/feat/size-optimization

Prepare for 6.0.0 release

Author: JaniAnttonen

.npmignore

@@ -1 +1,2 @@
 test
+examples

.travis.yml

@@ -1,7 +1,7 @@
 sudo: false
 language: node_js
 node_js:
-  - "10"
+  - "12"
 branches:
   only:
     - master

README.md

@@ -1,10 +1,10 @@
 # winston-loki
 
 [![npm version](https://badge.fury.io/js/winston-loki.svg)](https://badge.fury.io/js/winston-loki)
+[![install size](https://packagephobia.now.sh/badge?p=winston-loki)](https://packagephobia.now.sh/result?p=winston-loki)
 [![Build Status](https://travis-ci.com/JaniAnttonen/winston-loki.svg?branch=master)](https://travis-ci.com/JaniAnttonen/winston-loki)
 [![Coverage Status](https://coveralls.io/repos/github/JaniAnttonen/winston-loki/badge.svg?branch=master)](https://coveralls.io/github/JaniAnttonen/winston-loki?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/17a55cce14d581c308bc/maintainability)](https://codeclimate.com/github/JaniAnttonen/winston-loki/maintainability)
-[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
 
 A Grafana Loki transport for the nodejs logging library Winston.

examples/basicAuth.js

@@ -0,0 +1,30 @@
+const winston = require('winston')
+const LokiTransport = require('../index')
+const logger = winston.createLogger()
+
+logger.add(new winston.transports.Console({
+  format: winston.format.json(),
+  level: 'debug'
+}))
+
+logger.add(new LokiTransport({
+  host: 'http://127.0.0.1:3100',
+  json: true,
+  basicAuth: 'username:password',
+  labels: { job: 'winston-loki-example' }
+}))
+
+const wait = (duration) => new Promise(resolve => {
+  setTimeout(resolve, duration)
+})
+
+const run = async () => {
+  while (true) {
+    logger.debug('I am a debug log')
+    logger.info('This is a test, no need to panic')
+    logger.error('Testing for errors')
+    await wait(1000)
+  }
+}
+
+run()

examples/docker-compose.yaml

@@ -0,0 +1,28 @@
+version: "3"
+
+networks:
+  loki:
+
+services:
+  loki:
+    image: grafana/loki:latest
+    ports:
+      - "3100:3100"
+    command: -config.file=/etc/loki/local-config.yaml
+    networks:
+      - loki
+
+  promtail:
+    image: grafana/promtail:latest
+    volumes:
+      - /var/log:/var/log
+    command: -config.file=/etc/promtail/docker-config.yaml
+    networks:
+      - loki
+
+  grafana:
+    image: grafana/grafana:master
+    ports:
+      - "3000:3000"
+    networks:
+      - loki

examples/json.js

@@ -0,0 +1,29 @@
+const winston = require('winston')
+const LokiTransport = require('../index')
+const logger = winston.createLogger()
+
+logger.add(new winston.transports.Console({
+  format: winston.format.json(),
+  level: 'debug'
+}))
+
+logger.add(new LokiTransport({
+  host: 'http://127.0.0.1:3100',
+  json: true,
+  labels: { job: 'winston-loki-example' }
+}))
+
+const wait = (duration) => new Promise(resolve => {
+  setTimeout(resolve, duration)
+})
+
+const run = async () => {
+  while (true) {
+    logger.debug('I am a debug log')
+    logger.info('This is a test, no need to panic')
+    logger.error('Testing for errors')
+    await wait(1000)
+  }
+}
+
+run()

examples/proto.js

@@ -0,0 +1,28 @@
+const winston = require('winston')
+const LokiTransport = require('../index')
+const logger = winston.createLogger()
+
+logger.add(new winston.transports.Console({
+  format: winston.format.json(),
+  level: 'debug'
+}))
+
+logger.add(new LokiTransport({
+  host: 'http://127.0.0.1:3100',
+  labels: { job: 'winston-loki-example' }
+}))
+
+const wait = (duration) => new Promise(resolve => {
+  setTimeout(resolve, duration)
+})
+
+const run = async () => {
+  while (true) {
+    logger.debug('I am a debug log')
+    logger.info('This is a test, no need to panic')
+    logger.error('Testing for errors')
+    await wait(1000)
+  }
+}
+
+run()

index.js

@@ -20,6 +20,8 @@ class LokiTransport extends Transport {
     // Pass all the given options to batcher
     this.batcher = new Batcher({
       host: options.host,
+      basicAuth: options.basicAuth,
+      headers: options.headers || {},
       interval: options.interval,
       json: options.json,
       batching: options.batching !== false,
@@ -52,20 +54,12 @@ class LokiTransport extends Transport {
     const { label, labels, timestamp, level, message, ...rest } = info
 
     // build custom labels if provided
-    let lokiLabels
+    let lokiLabels = { level: level }
+
     if (this.labels) {
-      lokiLabels = `{level="${level}"`
-      for (let key in this.labels) {
-        lokiLabels += `,${key}="${this.labels[key]}"`
-      }
-      if (labels) {
-        for (let key in labels) {
-          lokiLabels += `,${key}="${labels[key]}"`
-        }
-      }
-      lokiLabels += '}'
+      lokiLabels = Object.assign(lokiLabels, this.labels)
     } else {
-      lokiLabels = `{job="${label}", level="${level}"}`
+      lokiLabels['job'] = label
     }
 
     // follow the format provided
@@ -78,7 +72,7 @@ class LokiTransport extends Transport {
       labels: lokiLabels,
       entries: [
         {
-          ts: timestamp || Date.now(),
+          ts: timestamp || Date.now().valueOf(),
           line
         }
       ]