This project provides a simple JavaScript interface for logging to HTTP Event Collector in Splunk Enterprise and Splunk Cloud.
- Node.js v4 or later.
- Splunk Enterprise 6.3.0 or later, or Splunk Cloud.
- An HTTP Event Collector token from your Splunk Enterprise server.
First, update npm to the latest version by running:
sudo npm install npm -g
Then run:
npm install --save splunk-logging
See the examples folder for usage examples:
all_batching.js: Shows how to configure a logger with the 3 batching settings:batchInterval,maxBatchCount, &maxBatchSize.basic.js: Shows how to configure a logger and send a log message to Splunk.custom_format.js: Shows how to configure a logger to log messages to Splunk using a custom format.manual_batching.js: Shows how to queue log messages, and send them in batches by manually callingflush().retry.js: Shows how to configure retries on errors.
Note: SSL certificate validation is disabled by default.
To enable it, set requestOptions.strictSSL = true on your SplunkLogger instance:
varSplunkLogger=require("splunk-logging").Logger;varconfig={token: "your-token-here",url: "https://splunk.local:8088"};varLogger=newSplunkLogger(config);// Enable SSL certificate validationLogger.requestOptions.strictSSL=true;varSplunkLogger=require("splunk-logging").Logger;varconfig={token: "your-token-here",url: "https://splunk.local:8088"};varLogger=newSplunkLogger(config);varpayload={// Message can be anything; doesn't have to be an objectmessage: {temperature: "70F",chickenCount: 500}};console.log("Sending payload",payload);Logger.send(payload,function(err,resp,body){// If successful, body will be { text: 'Success', code: 0 }console.log("Response from Splunk",body);});Stay connected with other developers building on Splunk software.
| devinfo@splunk.com | |
| Issues | https://github.com/splunk/splunk-javascript-logging/issues/ |
| Answers | http://answers.splunk.com/ |
| Blog | http://blogs.splunk.com/dev/ |
| @splunkdev |
The Splunk logging library for JavaScript is community-supported.
- You can find help through our community on Splunk Answers (use the
logging-library-javascripttag to identify your questions). - File issues on GitHub.
You can contact support if you have Splunk related questions.
You can reach the Dev Platform team at devinfo@splunk.com.
The Splunk Logging Library for JavaScript is licensed under the Apache License 2.0. Details can be found in the LICENSE file.