Splunk Enterprise SDK for JavaScript

In version 2.x, Splunk Enterprise SDK for JavaScript methods have been updated to return Promises. This allows you to use async/await instead of passing callback functions.

Important Change: The abort() method has been replaced by the response_timeout parameter, which allows you to specify a timeout for a particular API call.

// v2.x Promise/async-await approach
let appName = "<app-name>";  
try {
    let apps = await service.apps().fetch();
    let appList = apps.list();
    // other code
} catch (err) {
    console.log("There was an error retrieving the list of applications:", err);
}

Options are used to modify the qualities of a plugin instance. Each plugin provides a default object that can be modified to affect all subsequent instances via $.fn.plugin.defaults.

Example of modifying defaults:

$.fn.modal.defaults = { 
  backdrop: true,
  keyboard: false,
  placement: 'top' 
};

Each plugin stores a copy of the invoked class instance on an object. You can access this instance directly through jQuery's .data() API.

Example of checking if an element is an instance of a plugin's constructor:

$('[rel=popover]').data('popover') instanceof $.fn.popover.Constructor

Bootstrap plugins can be used purely through HTML markup using data attributes without writing JavaScript. This allows for declarative interaction patterns.

To disable the data-attribute API globally, unbind all events on the body namespaced with 'data-api':

$('body').off('.data-api')

To target a specific plugin for disabling, include the plugin's name as a namespace:

$('body').off('.alert.data-api')

All Bootstrap plugins are available via a JavaScript API. Public APIs are designed to be single, chainable methods that return the collection they acted upon.

Methods typically accept one of three types of arguments:

1. An optional options object: To configure the plugin instance.
2. A string: To target a specific method (e.g., 'show').
3. null: To initiate the default behavior.

Example of chaining and method invocation:

// Chaining methods
$(".btn.danger").button("toggle").addClass("fat")

// Initializing with defaults
$("#myModal").modal()

// Initializing with custom options
$("#myModal").modal({ keyboard: false })

// Initializing and invoking a specific method immediately
$("#myModal").modal('show')

Bootstrap events follow a specific naming convention using infinitive and past participle forms:

• Infinitive: Fired just before an action takes place (e.g., show).
• Past Participle: Fired upon completion of the action (e.g., shown).

Common examples include:

• show | shown
• hide | hidden

To authenticate with Splunk using a token instead of a session key, pass the token to the sessionKey property when initializing the splunkjs.Service object. Ensure the scheme (e.g., 'https') and host are correctly configured for your Splunk instance.

let serviceWithBearerToken = new splunkjs.Service({
    // Replace the host if you are accessing remote host
    scheme: 'https',
    host: 'localhost',
    port: '8089',
    sessionKey: TOKEN, // Add your token here
    version: '8',
});

try {
    let res  = await serviceWithBearerToken.jobs({ count: 2 });
    console.log("Login successful with bearer token");
} catch(err) {
    console.log(err);
}

To use token-based authentication, you must first enable token authentication on the Splunk instance, then create a token.

Enable token authentication via Shell

curl -k -u <username>:<password> -X POST <scheme>://<host>:<port>/services/admin/token-auth/tokens_auth -d disabled=false

Enable token authentication via Web UI

Navigate to Settings > Tokens and click on 'Enable Token Authentication'.

Create a token via Shell

curl -k -u <username>:<password> -X POST <scheme>://<host>:<port>/services/authorization/tokens?output_mode=json --data name=<username> --data audience=Users --data-urlencode expires_on=+30d

To use the SDK in a Node.js project, use the require function to import the module.

let splunkjs = require('splunk-sdk');

Data attributes define interactions and options directly in markup. They follow these patterns:

• data-{{verb}}={{plugin}}: Defines the main interaction.
• data-target or href^=#: Used on a 'control' element to target a different element.
• data-{{noun}}: Defines class instance options.

Examples

Control elements (targeting others):

<div data-toggle="modal" data-target="#foo"></div>
<div data-toggle="collapse" data-target="#foo" data-parent="#bar"></div>

Elements being controlled:

<div data-spy="scroll"></div>
<div data-dismiss="modal"></div>
<div data-dismiss="alert"></div>

Other common toggles:

<div data-toggle="dropdown"></div>
<div data-toggle="button"></div>
<div data-toggle="buttons-checkbox"></div>
<div data-toggle="buttons-radio"></div>