Glossary and Notes for Server Plugin

Owned by Brooke Gravitt (Deactivated)
Sept 11, 2020
3 min read

Project Registrations

A representation inside the Plugin application that links Splunk Servers to the JSD / JIRA instances on the server. It encapsulates a many-to-many relationship between JSD / JIRA Projects and Splunk Servers, as well as the events that the Plugin application should monitor on the JSD / JIRA instance for updates to send to the Splunk Server

Project Registration Activation: Activating a Project Registration (using the slider on the Project Registration List page) to turn on the Issue Scan Service.

Scan Interval: A date range representing a time period of Issues on the JSD / JIRA instance that will be synchronized to the Plugin application, and later to the Splunk Server. A Scan Interval can be passed to the Issue Scan Service requesting any issues defined by the Scan Interval from the JSD / JIRA instance and copied to the Plugin application.

Issue Scan Service: A background service that runs at a defined interval ("Issue Scan Interval")  and iterates through each active Project Registration and performs the following steps:

  1. Sends a request to the JSD / JIRA instance a request for any Issue that has been updated since the last request.
  2. Iterates through each issue and decides if the data is duplicated or not and saves all updated Issues.

Scan Issue: A representation of the Issue returned from the JSD / JIRA instance and saved by the Plugin application. For tracking purposes, a copy of the returned Issue from the JSD / JIRA instance will be saved for each Splunk Server associated with the Project Registration. 

Splunk Server

A representation inside the Plugin application that encapsulates the parameters needed to communicate with a physical Splunk Server.

Splunk Activation: Activating a Splunk Server (using the slider on the Splunk List page) to turn on the Splunk Health Check service and the Message Delivery Service. When a Splunk Server is activated, a request is sent to the physical Splunk Server and if the response is successful, the Splunk is Activated. If it is unsuccessful, the Splunk Server can not be activated. (Need to investigate the problem).

Splunk Health Check Service: A background service that runs at a defined interval ("Splunk Heartbeat Interval") and iterates through each active Splunk Server and performs the following steps:

  1. Sends a heart beat message to the Splunk Server and waits for a response.
  2. Updates the Splunk Server List with the response from the Splunk.
  3. Updates any integrated HipChat Glances.
  4. Evaluates the defined number of failed responses("Splunk Failure Count Alert") and sends a message to any integrated HipChat rooms with the failure details. It will continue to send updates every defined number of failures("Splunk Failure Count Interval") until the Splunk Server is back online

Message Delivery Service: A background service that runs at a defined interval ("Delivery Scan Interval") and iterates over through the list of Scan Issues and forwards them to the appropriate Splunk Server.

HipChat Rooms

Prerequisite: Before trying to add a HipChat room into the Plugin application, it is required that the Plugin be integrated inside the HipChat Client first. Please see HipChat documentation if help is needed to perform the prerequisite.

Group Name: This is the name of the group displayed inside your HipChat Client. It can be found at the top of the "left-hand-navigation" within the HipChat Client. (Clicking on it in the Client displays a full list of the People and Rooms assigned to the Group.) The name of Room must be an exact match or an error will be displayed that the Group Can not be found.

Room: Each time the Plugin Application is integrated into HipChat, it is associate with a specific Room within HipChat. Select the Room that the integration currently being configured. If you selected more than one Room, each room will be added as separate items on the HipChat Rooms List.

Assign Splunks: Each integration can be setup to monitor a different list of Splunks. Not only will the integration show the health of the selected Splunk Servers, all failures reported by the selected Splunk Server will displayed in the room associated with this integration.

General

Notifications by actions performed will appears as flags that pop up when the action is complete.

Green: Success - will close automatically after a few seconds. 

Yellow: Caution - requires manual intervention (press the "X" icon) to close.

Red: Error -  requires manual intervention (press the "X" icon) to close.

Â