add option to set/unset user-agent header (#96)

* add option to set/unset user-agent header

* add unit test and fix indentation

* update test for user-agent

* update indentation

* update description of the field

* fix typo

* refactor assign headers

* update version add github action npm-publish

* update version in package-lock.json

* upgrade moment to 2.29.2

Author: resdenia

.github/workflows/npm-publish.yml

@@ -0,0 +1,16 @@
+on:
+  release:
+    types: [published]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 17
+      - run: npm install
+      - run: npm test
+      - uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,3 +1,4 @@
 .idea
 .history
+.prettierignore
 node_modules

README.md

@@ -47,6 +47,7 @@ logger.log(obj);
 * **addTimestampWithNanoSecs** - Add a timestamp with nano seconds granularity. This is needed when many logs are sent in the same millisecond, so you can properly order the logs in kibana. The added timestamp field will be `@timestamp_nano` Default: `false`
 * **compress** - If true the the logs are compressed in gzip format. Default: `false`
 * **internalLogger** - set internal logger that supports the function log. Default: console.
+* **setUserAgent** - Set `false` to send logs without user-agent field in request header.  Default:`true`.
 * **extraFields** - Adds your own custom fields to each log. Add in JSON Format, for example: `extraFields : { field_1: "val_1", field_2: "val_2" , ... }`.
 
 
@@ -59,6 +60,12 @@ A few notes are worth mentioning regarding the use of the UDP protocol:
 
 
 ## Update log
+**2.0.4**
+- Add parameter to manage User-agent
+
+**2.0.3**
+- Add verbose logging to use in Azure serverless function
+
 **2.0.2**
 - Updated required fields for typescript
 

lib/logzio-nodejs.d.ts

@@ -1,28 +1,29 @@
 interface ILoggerOptions {
-    token: string;
-    host?: string;
-    type?: string;
-    sendIntervalMs?: number;
-    bufferSize?: number;
-    debug?: boolean;
-    numberOfRetries?: number;
-    supressErrors?: boolean;
-    addTimestampWithNanoSecs?: boolean;
-    compress?: boolean;
-    internalLogger?: { log(message: string, ...args: any[]): any } & Record<string, any>;
-    protocol?: string;
-    port?: string;
-    timeout?: number;
-    sleepUntilNextRetry?: number;
-    callback?: (err: Error, bulk: object) => void;
-    extraFields?: {};
+	token: string;
+	host?: string;
+	type?: string;
+	sendIntervalMs?: number;
+	bufferSize?: number;
+	debug?: boolean;
+	numberOfRetries?: number;
+	supressErrors?: boolean;
+	addTimestampWithNanoSecs?: boolean;
+	compress?: boolean;
+	internalLogger?: { log(message: string, ...args: any[]): any } & Record<string, any>;
+	protocol?: string;
+	setUserAgent?: boolean;
+	port?: string;
+	timeout?: number;
+	sleepUntilNextRetry?: number;
+	callback?: (err: Error, bulk: object) => void;
+	extraFields?: {};
 }
 
 interface ILogzioLogger extends ILoggerOptions {
-    jsonToString(json: string): string;
-    log(msg: any, obj?: object): void;
-    close(): void;
-    sendAndClose(callback?: (error: Error, bulk: object) => void): void;
+	jsonToString(json: string): string;
+	log(msg: any, obj?: object): void;
+	close(): void;
+	sendAndClose(callback?: (error: Error, bulk: object) => void): void;
 }
 
 export function createLogger(options: ILoggerOptions): ILogzioLogger;

lib/logzio-nodejs.js

@@ -53,6 +53,7 @@ class LogzioLogger {
         timeout,
         sleepUntilNextRetry = 2 * 1000,
         callback = this._defaultCallback,
+        setUserAgent = true,
         extraFields = {},
     }) {
         if (!token) {
@@ -71,7 +72,7 @@ class LogzioLogger {
         this.compress = compress;
         this.internalLogger = internalLogger;
         this.sleepUntilNextRetry = sleepUntilNextRetry;
-
+        this.setUserAgent = setUserAgent;
         this.timer = null;
         this.closed = false;
 
@@ -258,8 +259,8 @@ class LogzioLogger {
             headers: {
                 host: this.host,
                 accept: '*/*',
-                'user-agent': USER_AGENT,
                 'content-type': 'text/plain',
+                ...(this.setUserAgent ? { 'user-agent': USER_AGENT } : {}),
             },
         };
 

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "logzio-nodejs",
   "description": "A nodejs implementation for sending logs to Logz.IO cloud service Copy of logzio-nodejs",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "author": "Gilly Barr <gilly@logz.io>",
   "contributors": [
     {
@@ -23,7 +23,11 @@
     {
       "name": "Roni Shaham",
       "email": "ronish31@gmail.com"
-    }
+    },
+	{
+		"name": "Anton Kolomiiets",
+		"email": "resdenia@gmail.com"
+	}
   ],
   "repository": {
     "type": "git",
@@ -39,7 +43,7 @@
   "dependencies": {
     "json-stringify-safe": "5.0.1",
     "lodash.assign": "4.2.0",
-    "moment": "^2.24.0",
+    "moment": "2.29.2",
     "request": "^2.88.0",
     "request-promise": "^4.2.4"
   },

package.json

@@ -59,6 +59,25 @@ describe('logger', () => {
             logger.close();
         });
 
+        it('sends log without user-agent header', (done) => {
+            const logger = createLogger({
+                bufferSize: 1,
+                callback: onDone,
+                setUserAgent:false
+            });
+            sinon.spy(logger, '_tryToSend');
+
+            const logMsg = 'hello there from test';
+            logger.log(logMsg);
+
+            function onDone() {
+                assert.equal(logger._tryToSend.getCall(0).args[0].headers['user-agent'], undefined);
+                logger._tryToSend.restore();
+                logger.close();
+                done();
+            }
+        });
+
         it('should send a log with an object as additional param', (done) => {
             const logger = createLogger({
                 bufferSize: 1,