Skip to content

Latest commit

 

History

History

fn_pulsedive

README.md

fn-pulsedive Functions for IBM Resilient

Release Notes

v1.0.1

  • App Host support

v1.0.0

  • Initial Release

Overview

Resilient Circuits Components for 'fn_pulsedive'

screenshot: fn-pulsedive-wf

Resilient Circuits Components for 'fn_pulsedive'

Requirements

  • Resilient platform >= v35.0.5343
  • An Integration Server running resilient_circuits>=30.0.0
    • The minimum set of Resilient API permissions if using an API key account:
      • Incidents.Edit.Fields
      • Workflows.Create
      • Workflows.Edit
      • Functions.Read
      • Functions.Create
      • Functions.Edit
      • Other.ReadIncidentsActionInvocations
      • Edit Org Data
      • Scripts.Create
      • Scripts.Edit
    • To set up an Integration Server see: ibm.biz/res-int-server-guide

Installation

  • Download the fn_pulsedive.zip.

  • Copy the .zip to your Integration Server and SSH into it.

  • Unzip the package:

    $ unzip fn_pulsedive-x.x.x.zip

  • Change Directory into the unzipped directory:

    $ cd fn_pulsedive-x.x.x

  • Install the package:

    $ pip install fn_pulsedive-x.x.x.tar.gz

  • Import the configurations into your app.config file:

    $ resilient-circuits config -u

  • Import the fn_pulsedive customizations into the Resilient platform:

    $ resilient-circuits customize -y -l fn-pulsedive

  • Open the config file, scroll to the bottom and edit your fn_pulsedive configurations:

    $ nano ~/.resilient/app.config
    Config Required Example Description
    pulsedive_api_key Yes <my api key> User API key that can be found under Pulsedive --> API
    pulsedive_api_url Yes https://pulsedive.com/api/ Pulsedive base URL

  • Save and Close the app.config file.

  • [Optional]: Run selftest to test the Integration you configured:

    $ resilient-circuits selftest -l fn-pulsedive

  • Run resilient-circuits or restart the Service on Windows/Linux:

    $ resilient-circuits run

Uninstall

  • SSH into your Integration Server.
  • Uninstall the package: 
    $ pip uninstall fn-pulsedive
  • Open the config file, scroll to the [fn_pulsedive] section and remove the section or prefix # to comment out the section.
  • Save and Close the app.config file.

Troubleshooting

There are several ways to verify the successful operation of a function.

Resilient Action Status

  • When viewing an incident, use the Actions menu to view Action Status.
  • By default, pending and errors are displayed.
  • Modify the filter for actions to also show Completed actions.
  • Clicking on an action displays additional information on the progress made or what error occurred.

Resilient Scripting Log

  • A separate log file is available to review scripting errors.
  • This is useful when issues occur in the pre-processing or post-processing scripts.
  • The default location for this log file is: /var/log/resilient-scripting/resilient-scripting.log.

Resilient Logs

  • By default, Resilient logs are retained at /usr/share/co3/logs.
  • The client.log may contain additional information regarding the execution of functions.

Resilient-Circuits

  • The log is controlled in the .resilient/app.config file under the section [resilient] and the property logdir.
  • The default file name is app.log.
  • Each function will create progress information.
  • Failures will show up as errors and may contain python trace statements.

Timeouts

Pulsedive Search may take a long time to execute. In the case that the function times out, you can edit the timeout setting in app.config. If the timeout setting is not there, go to app.config and add the following to increase the timeout setting to 60 seconds. For example:

[integrations]
timeout=60

Support

Name Version Author Support URL
fn_pulsedive 1.0.1 Resilient Labs http://ibm.biz/resilientcommunity