Merge pull request #101 from JaniAnttonen/development

Merge new patches to master

.github/workflows/npm-publish.yml

@@ -0,0 +1,31 @@
+name: Publish to NPM
+on:
+  release:
+    types: [published]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org
+      - name: Check node_modules cache
+        uses: actions/cache@v2
+        id: yarn-cache
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
+      - name: Install dependencies
+        if: steps.yarn-cache.outputs.cache-hit != 'true'
+        run: yarn install --frozen-lockfile
+      - name: Test
+        run: yarn test --ci --coverage
+      - name: Version
+        run: yarn version --new-version "${GITHUB_REF:11}" --no-git-tag-version
+      - name: Publish
+        run: yarn publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -25,11 +25,12 @@ LokiTransport() takes a Javascript object as an input. These are the options tha
 | `batching`         | If batching is not used, the logs are sent as they come   | true                   | true          |
 | `clearOnError`     | Discard any logs that result in an error during transport | true                   | false         |
 | `replaceTimestamp` | Replace any log timestamps with Date.now()                | true                   | false         |
-| `labels`           | custom labels, key-value pairs                            | { module: 'http' }     | null          |
-| `format`           | winston format (https://github.com/winstonjs/winston#formats) | simple()           | null          |
+| `labels`           | custom labels, key-value pairs                            | { module: 'http' }     | undefined     |
+| `format`           | winston format (https://github.com/winstonjs/winston#formats) | simple()           | undefined     |
 | `gracefulShutdown` | Enable/disable graceful shutdown (wait for any unsent batches) | false             | true          |
-| `timeout`          | timeout for requests to grafana loki in ms                | 30000                  | null          | 
-| `basicAuth`        | basic authentication credentials to access Loki over HTTP | username:password      | null          | 
+| `timeout`          | timeout for requests to grafana loki in ms                | 30000                  | undefined     | 
+| `basicAuth`        | basic authentication credentials to access Loki over HTTP | username:password      | undefined     | 
+| `onConnectionError`| Loki error connection handler                        | (err) => console.error(err) | undefined     | 
 
 ### Example
 With default formatting:

index.d.ts

@@ -9,10 +9,10 @@ declare interface LokiTransportOptions extends TransportStream.TransportStreamOp
     batching?: boolean;
     labels?: object;
     clearOnError?: boolean,
-    replaceOnError?: boolean,
     replaceTimestamp?: boolean,
     gracefulShutdown?: boolean,
     timeout?: number,
+    onConnectionError?(error: unknown): void
 }
 
 declare class LokiTransport extends TransportStream {

index.js

@@ -26,7 +26,7 @@ class LokiTransport extends Transport {
       json: options.json,
       batching: options.batching !== false,
       clearOnError: options.clearOnError,
-      replaceOnError: options.replaceOnError,
+      onConnectionError: options.onConnectionError,
       replaceTimestamp: options.replaceTimestamp,
       gracefulShutdown: options.gracefulShutdown !== false,
       timeout: options.timeout

src/batcher.js

@@ -201,6 +201,9 @@ class Batcher {
           .catch(err => {
             // Clear the batch on error if enabled
             this.options.clearOnError && this.clearBatch()
+
+            this.options.onConnectionError !== undefined && this.options.onConnectionError(err)
+
             reject(err)
           })
       }