feat: add support for customizing the agent

Author: lamweili

README.md

@@ -14,6 +14,7 @@ npm install log4js @log4js-node/logstash-http
 * `logChannel` - `string` (optional) - also used to identify your application's logs [but in a more specific way]
 * `logType` - `string` (optional) - used for the `type` field in the logstash data
 * `timeout` - `integer` (optional, defaults to 5000ms) - the timeout for the HTTP request.
+* `agent` - `http.Agent | https.Agent` (optional) - used to configure the requests being sent out if needed.
 
 This appender will also pick up Logger context values from the events, and add them as `p_` values in the logFaces event. See the example below for more details.
 

lib/index.js

@@ -34,13 +34,18 @@ function format(logData) {
  *      "logChannel": "test",        // channel of the application
  *      "url": "http://lfs-server/_bulk",  // logstash receiver servlet URL
  *   }
+ * @param {import('../types').LogstashHTTPAppender} config
  */
 function logstashHTTPAppender(config) {
   const sender = axios.create({
     baseURL: config.url,
     timeout: config.timeout || 5000,
     headers: { 'Content-Type': 'application/x-ndjson' },
     withCredentials: true,
+    // The user should pass in the correct Agent type for their url
+    // since their url won't change after config this should be fine
+    httpAgent: config.agent,
+    httpsAgent: config.agent,
   });
 
   return function log(event) {

test/tap/index-test.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const { Agent } = require('http');
 const test = require('tap').test;
 const sandbox = require('@log4js-node/sandboxed-module');
 const appender = require('../../lib');
@@ -64,18 +65,25 @@ test('logstashappender', (batch) => {
   });
 
   batch.test('when using HTTP receivers', (t) => {
+    const agent = new Agent();
     const setup = setupLogging('myCategory', {
       application: 'logstash-sample',
       logType: 'application',
       logChannel: 'sample',
       url: 'http://localhost/receivers/rx1'
+      agent,
     });
 
     t.test('axios should be configured', (assert) => {
       assert.equal(setup.fakeAxios.config.baseURL, 'http://localhost/receivers/rx1');
       assert.equal(setup.fakeAxios.config.timeout, 5000);
       assert.equal(setup.fakeAxios.config.withCredentials, true);
       assert.same(setup.fakeAxios.config.headers, { 'Content-Type': 'application/x-ndjson' });
+      // For some reason with the sandboxed tests, the instanceof Agent doesn't exist.
+      assert.match(setup.fakeAxios.config, {
+        httpAgent: Object,
+        httpsAgent: Object,
+      });
       assert.end();
     });
 

types/index.d.ts

@@ -1,8 +1,15 @@
+import type { Agent as httpAgent } from 'http';
+import type { Agent as httpsAgent } from 'https';
+
 export interface LogstashHTTPAppender extends Appender {
   type: '@log4js-node/logstashHTTP';
   url: string;
   timeout ?: number; //defaults to 5000
   application ?: string;
   logChannel ?: string;
   logType ?: string;
+  /** An http.Agent or https.Agent to allow configuring behavior as needed.
+   * Make sure you use the correct type base on your url
+   */
+  agent?: httpAgent | httpsAgent;
 }