What's new in the Splunk SDK for JavaScript

The current version of the Splunk SDK for JavaScript is 1.8.2. This topic summarizes the changes included in each version of the SDK.

For a detailed list of new features and APIs, breaking changes, and other changes, see the Splunk SDK for JavaScript Changelog (/splunk-sdk-javascript/changelog.md).

v1.8.2

Version 1.8.2 of the Splunk SDK for JavaScript contains the following changes since the last release:

  • Bug Fixes
    • Correct the JSON for boolean, string, ipv4, and number pivot filter types.
  • Minor changes
    • Updated some dependencies.

v1.8.1

Here's what was new in version 1.8.1 of the SDK:

  • Bug Fixes
    • Ensure modular input streams are flushed, avoid hanging processes (see GitHub pull request #48).
  • Minor changes
    • Add Travis CI configuration.

v1.8.0

Here's what was new in version 1.8.0 of the SDK:

  • Added support for cookie-based authentication, for Splunk 6.2+.
  • Fixed Authorization header always being added to request even when not authenticated.
  • utils.namespaceFromProperties() now returns an empty object when given undefined required parameters.
  • Added multiple formats of Content-Type headers that will be read from a http response.
  • Added logout() method to context.js.

v1.7.1

Here's what was new in version 1.7.1 of the SDK:

  • Fixed an issue with data being truncated by node_http with multi-byte characters.
  • Updated request module to version 2.55.0 to include a bug fix for Node.js v0.12.x.
  • Fixed a bug in Chrome authorization header handling.
  • Updated mustache dependency to version 0.4.0.

v1.7.0

Here's what was new in version 1.7.0 of the SDK:

  • Added support for Node.js v0.12.x and io.js.
  • Added Service.getJob() method for getting a Job by its sid.
  • Added Service.ConfigurationFile.getDefaultStanza() method for getting the [default] stanza of a .conf file.
  • Can now stream JavaScript objects with modular inputs by passing an object as the data parameter to the Event constructor; that object will then be passed to JSON.stringify(). The GitHub commits modular inputs example has been updated with this new functionality.
  • New examples added:
    • The node/helloworld/endpoint_instantiation.js example shows how to access an unsupported REST API endpoint.
    • The node/helloworld/get_job.js example shows how to get a Job by its sid.
  • Other minor changes:
    • Added a --quiet option for running the tests without printing log messages prefixed with [SPLUNKD].
    • Update nodeunit dependency to v0.9.1.
    • Skip data model and pivot tests for older version of Splunk.

v1.6.0

Here's what was new in version 1.6.0 of the SDK:

v1.5.0

Here's what was new in version 1.5.0 of the SDK:

  • Added support for data models and pivots.
  • Fixed namespace parameter handling for Jobs.oneshotSearch and Jobs.search functions.
  • Disallow the wildcard operator - when retrieving an entity from a Service object.
  • Removed the xml2json Splunk app, which was previously bundled with the SDK.

v1.4.0

Here's what was new in version 1.4.0 of the SDK:

v1.3.0

Here's what was new in version 1.3.0 of the SDK:

v1.2.3

Here's what was new in version 1.2.3 of the SDK:

  • Job.track now properly uses the dispatchState property to work consistently across all versions of Splunk.

v1.2.2

Here's what was new in version 1.2.2 of the SDK:

  • Fixed a bug in the examples that prevented them from running on Splunk 6.0.0 (due to an HTTP 413 error).

v1.2.0

Here's what was new in version 1.2.0 of the SDK:

  • Fixed an issue with version 0.10.x of Node.js. Node.js version 0.8.x or 0.10.x is now required.
  • Add back general JQuery HTTP implementation.
  • General improvements to unit tests.

v1.1.0

Here's what was new in version 1.1.0 of the SDK:

  • Added ability to log JSON objects directly from the SDK.
  • Improved job management, such as tracking the progress and iterating over results.
  • Version 1.0 of the client-side Splunk SDK for JavaScript is included with Splunk, starting with version 5.0—if you're using Splunk 5.0 or later, you no longer need to install the client-side SDK files in your JavaScript applications.