Skip to content

Commit 4d53b75

Browse files
akaila-splunkakaila-splunk
committed
Update version and docs
1 parent 26043a1 commit 4d53b75

File tree

5 files changed

+38
-40
lines changed

5 files changed

+38
-40
lines changed

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Splunk logging for JavaScript
22

3-
#### Version 0.10.1
3+
#### Version 0.11.0
44

55
This project provides a simple JavaScript interface for logging to HTTP Event Collector in Splunk Enterprise and Splunk Cloud.
66

77
## Requirements
88

9-
* Node.js v4 or later. Splunk logging for Javascript is tested with Node.js v4.2, v6.0 and v8.0.
10-
* Splunk Enterprise 6.3.0 or later, or Splunk Cloud. Splunk logging for Javascript is tested with Splunk Enterprise 7.0 and 7.2.
9+
* Node.js v4 or later. Splunk logging for Javascript is tested with Node.js v10.0 and v14.0.
10+
* Splunk Enterprise 6.3.0 or later, or Splunk Cloud. Splunk logging for Javascript is tested with Splunk Enterprise 8.0 and 8.2.0.
1111
* An HTTP Event Collector token from your Splunk Enterprise server.
1212

1313
## Installation

‎package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "splunk-logging",
3-
"version": "0.10.1",
3+
"version": "0.11.0",
44
"description": "Splunk HTTP Event Collector logging interface",
55
"homepage": "http://dev.splunk.com",
66
"main": "index.js",

