Monitoring Splunk Connectivity to JSD Server

Prerequisites

• Install and configure the JSD add-on.
• If you want to use HipChat, install the HipChat integration.

Checking Splunk Connectivity in JSD

The add-on automatically checks the connectivity of your Splunk servers every 2 minutes, by default. You can view the current status of these checks on the JSD configuration page for the add-on.

1. Click the gear icon, and then click Applications.

2. Under Integrations, click RealTime Splunk Connector for JIRA.

3. Click the Splunk Servers tab.
   For each server, the table shows the results of the most recent connectivity check and the reason for a failure, if applicable.

4. To modify or remove a Splunk server connection, click the ellipses, and then click Edit or Delete.
   

   The add-on verifies the Splunk URL before activating the connection. If you receive an error message about the Splunk URL, correct the settings and then activate the Splunk server.

    

   Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'DOCS:_Refresh'.

Viewing Unsent Issues

The add-on sends JSD data to the Splunk servers in real time, when an issue event triggers it. If a connectivity issue prevents an issue from being sent successfully, the add-on stores the issue in a queue and periodically attempts to resend it. You can review the issues in this queue and either try to resend them or remove them from the queue.

1. Click the gear icon, and then click Applications.

2. Under Integrations, click RealTime Splunk Connector for JIRA.

3. Click the Splunk Servers tab.
4. Click the ellipses beside a Splunk server, and then click View Unsent Issues.
   The table lists the JSD issues that haven’t been successfully sent to Splunk with a reason for the failure.
   
   
   
5. To view the data payload for an unsent issue, click the ellipses, and then click View Issue Details.
6. To resend or permanently remove the issue from the queue, click the ellipses, and then click Resend or Delete.
   Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'DOCS:_Refresh'.

Monitoring Splunk Connectivity with HipChat

You can monitor Splunk connectivity and receive failure notifications in HipChat.

After you install the HipChat integration for a room, the right sidebar shows a summary of the connectivity status between JSD and your Splunk servers. You can click the summary to expand details for each Splunk server.

The add-on sends a notification to HipChat if a Splunk server fails 5 consecutive connectivity checks, by default. You can click the card title to go directly to the Splunk Servers tab in JSD.

Changing the Settings for Connectivity Checks

You can change the default values for the frequency of connectivity checks, when to send a HipChat notification, and other communication settings between JSD and Splunk.

1. Click the gear icon, and then click Applications.

2. Under Integrations, click RealTime Splunk Connector for JIRA.

3. Click Settings.

4. On the Settings page, configure the communication settings between JSD and Splunk.

   Field	Description
   Splunk Heartbeat Interval	How often the add-on checks the connectivity of your Splunk servers, in minutes. Default value is 2.
   Splunk Failure Count Alert	Number of consecutive Splunk connectivity failures that will trigger an initial HipChat notification (if the HipChat add-on is configured). Default value is 5.
   Splunk Failure Count Interval	Number of consecutive Splunk connectivity failures that will trigger a subsequent HipChat notification, after the initial failure notification. The add-on will continue to send these updates until the Splunk server is back online. Default value is 10.
   Splunk Resend Interval	How often the add-on tries to resend any issues that haven’t been successfully sent to Splunk, in minutes. Default value is 3.
   Use Strict Mode	Whether SSL certificates are verified. Default value is true. If you are using a self-signed certificate on your Splunk servers, set this value to false to disable SSL verification. To turn Strict Mode back on, you must set the value to true, and then restart your JSD instance.

   
   

5. Click Save Settings.
   

Next Steps

If necessary, add, modify, or delete Splunk server connections in JSD.