Integrating with third-party platforms

Third-party integration is a premium feature and is not available on the default version of the app. To unlock this feature, please contact ServiceRocket Support for assistance.

Splunk

Splunk is a powerful platform designed to handle large volumes of machine-generated data, such as logs, metrics, and events. It allows users to search, monitor, and analyze this data in real-time.

When integrating Splunk with Guard Dog Proxy for Jira, you can set up Splunk to receive time-stamped events through the HTTP Event Collector using the Splunk platform JSON event protocol. This integration enables you to monitor and analyze Jira REST API calls effectively.

While configuring the third-party app, ensure that you have created an HTTP Event Collector Token in Splunk Enterprise and have enabled data flow.

To establish a successful connection, ensure that you’ve pasted the generated token and your Splunk instance URL into the application configuration page .

Setting Up Splunk Integration

1. Refer to the Splunk Documentation or follow the steps below:

2. Create an HTTP Event Collector Token in Splunk Enterprise, https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector may help:

   1. Have your Splunk instance ready.

   2. Navigate to the Settings menu and select Add Data to begin configuring the data you wish to send to Splunk.
      

      

3. Enable Data Flow:

   1. Choose Monitor to allow data to flow through your Splunk instance.

      

4. Set up HTTP Event Collector:

   1. Navigate to the HTTP Event Collector section.

   2. Fill in the Name field for the new token.

   3. Click Next > Review, and click Submit to generate the token.
      

      

5. Configure the application:

   1. On your application configuration page, paste the token into the Splunk API Token field.

   2. Enter your Splunk instance URL.

   3. Click Connect to establish the connection between your application and Splunk.

      

Testing the Integration

1. Prepare the request:

   1. Go to settings, copy the proxy URL and add it to the requests that need monitoring.
      

      

2. Send the request via postman:

   1. Open Postman and send a request to the Jira REST API (e.g., GET issue) using the proxy API endpoint.

      

3. Verify the log in Splunk:

   1. Check Splunk to confirm that the log for the Jira REST API call appears in the search results.

      

4. Review proxy API logs:

   1. Access the proxy API logs to ensure the log for the Jira REST API call is recorded correctly.
      

      

Logstash

Logstash is an open-source data processing pipeline that collects, processes and forwards logs or other types of data to various outputs. It is often used to aggregate and transform logs from different sources before sending them to systems like Elasticsearch, Splunk, or other databases for storage and analysis.

When integrating Logstash with Guard Dog Proxy for Jira, you need to configure Logstash to receive data from the Guard Dog Proxy for Jira settings page.

Enter the endpoint where your Logstash instance is configured to receive data and select the appropriate authentication method.

During configuration, ensure that the data flow is correctly set up and that the necessary credentials are provided if applicable. This setup allows for real-time data processing and supports a wide range of input, filter, and output plugins, making it highly versatile for managing log data.

Setting up Logstash integration

1. Configuration

   1. Navigate to Jira top menu Settings (⚙️)> Apps > Forge Observability – API Proxy.

   2. Click Settings (⚙️)and find the Logstash section.

   3. Enter the endpoint where your Logstash instance is configured to receive data.

   4. Select the appropriate authentication method (e.g., None, Basic, Bearer) and provide the necessary credentials if applicable.
      

      

2. Testing the integration

To test Logstash integration with Guard Dog Proxy for Jira, you can use Postman or similar to send a Jira REST API request via the Proxy API endpoint.

Next step

• Deploying Forge Observer for Jira (API Proxy)