IBM Cloud Application Business Insights

https://www.ibm.com/docs/en/cabi
Admin
IBM Cloud Application Business Insights is an enterprise application monitoring and analytics...
Tokens:205,781
Snippets:1,282
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Start ICABI Server Script

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=application-installing-cloud-business-insights

This bash script starts the Cloud Application Business Insights server, OIDC server, Derby database, and NiFi server. It requires navigating to the installation directory before execution. The script outputs the status of each server as it starts.

```bash
cd $install_dir
./start_icabi.sh
```

--------------------------------

### Start IBM Cloud Application Business Insights Servers (Shell Script)

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=ip-installing-cloud-application-business-insights-fix-pack-1

This script initiates the Cloud Application Business Insights server, OIDC server, and PostgreSQL database. It requires navigating to the installation directory and executing the 'start_prd.sh' script. The output confirms the successful startup of the database and application servers.

```shell
cd $install_dir
./start_prd.sh
```

--------------------------------

### Start Real Time Data Collector Script (Shell)

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=tasks-starting-real-time-data-collector

This script navigates to the Real Time Data Collector directory and executes the start script. Ensure you have the correct installation directory path. The script takes no arguments.

```shell
cd install_dir/prdrtdc
./start_prdrtdc.sh
```

--------------------------------

### Configure Patroni Systemd Service (Systemd Unit File)

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=availability-installing-software

Defines the systemd service file for Patroni, specifying its description, dependencies, user, group, and the command to start the Patroni process with a given configuration file. This allows Patroni to run as a managed service.

```systemd
[Unit]
Description=Patroni
After=syslog.target network.target
[Service]
Type=simple
User=postgres
Group=postgres
ExecStart=/bin/patroni <path>/patroni.yml
KillMode=process
TimeoutSec=30
Restart=no
[Install]
WantedBy=multi-user.target
```

--------------------------------

### Install EPEL Repository Directly from RPM

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=availability-installing-software

This command downloads and installs the EPEL repository directly from its RPM package URL. This is an alternative method if the `yum install` command fails.

```bash
rpm -ivh https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
```

--------------------------------

### Install Package from Enabled EPEL Repository

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=availability-installing-software

This command installs a specific package using YUM, explicitly enabling the EPEL repository. Replace `<PACKAGE_NAME>` with the actual package you wish to install.

```bash
yum install --enablerepo=epel <PACKAGE_NAME>
```

--------------------------------

### Install Apache NiFi-based Connector Framework (Shell Script)

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=premises-optional-installing-apache-nifi-based-connector-framework

This script installs the Apache NiFi-based Connector framework. It requires the user to navigate to the distribution directory and execute the install script. An optional installation directory can be provided; otherwise, it defaults to /opt/icabi.

```shell
cd $DIST_DIR2
./install_prdconnector.sh [<install_dir>]
```

```shell
./install /home/icabi
```

--------------------------------

### Install EPEL Repository using YUM

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=availability-installing-software

This command installs the EPEL repository package using the YUM package manager. Ensure you have internet connectivity and appropriate permissions.

```bash
yum install epel-release
```

--------------------------------

### Install Patroni and Dependencies (Bash)

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=availability-installing-software

Installs Python, pip, and other necessary development libraries using YUM, followed by the installation of Patroni and its supporting Python packages (psycopg2, python-etcd) using pip. This prepares the system for Patroni cluster management.

```bash
yum install -y gcc python-devel python2-pip
pip install --upgrade setuptools
pip install psycopg2-binary
pip install patroni
pip install python-etcd
```

--------------------------------

### Install Fix Pack 4 using Installation Script

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=ip-installing-cloud-application-business-insights-fix-pack-4

Command to execute the Fix Pack installation script. This script is run from the directory where the Fix Pack media was extracted and requires the path to the previous installation.

```shell
cd <DIST_DIR>/
./icabi_1.1.8.4.sh
```

--------------------------------

### Install PostgreSQL using YUM Repository (Bash)

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=availability-installing-software

Installs PostgreSQL 12 server and client packages on a Red Hat-based system using the official PostgreSQL YUM repository. This involves configuring the repository and then installing the necessary packages.

```bash
yum -y install \
https://download.postgresql.org/pub/repos/yum/reporpms/EL-8-x86_64/pgdg-redhat-repo-latest.noarch.rpm
dnf -y install postgresql12 postgresql12-server
```

--------------------------------

### Install HAProxy using YUM (Bash)

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=availability-installing-software

Installs the HAProxy package on a Red Hat-based system using the YUM package manager. HAProxy is a high-performance load balancer and proxy server.

```bash
yum install -y haproxy
```

--------------------------------

### Install and Configure etcd (Bash)

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=availability-installing-software

Installs the etcd service by downloading binaries, extracting them, moving them to the system's PATH, creating necessary directories and users, and setting up a systemd service file for etcd. This includes defining environment variables for etcd's operation.

```bash
tar -xvf etcd-v2.2.5-linux-amd64.tar.gz
mv etcd etcdctl  /usr/local/bin
mkdir -p /var/lib/etcd && mkdir -p /etc/etcd
groupadd –-system etcd
useradd -s /sbin/nologin –-system -g etcd etcd
chown -R etcd:etcd /var/lib/etcd
```