‎splunklogger.js

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ function _defaultEventFormatter(message, severity) {
6666
* var logger = new SplunkLogger(config);
6767
*
6868
* @property {object} config - Configuration settings for this <code>SplunkLogger</code> instance.
69-
* @param {object} requestOptions - Options to pass to <code>{@link https://github.com/request/request#requestpost|request.post()}</code>.
70-
* See the {@link http://github.com/request/request|request documentation} for all available options.
69+
* @param {object} requestOptions - Options to pass to <code>{@link https://github.com/tomas/needle#needleposturl-data-options-callback|needle.post()}</code>.
70+
* See the {@link https://github.com/tomas/needle#request-options|needle documentation} for all available options.
7171
* @property {object[]} serializedContextQueue - Queue of serialized <code>context</code> objects to be sent to Splunk Enterprise or Splunk Cloud.
7272
* @property {function} eventFormatter - Formats events, returning an event as a string, <code>function(message, severity)</code>.
7373
* Can be overwritten, the default event formatter will display event and severity as properties in a JSON object.
@@ -76,7 +76,7 @@ function _defaultEventFormatter(message, severity) {
7676
*
7777
* @param {object} config - Configuration settings for a new [SplunkLogger]{@link SplunkLogger}.
7878
* @param {string} config.token - HTTP Event Collector token, required.
79-
* @param {string} [config.name=splunk-javascript-logging/0.10.1] - Name for this logger.
79+
* @param {string} [config.name=splunk-javascript-logging/0.11.0] - Name for this logger.
8080
* @param {string} [config.host=localhost] - Hostname or IP address of Splunk Enterprise or Splunk Cloud server.
8181
* @param {string} [config.maxRetries=0] - How many times to retry when HTTP POST to Splunk Enterprise or Splunk Cloud fails.
8282
* @param {string} [config.path=/services/collector/event/1.0] - URL path to send data to on the Splunk Enterprise or Splunk Cloud server.
@@ -135,7 +135,7 @@ SplunkLogger.prototype.levels = {
135135
};
136136

137137
var defaultConfig = {
138-
name: "splunk-javascript-logging/0.10.1",
138+
name: "splunk-javascript-logging/0.11.0",
139139
host: "localhost",
140140
path: "/services/collector/event/1.0",
141141
protocol: "https",
@@ -412,11 +412,9 @@ SplunkLogger.prototype._makeBody = function(context) {
412412
SplunkLogger.prototype._post = function(requestOptions, callback) {
413413
let body = requestOptions.body ;
414414
let url = requestOptions.url;
415-
let options = {
416-
rejectUnauthorized : requestOptions.strictSSL,
417-
json : requestOptions.json,
418-
headers: requestOptions.headers
419-
};
415+
let options = requestOptions;
416+
options["rejectUnauthorized"] = requestOptions.rejectUnauthorized ? requestOptions.rejectUnauthorized : requestOptions.strictSSL;
417+
console.log(options);
420418
needle.post(url,body,options, callback);
421419
};
422420

‎test/test_config.js

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ describe("SplunkLogger", function() {
134134
var logger = new SplunkLogger(config);
135135
assert.ok(logger);
136136
assert.strictEqual(config.token, logger.config.token);
137-
assert.strictEqual("splunk-javascript-logging/0.10.1", logger.config.name);
137+
assert.strictEqual("splunk-javascript-logging/0.11.0", logger.config.name);
138138
assert.strictEqual("localhost", logger.config.host);
139139
assert.strictEqual("/services/collector/event/1.0", logger.config.path);
140140
assert.strictEqual("https", logger.config.protocol);
@@ -153,7 +153,7 @@ describe("SplunkLogger", function() {
153153

154154
assert.ok(logger);
155155
assert.strictEqual(config.token, logger.config.token);
156-
assert.strictEqual("splunk-javascript-logging/0.10.1", logger.config.name);
156+
assert.strictEqual("splunk-javascript-logging/0.11.0", logger.config.name);
157157
assert.strictEqual("localhost", logger.config.host);
158158
assert.strictEqual("/services/collector/event/1.0", logger.config.path);
159159
assert.strictEqual("https", logger.config.protocol);
@@ -184,7 +184,7 @@ describe("SplunkLogger", function() {
184184

185185
assert.ok(logger);
186186
assert.strictEqual(config.token, logger.config.token);
187-
assert.strictEqual("splunk-javascript-logging/0.10.1", logger.config.name);
187+
assert.strictEqual("splunk-javascript-logging/0.11.0", logger.config.name);
188188
assert.strictEqual("localhost", logger.config.host);
189189
assert.strictEqual("/services/collector/event/1.0", logger.config.path);
190190
assert.strictEqual("https", logger.config.protocol);
@@ -291,7 +291,7 @@ describe("SplunkLogger", function() {
291291
assert.ok(logger._timerID);
292292

293293
assert.strictEqual(config.token, logger.config.token);
294-
assert.strictEqual("splunk-javascript-logging/0.10.1", logger.config.name);
294+
assert.strictEqual("splunk-javascript-logging/0.11.0", logger.config.name);
295295
assert.strictEqual("localhost", logger.config.host);
296296
assert.strictEqual("/services/collector/event/1.0", logger.config.path);
297297
assert.strictEqual("https", logger.config.protocol);
@@ -310,7 +310,7 @@ describe("SplunkLogger", function() {
310310
assert.ok(!logger._timerID);
311311

312312
assert.strictEqual(config.token, logger.config.token);
313-
assert.strictEqual("splunk-javascript-logging/0.10.1", logger.config.name);
313+
assert.strictEqual("splunk-javascript-logging/0.11.0", logger.config.name);
314314
assert.strictEqual("localhost", logger.config.host);
315315
assert.strictEqual("/services/collector/event/1.0", logger.config.path);
316316
assert.strictEqual("https", logger.config.protocol);
@@ -391,7 +391,7 @@ describe("SplunkLogger", function() {
391391
assert.ok(!logger._timerID);
392392

393393
assert.strictEqual(config.token, logger.config.token);
394-
assert.strictEqual("splunk-javascript-logging/0.10.1", logger.config.name);
394+
assert.strictEqual("splunk-javascript-logging/0.11.0", logger.config.name);
395395
assert.strictEqual("localhost", logger.config.host);
396396
assert.strictEqual("/services/collector/event/1.0", logger.config.path);
397397
assert.strictEqual("http", logger.config.protocol);
@@ -408,7 +408,7 @@ describe("SplunkLogger", function() {
408408

409409
assert.ok(logger);
410410
assert.strictEqual(config.token, logger.config.token);
411-
assert.strictEqual("splunk-javascript-logging/0.10.1", logger.config.name);
411+
assert.strictEqual("splunk-javascript-logging/0.11.0", logger.config.name);
412412
assert.strictEqual("localhost", logger.config.host);
413413
assert.strictEqual(config.path, logger.config.path);
414414
assert.strictEqual("https", logger.config.protocol);
@@ -425,7 +425,7 @@ describe("SplunkLogger", function() {
425425

426426
assert.ok(logger);
427427
assert.strictEqual(config.token, logger.config.token);
428-
assert.strictEqual("splunk-javascript-logging/0.10.1", logger.config.name);
428+
assert.strictEqual("splunk-javascript-logging/0.11.0", logger.config.name);
429429
assert.strictEqual("localhost", logger.config.host);
430430
assert.strictEqual("/services/collector/event/1.0", logger.config.path);
431431
assert.strictEqual("https", logger.config.protocol);
@@ -442,7 +442,7 @@ describe("SplunkLogger", function() {
442442

443443
assert.ok(logger);
444444
assert.strictEqual(config.token, logger.config.token);
445-
assert.strictEqual("splunk-javascript-logging/0.10.1", logger.config.name);
445+
assert.strictEqual("splunk-javascript-logging/0.11.0", logger.config.name);
446446
assert.strictEqual("localhost", logger.config.host);
447447
assert.strictEqual("/services/collector/event/1.0", logger.config.path);
448448
assert.strictEqual("https", logger.config.protocol);
@@ -460,7 +460,7 @@ describe("SplunkLogger", function() {
460460

461461
assert.ok(logger);
462462
assert.strictEqual(config.token, logger.config.token);
463-
assert.strictEqual("splunk-javascript-logging/0.10.1", logger.config.name);
463+
assert.strictEqual("splunk-javascript-logging/0.11.0", logger.config.name);
464464
assert.strictEqual("splunk.local", logger.config.host);
465465
assert.strictEqual("/services/collector/different/1.0", logger.config.path);
466466
assert.strictEqual("http", logger.config.protocol);
@@ -477,7 +477,7 @@ describe("SplunkLogger", function() {
477477

478478
assert.ok(logger);
479479
assert.strictEqual(config.token, logger.config.token);
480-
assert.strictEqual("splunk-javascript-logging/0.10.1", logger.config.name);
480+
assert.strictEqual("splunk-javascript-logging/0.11.0", logger.config.name);
481481
assert.strictEqual("localhost", logger.config.host);
482482
assert.strictEqual("/services/collector/event/1.0", logger.config.path);
483483
assert.strictEqual("http", logger.config.protocol);
@@ -494,7 +494,7 @@ describe("SplunkLogger", function() {
494494

495495
assert.ok(logger);
496496
assert.strictEqual(config.token, logger.config.token);
497-
assert.strictEqual("splunk-javascript-logging/0.10.1", logger.config.name);
497+
assert.strictEqual("splunk-javascript-logging/0.11.0", logger.config.name);
498498
assert.strictEqual("splunk.local", logger.config.host);
499499
assert.strictEqual("/services/collector/event/1.0", logger.config.path);
500500
assert.strictEqual("http", logger.config.protocol);
@@ -511,7 +511,7 @@ describe("SplunkLogger", function() {
511511

512512
assert.ok(logger);
513513
assert.strictEqual(config.token, logger.config.token);
514-
assert.strictEqual("splunk-javascript-logging/0.10.1", logger.config.name);
514+
assert.strictEqual("splunk-javascript-logging/0.11.0", logger.config.name);
515515
assert.strictEqual("splunk.local", logger.config.host);
516516
assert.strictEqual("/services/collector/event/1.0", logger.config.path);
517517
assert.strictEqual("http", logger.config.protocol);
@@ -528,7 +528,7 @@ describe("SplunkLogger", function() {
528528

529529
assert.ok(logger);
530530
assert.strictEqual(config.token, logger.config.token);
531-
assert.strictEqual("splunk-javascript-logging/0.10.1", logger.config.name);
531+
assert.strictEqual("splunk-javascript-logging/0.11.0", logger.config.name);
532532
assert.strictEqual("splunk.local", logger.config.host);
533533
assert.strictEqual("/services/collector/event/1.0", logger.config.path);
534534
assert.strictEqual("https", logger.config.protocol);
@@ -545,7 +545,7 @@ describe("SplunkLogger", function() {
545545

546546
assert.ok(logger);
547547
assert.strictEqual(config.token, logger.config.token);
548-
assert.strictEqual("splunk-javascript-logging/0.10.1", logger.config.name);
548+
assert.strictEqual("splunk-javascript-logging/0.11.0", logger.config.name);
549549
assert.strictEqual("localhost", logger.config.host);
550550
assert.strictEqual("/services/collector/event/1.0", logger.config.path);
551551
assert.strictEqual("https", logger.config.protocol);
@@ -679,7 +679,7 @@ describe("SplunkLogger", function() {
679679

680680
assert.ok(loggerConfig);
681681
assert.strictEqual(config.token, loggerConfig.token);
682-
assert.strictEqual("splunk-javascript-logging/0.10.1", loggerConfig.name);
682+
assert.strictEqual("splunk-javascript-logging/0.11.0", loggerConfig.name);
683683
assert.strictEqual("localhost", loggerConfig.host);
684684
assert.strictEqual("/services/collector/event/1.0", loggerConfig.path);
685685
assert.strictEqual("https", loggerConfig.protocol);
@@ -698,7 +698,7 @@ describe("SplunkLogger", function() {
698698

699699
assert.ok(loggerConfig);
700700
assert.strictEqual(config.token, loggerConfig.token);
701-
assert.strictEqual("splunk-javascript-logging/0.10.1", loggerConfig.name);
701+
assert.strictEqual("splunk-javascript-logging/0.11.0", loggerConfig.name);
702702
assert.strictEqual("localhost", loggerConfig.host);
703703
assert.strictEqual("/services/collector/event/1.0", loggerConfig.path);
704704
assert.strictEqual("https", loggerConfig.protocol);
@@ -717,7 +717,7 @@ describe("SplunkLogger", function() {
717717
var loggerConfig = SplunkLogger.prototype._initializeConfig(config);
718718

719719
assert.strictEqual(config.token, loggerConfig.token);
720-
assert.strictEqual("splunk-javascript-logging/0.10.1", loggerConfig.name);
720+
assert.strictEqual("splunk-javascript-logging/0.11.0", loggerConfig.name);
721721
assert.strictEqual("localhost", loggerConfig.host);
722722
assert.strictEqual("/services/collector/event/1.0", loggerConfig.path);
723723
assert.strictEqual("http", loggerConfig.protocol);
@@ -736,7 +736,7 @@ describe("SplunkLogger", function() {
736736

737737
assert.ok(loggerConfig);
738738
assert.strictEqual(config.token, loggerConfig.token);
739-
assert.strictEqual("splunk-javascript-logging/0.10.1", loggerConfig.name);
739+
assert.strictEqual("splunk-javascript-logging/0.11.0", loggerConfig.name);
740740
assert.strictEqual("localhost", loggerConfig.host);
741741
assert.strictEqual(config.path, loggerConfig.path);
742742
assert.strictEqual("https", loggerConfig.protocol);
@@ -755,7 +755,7 @@ describe("SplunkLogger", function() {
755755

756756
assert.ok(loggerConfig);
757757
assert.strictEqual(config.token, loggerConfig.token);
758-
assert.strictEqual("splunk-javascript-logging/0.10.1", loggerConfig.name);
758+
assert.strictEqual("splunk-javascript-logging/0.11.0", loggerConfig.name);
759759
assert.strictEqual("localhost", loggerConfig.host);
760760
assert.strictEqual("/services/collector/event/1.0", loggerConfig.path);
761761
assert.strictEqual("https", loggerConfig.protocol);
@@ -774,7 +774,7 @@ describe("SplunkLogger", function() {
774774

775775
assert.ok(loggerConfig);
776776
assert.strictEqual(config.token, loggerConfig.token);
777-
assert.strictEqual("splunk-javascript-logging/0.10.1", loggerConfig.name);
777+
assert.strictEqual("splunk-javascript-logging/0.11.0", loggerConfig.name);
778778
assert.strictEqual("splunk.local", loggerConfig.host);
779779
assert.strictEqual("/services/collector/different/1.0", loggerConfig.path);
780780
assert.strictEqual("http", loggerConfig.protocol);
@@ -793,7 +793,7 @@ describe("SplunkLogger", function() {
793793

794794
assert.ok(loggerConfig);
795795
assert.strictEqual(config.token, loggerConfig.token);
796-
assert.strictEqual("splunk-javascript-logging/0.10.1", loggerConfig.name);
796+
assert.strictEqual("splunk-javascript-logging/0.11.0", loggerConfig.name);
797797
assert.strictEqual("localhost", loggerConfig.host);
798798
assert.strictEqual("/services/collector/event/1.0", loggerConfig.path);
799799
assert.strictEqual("http", loggerConfig.protocol);
@@ -812,7 +812,7 @@ describe("SplunkLogger", function() {
812812

813813
assert.ok(loggerConfig);
814814
assert.strictEqual(config.token, loggerConfig.token);
815-
assert.strictEqual("splunk-javascript-logging/0.10.1", loggerConfig.name);
815+
assert.strictEqual("splunk-javascript-logging/0.11.0", loggerConfig.name);
816816
assert.strictEqual("splunk.local", loggerConfig.host);
817817
assert.strictEqual("/services/collector/event/1.0", loggerConfig.path);
818818
assert.strictEqual("https", loggerConfig.protocol);
@@ -833,7 +833,7 @@ describe("SplunkLogger", function() {
833833
assert.ok(loggerConfig);
834834
assert.ok(!loggerConfig.hasOwnProperty("something"));
835835
assert.strictEqual(config.token, loggerConfig.token);
836-
assert.strictEqual("splunk-javascript-logging/0.10.1", loggerConfig.name);
836+
assert.strictEqual("splunk-javascript-logging/0.11.0", loggerConfig.name);
837837
assert.strictEqual("splunk.local", loggerConfig.host);
838838
assert.strictEqual("/services/collector/event/1.0", loggerConfig.path);
839839
assert.strictEqual("https", loggerConfig.protocol);
@@ -959,7 +959,7 @@ describe("SplunkLogger", function() {
959959

960960
var expected = {
961961
token: config.token,
962-
name: "splunk-javascript-logging/0.10.1",
962+
name: "splunk-javascript-logging/0.11.0",
963963
host: "localhost",
964964
path: "/services/collector/event/1.0",
965965
protocol: "https",
@@ -993,7 +993,7 @@ describe("SplunkLogger", function() {
993993

994994
var expected = {
995995
token: config.token,
996-
name: "splunk-javascript-logging/0.10.1",
996+
name: "splunk-javascript-logging/0.11.0",
997997
host: "localhost",
998998
path: "/services/collector/event/1.0",
999999
protocol: "https",

0 commit comments

Comments
 (0)