Install Tivoli with Debian or Ubuntu

The BigPanda agent is a low-footprint utility installed on the master host of your monitoring tool. It consumes alerts from the tool in real-time and then transmits them to BigPanda via TLS-encrypted HTTP calls.

❗️

Python Compatibility

To use the Open Integration Manager for Agent-based integrations, Python version>= 3.8.0 and an Agent version >= 10.2 are required.

Prerequisites

python >= 3.8 and python-pip3 should be installed prior to installing the bigpanda-agent package.

1. Ensure python3 is installed with the following command:

   $ sudo apt install -y python3
   

2. Verify the install with the following commands:

   $ python3 --version
   $ pip3 --version
   

Note: If pip3 was not installed as a dependency, it can be installed with sudo apt install -y python3-pip.

Note: Access to JFrog, pypi, and yum repositories are required to install all dependencies.

Install the BigPanda Agent on Debian or Ubuntu

Connect to the host where your Tivoli server is installed, and install the BigPanda agent package.

1. Ensure packages are installed prior to downloading the BigPanda agent package:

   $ sudo apt update && sudo apt install -y gnupg2 curl lsb-release
   

2. Add the BigPanda repository and download the OpenPGP key:

       $ echo deb https://bigpandaio.jfrog.io/artifactory/int-deb `lsb_release -c -s` main | sudo tee /etc/apt/sources.list.d/bigpanda.list
       $ curl -sL https://bigpandaio.jfrog.io/artifactory/api/security/keypair/bigpanda/public | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/bigpanda.gpg > /dev/null
   

   • The --dearmor option is for unpacking input from an OpenPGP ASCII armored key.
   • Since apt-key is marked to be deprecated on future releases of Debian or Ubuntu, it is preferred to manage keyring files in trusted.gpg.d instead.
   • Note: apt-key can still be used in place of OpenPGP, but it is less secure.

     $ curl -sL https://bigpandaio.jfrog.io/artifactory/api/security/keypair/bigpanda/public | sudo apt-key add -
     

3. Update the repo list and install the BigPanda agent package.

   $ sudo apt update
   $ sudo apt install -y bigpanda-agent
   

   Note: For the OIM, bigpanda-agent v10.0.0+ is required.

Troubleshooting:

Error:

E: The method driver /usr/lib/apt/methods/https could not be found.
N: Is the package apt-transport-https installed?

Solution:

$ sudo ln -sf /usr/lib/apt/methods/http /usr/lib/apt/methods/https
$ sudo apt install -y apt-transport-https
$ sudo apt update

Install the bp_listener package

The bp_listener package is hosted in JFrog and can be installed via pip.

1. Install the bp_listener package as a global python3 package:

   $ sudo pip3 install --extra-index-url https://bigpandaio.jfrog.io/artifactory/api/pypi/int-pypi/simple bp_listener
   
   

   Note: Global installation is required to work correctly with the BigPanda Agent Configurator.

2. You can verify the bp_listener package has been installed into the global site-packages:

   $ sudo pip3 show bp_listener
   

Configure the BigPanda Agent

1. Generate the agent's configuration file:

   $ sudo bigpanda-config --init --token <Your Org Bearer Token>
   $ sudo bigpanda-config --add listener --app-key <Your App Key>
   

Configuration

1. Update the configuration file as needed before starting the bigpanda-listener service:

   $ sudo vim /etc/bigpanda/listener/bp_listener.json
   
   

2. You have the following configuration options:

   • bp.queue: The BigPanda queue the agent is configured to use.
   • bp.logfile: The log file path for bp_listener.
   • listener.port: The port the listener will listen on.
   • listener.host: The host ip the listener will bind to.
   • listener.timeout: The timeout in seconds for the socket to stay open.
   • listener.source_timezone: The IANA compliant timezone identifier.
   • listener.timestamp_key: The key in the payload that contains the timestamp.
   • listener.timestamp_format: The format of the timestamp in the payload.
   • listener.inbound_queue_size: The socket queue for inbound connections, uses up server resources.
   • listener.max_threads: The maximum number of threads to use for processing events.
   • log.level: The log level for bp_listener.
   • log.verbose: Boolean switch to log verbose output.
   • log.log_count: The number of log files to keep.

Start the BigPanda Listener service

1. Start the Bigpanda Listener service by running the following command:

   $ sudo systemctl start bigpanda-listener
   
   

2. Verify the service is running with the following command:

   $ systemctl status bigpanda-listener
   

Testing the BigPanda Listener Service

The client.py script is used to test the functionality of the server, and is located within the bp_listener python package in the installed python3 site-packages/ directory.

The following command will list the location of the bp_listener package:

$ sudo pip3 show bp_listener

The client.py script contains a default payload that is sent to the bigpanda-listener service. A json file can be used to submit a custom payload in place of the default.

To run the client.py script, use the following command:

$ python3 /path/to/bp_listener/test_client/client.py

Example Use:

usage: client.py [-h] [-s SERVER] [-p PORT] [-f FILE]

Client to send test payloads to BP Listener.

options:
  -h, --help                    show this help message and exit
  -s SERVER, --server SERVER    Server address the listener is configured to listen on (default: 127.0.0.1)
  -p PORT, --port PORT          Port the listener is configured to listen on (default: 4011)
  -f FILE, --file FILE          Optional JSON file to send as payload (default: None)
  -r RAW, --raw RAW             Optional TXT file containing a raw EIF type message (default: None)

Start the BigPanda Agent

$ sudo service bigpanda start

Success

You should be able to see all your active Tivoli alerts in the Incidents tab.