--------------------------------

### GET Method URI Example

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=sources-configuring-salesforce-rest-api-connector

Example of a Uniform Resource Identifier (URI) for a GET request to retrieve data from a Salesforce API. This format is used to query specific data based on the provided parameters.

```text
/services/data/v48.0/query/?q=SELECT+Name,Type,Phone,Industry+FROM+Account
```

--------------------------------

### Example URI for GET Method in OMNIbus Connector

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=products-configuring-tivoli-netcoolomnibus-connector-sources

This example demonstrates the format of a Uniform Resource Identifier (URI) used for a GET request when configuring the OMNIbus Connector. It specifies parameters for filtering and ordering alerts.

```text
/objectserver/restapi/alerts/status?collist=ServerName,Serial,AlertGroup,Summary,Severity,LastOccurrence&filter=LastOccurrence%3E1527591654&orderby=LastOccurrence%20DESC 
```

--------------------------------

### REST API GET Method URI Example

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=connectors-configuring-rest-api-connector-sources

This snippet shows an example URI for making a GET request to a REST API. It is a simple string representing the endpoint.

```plaintext
/sampleuri
```

--------------------------------

### Navigate to basic-registry.xml File

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=tasks-adding-modifying-user-information-in-registry

This command navigates to the directory containing the basic-registry.xml file. It assumes the installation directory is stored in the `$install_dir` environment variable. Replace `$install_dir` with the actual installation path if it's not set.

```bash
cd $install_dir/wlp/usr/servers/prdauth
vi basic-registry.xml
```

--------------------------------

### Start Real Time Data Collector Script (Shell)

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=collector-restarting-real-time-data

This script starts the Real Time Data Collector service. It requires navigating to the installation directory and executing the start script. The 'install_dir' variable must be set to the application's installation path.

```shell
cd $install_dir/prdrtdc
./start_prdrtdc.sh
```

--------------------------------

### GET /sampleuri

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=connectors-configuring-rest-api-connector-sources

Example endpoint for a GET request.

```APIDOC
## GET /sampleuri

### Description
Example endpoint for a GET request.

### Method
GET

### Endpoint
/sampleuri

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **string** (string) - Description of the response

#### Response Example
```json
{
  "message": "Success"
}
```
```

--------------------------------

### Start PostgreSQL Daemon

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=cluster-migrating-stand-alone-postgresql-instance-node

Initiates the PostgreSQL database server process. Requires specifying the PostgreSQL binary directory and the data directory. This is a prerequisite for connecting to the database.

```shell
<BIN_DIR>/pg_ctl -D <DATA_DIR> start
```

--------------------------------

### SolarWinds URI Examples for GET and POST

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=products-configuring-solarwinds-connector-sources

Illustrates the URI formats for GET and POST methods when configuring a SolarWinds data source. The GET method includes a query parameter, while the POST method uses a base URI.

```text
/SolarWinds/InformationService/v3/Json/Query?query=QUERY
```

```text
/SolarWinds/InformationService/v3/Json/Query
```

--------------------------------

### ICABI Server Startup Output

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=application-installing-cloud-business-insights

This output shows the successful startup of various ICABI components, including the main server, AP server, Connector Server, and ApacheDS LDAP server. It confirms that processes are running and provides their respective process IDs.

```text
Starting ICABI Server...
Derby process is already running

Starting server icabi.
Server icabi started with process ID 748.

Starting server icabiap.
Server icabiap started with process ID 1019.
Starting Connector Server...
Starting LDAP Server
Using ADS_HOME:   /opt/icabi/connector/apacheds-2.0.0-M24
Using JAVA_HOME:

Starting ApacheDS instance 'default'...
ApacheDS is already running as 31345
Connector server already running.
```

--------------------------------

### Start Patroni Service

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=availability-initializing-your-cluster

Starts the Patroni service. Patroni is a high-availability solution for PostgreSQL. This command assumes Patroni is installed and configured on the system.

```bash
systemctl start patroni
```

--------------------------------

### Prometheus URI Example for Range Query

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=products-configuring-prometheus-connector-sources

This example demonstrates the format for a Prometheus URI when performing a range query. It includes the query parameter and specifies the start and end times in UTC format, along with a step interval.

```plaintext
/api/v1/query_range?query=process_cpu_seconds_total&start=2019-07-04T08:00:19.699Z&end=2019-07-04T18:30:19.699Z&step=5m
```

--------------------------------

### Configure etcd Systemd Service (Systemd Unit File)

Source: https://www.ibm.com/docs/en/cabi/1.1_topic=availability-installing-software

Defines the systemd service file for etcd, including its description, documentation link, dependencies, user, data directory, and the executable path. It also specifies restart behavior and resource limits, enabling etcd to run as a reliable service.

```systemd
[Unit]
Description=etcd cluster
Documentation=https://github.com/etcd-io/etcd
After=syslog.target network.target
[Service]
User=etcd
Type-notify
Environment file=/etc/etcd/default
Environment=ETCD_DATA_DIR=/var/lib/etcd
Environment=
ExecStart=/usr/local/bin/etcd
Restart=always
RestartSec=10s
LimitNOFILE=40000
[Install]
WantedBy=multi-user.target
```
Tokens:
Raw