> ## Documentation Index
> Fetch the complete documentation index at: https://docs.germainux.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Oracle BI Publisher Monitoring

> Know when BI Publisher reports fail, a server stops or threads get stuck, from the WebLogic and diagnostic logs of every BI Publisher host.

Components
[`Engine`](https://docs.germainux.com/deploy/germain-ux-engine)
[`JS Profiler`](https://docs.germainux.com/deploy/germain-ux-js-profiler)
[`RPA Bot Recorder`](https://docs.germainux.com/deploy/germain-ux-rpa-bot-recorder)
[`RUM JS`](https://docs.germainux.com/deploy/germain-ux-rum-js)
[`RUM Extension`](https://docs.germainux.com/deploy/germain-ux-rum-extension)

Availability
8.6.9 or later

> [card] [What Is Monitored](#what-is-monitored)
>
> Errors, warnings, servers

> [card] [How It Works](#how-it-works)
>
> Log parsers, process checks

> [card] [Deploy](#deploy)
>
> One wizard per host

> [card] [KPIs](#kpis)
>
> Events and server counts

## Overview

GermainUX reads the logs of your Oracle BI Publisher (BIP) servers and checks that they're running. You see every error and warning the BI Publisher application and its WebLogic servers write, from failed reports and delivery errors to stuck threads, and how many WebLogic servers and Node Managers run on each host. An SLA tells you about each new error, so a broken data source or a bursting job that can't send email is found before the report recipients notice. Your team stops searching `bipublisher.log` and the WebLogic logs host by host.

> [card] Report and Delivery Errors
>
> Errors and warnings from the BI Publisher diagnostic log, such as failed reports, data engine errors and delivery failures.

> [card] WebLogic Server Events
>
> Warnings and errors from the AdminServer and `bi_server1` logs, with their WebLogic message ID, such as `BEA-000337` for stuck threads.

> [card] Servers Running
>
> How many WebLogic servers and Node Managers run on each host, checked every minute.

> [card] Every Host in One Place
>
> Compare errors across BI Publisher hosts, and see who ran the report that failed.

### Questions It Answers

* Which BI Publisher reports failed today, and with what error?
* Is `bi_server1` running on every host right now?
* Did the Node Manager start after the host was patched?
* Why did `bi_server1` restart?
* Are threads getting stuck on a BI Publisher server?
* Did a bursting job fail to deliver its reports by email?
* Which users ran into report errors this week?

## What Is Monitored

| Area | What GermainUX monitors |
| - | - |
| **BI Publisher diagnostic events** | Each error and warning in the Oracle diagnostic logs: `bipublisher.log`, `bi_server1-diagnostic.log` and `AdminServer-diagnostic.log`, with its module, message and user |
| **WebLogic server events** | Each warning and error in the `AdminServer.log` and `bi_server1.log` server logs, with its subsystem, WebLogic message ID, server and user |
| **Servers running** | The number of running WebLogic server processes and Node Manager processes on the host |
| **Availability** | Up/down status and response time of the BI Publisher URL, checked on a schedule with [synthetic HTTP checks](https://docs.germainux.com/automation/synthetic-http-execution.md) |
| **Host** | CPU, memory, disk and network of the BI Publisher host. See [Linux monitoring](https://docs.germainux.com/integrations/linux-redhat-suse-monitoring.md) or [Windows monitoring](https://docs.germainux.com/integrations/windows-monitoring.md). |
| **User experience** | Real-user page performance, JavaScript errors and Session Replay for the BI Publisher pages your users work in, with [RUM JS](https://docs.germainux.com/deploy/germain-ux-rum-js.md) or the [RUM Extension](https://docs.germainux.com/deploy/germain-ux-rum-extension.md) |

## Analytics, Alerts and Automation

### AI Analysis

Ask [AI Explore](https://docs.germainux.com/analytics/ai-driven-insights.md) questions such as "Which BI Publisher errors happened most this week?" and get the answer without building a report. [Error categorization](https://docs.germainux.com/analytics/data-categorization.md) groups similar messages, so a new error stands out from the known ones.

### Dashboards and Reports

Build [dashboards and reports](https://docs.germainux.com/dashboards/dashboard-and-report.md) on the BI Publisher KPIs: events per host and module, the WebLogic message IDs that occur most, and the server counts over time.

Click a value to open it in the [Analysis](https://docs.germainux.com/dashboards/analytics-dashboard/4-analysis-dashboard.md) screen. In the example below, threads got stuck on `bi_server1`, and the WebLogic server events spiked with `BEA-000337` messages.

![Analysis screen for the BIP Server Event KPI, with a spike of BEA-000337 stuck-thread events on bi\_server1](https://mintcdn.com/germain-ux/qPS41_DNCFigAODI/images/main/oracle-bi-publisher-monitoring/bip-server-event-analysis.png?fit=max\&auto=format\&n=qPS41_DNCFigAODI\&q=85\&s=031d7429c49742719db2c0b490f6911f)

Analysis of BIP Server Events During Stuck Threads - GermainUX

### Analysis

Open a BI Publisher KPI in the [Analysis](https://docs.germainux.com/dashboards/analytics-dashboard/4-analysis-dashboard.md) screen to see what changed in the selected period. The top row compares the period with the same hours on the previous days, and shows the hourly trend. The relationships chart shows the KPI over a longer time range, with the selected period highlighted. The segmentation breakdown lists the hosts, users and message types that changed most, and labels each one, for example as a spike.

### Investigate a Node Manager That Didn't Start

After a host is patched, the WebLogic servers can come back while the Node Manager doesn't. Open the **WebLogic Node Manager Count** KPI in the Analysis screen. Compare the average count with the previous days, and use the hourly trend to see when it fell to `0`.

In the example below, `bip-01` was patched on 9 November, and its Node Manager wasn't started again. From 09:00 the count is `0`. Over the day shown, the average count is 0.264, down 73.6% on the 1.000 of the previous days, and the breakdown marks `bip-01` as a drop. The relationships chart shows the count at `0` until the Node Manager was started on the afternoon of 10 November. The SLA on the KPI flags the host as soon as no Node Manager runs, so an [alert](https://docs.germainux.com/automation/notifications.md) can tell you on the morning of the patch.

![Analysis screen for the WebLogic Node Manager Count KPI, with an average of 0.264 against 1.000 on the previous days, the hourly trend falling to 0, the relationships chart at 0 from 9 November to the afternoon of 10 November, and bip-01 marked as a drop](https://mintcdn.com/germain-ux/qPS41_DNCFigAODI/images/main/oracle-bi-publisher-monitoring/bip-node-manager-count-analysis.png?fit=max\&auto=format\&n=qPS41_DNCFigAODI\&q=85\&s=b133e690f494922b02c81ac289884719)

Aggregate Analysis of WebLogic Node Manager Count After Host Patching - GermainUX

### Investigate a Server Restart

When `bi_server1` crashes and the Node Manager restarts it, the **WebLogic Server Count** of the host drops for a few minutes. Open the KPI in the Analysis screen to see when it dropped and for how long.

In the example below, `bi_server1` on `bip-01` ran out of heap at 15:20. Before it stopped, WebLogic logged low-memory warnings (`BEA-310003`) in the **BIP Server Event** KPI, and BI Publisher logged `java.lang.OutOfMemoryError: Java heap space` in **BIP Diagnostic Event**. The server count fell from `2` to `1` until the Node Manager restarted the server 25 minutes later. Over the five hours shown, the average count is 1.917, down 4.2% on the 2.000 of the previous days, and the hourly trend dips in the afternoon. The count never reaches `0`, so the SLA on the KPI isn't breached. Open the event KPIs for the same period to see why the server stopped.

![Analysis screen for the WebLogic Server Count KPI, with an average of 1.917 servers against 2.000 on the previous days, and a dip in the hourly trend and the relationships chart on 12 November](https://mintcdn.com/germain-ux/qPS41_DNCFigAODI/images/main/oracle-bi-publisher-monitoring/bip-server-count-restart-analysis.png?fit=max\&auto=format\&n=qPS41_DNCFigAODI\&q=85\&s=87debd8348c92c2858761d8e7c4ff420)

Aggregate Analysis of WebLogic Server Count During a Restart - GermainUX

### Investigate Reporting Database Errors

When the reporting database can't be reached, every report that reads it fails. Open the **BIP Diagnostic Event** KPI in the Analysis screen. The top row shows how far the errors rose above the previous days. The segmentation breakdown shows whether they come from one user or from all of them.

In the example below, the reporting database `rpt-db-01` was unreachable for 45 minutes. The data engine logged a connection error for data source `RPT_DB` for every report that ran, and WebLogic logged `BEA-001129` for the `RPT_DB` connection pool in the **BIP Server Event** KPI. The analysis shows 146 diagnostic events against 13 at the same hours on the previous days. The breakdown marks the host `bip-01` and the `ERROR` message type as a spike, and spreads the errors over the users `ops_lead01`, `sched_batch`, `fin_analyst01` and `fin_analyst02`. Errors from every user point to a shared cause, such as the database, rather than one report. The errors stop when the database is back.

![Analysis screen for the BIP Diagnostic Event KPI, with 146 events against 13 on the previous days, a spike on the morning of 14 November in the relationships chart, and bip-01, ERROR and the users ops\_lead01, sched\_batch, fin\_analyst01 and fin\_analyst02 marked as spikes](https://mintcdn.com/germain-ux/qPS41_DNCFigAODI/images/main/oracle-bi-publisher-monitoring/bip-diagnostic-event-database-analysis.png?fit=max\&auto=format\&n=qPS41_DNCFigAODI\&q=85\&s=1eed0a9eb3cafc4f881e680ae131e0f2)

Aggregate Analysis of BIP Diagnostic Events During a Database Outage - GermainUX

### Investigate Failed Report Delivery

A bursting job that can't send its email logs a delivery error for each report it tries to send. Open the **BIP Diagnostic Event** KPI in the Analysis screen for the time the job ran. The segmentation breakdown shows the user the job runs as.

In the example below, the nightly bursting job couldn't reach the SMTP server `smtp.example.com` for 40 minutes after 02:00. Each delivery failed with `Could not connect to SMTP host: smtp.example.com, port: 25`. The analysis shows 133 events against 3 at the same hours on the previous days, and the breakdown marks the host `bip-01` and the user `sched_batch` as a spike. The SLA on the KPI flags each delivery error, so an [alert](https://docs.germainux.com/automation/notifications.md) can tell you before the report recipients notice that nothing arrived.

![Analysis screen for the BIP Diagnostic Event KPI, with 133 events against 3 on the previous days, a spike in the early hours of 15 November in the relationships chart, and bip-01 and the sched\_batch user marked as spikes](https://mintcdn.com/germain-ux/qPS41_DNCFigAODI/images/main/oracle-bi-publisher-monitoring/bip-diagnostic-event-delivery-analysis.png?fit=max\&auto=format\&n=qPS41_DNCFigAODI\&q=85\&s=29020dbd73c897d81dc54fab06629457)

Aggregate Analysis of Failed Report Delivery - GermainUX

### SLAs and Alerts

The event KPIs ship with an SLA that flags every new event. The server-count KPIs ship with an SLA that flags a host where no WebLogic server or no Node Manager runs. Get an [alert](https://docs.germainux.com/automation/notifications.md) by email, SMS, Slack or Teams when one is breached, and adjust the [SLAs](https://docs.germainux.com/analytics/slas.md) to the events you care about.

### Correlation with Other Technologies

[Correlate](https://docs.germainux.com/analytics/correlation-and-tracing.md) BI Publisher events with the [Oracle WebLogic](https://docs.germainux.com/integrations/oracle-weblogic-monitoring.md) servers it runs on, the [Oracle Database](https://docs.germainux.com/integrations/oracle-db-observability.md) behind its reports, and [OBIEE](https://docs.germainux.com/integrations/obiee-monitoring.md) when BI Publisher runs as part of it.

## How It Works

BIP logs and processes
Engine on the BIP host
KPIs
Alerts

The **BIP App Server** wizard applies a server profile to the BI Publisher host. The profile deploys these components to the GermainUX Engine on that host:

| Component | What it does |
| - | - |
| **BIP Admin Log Directory Monitor** | Watches the AdminServer log directory and sends new lines of `AdminServer.log` and `AdminServer-diagnostic.log` to the parsers |
| **BIP Log Directory Monitor** | Watches the managed server log directory and sends new lines of `bipublisher.log`, `bi_server1.log` and `bi_server1-diagnostic.log` to the parsers |
| **BIP Diagnostic Parser** | Reads the diagnostic logs and stores each error and warning as a **BIP Diagnostic Event** |
| **BIP Server Parser** | Reads the WebLogic server logs and stores each warning and error as a **BIP Server Event** |
| **BIP Monitor Local** | Counts the running WebLogic server and Node Manager processes on the host every minute |

## Before You Start

* A [GermainUX Engine](https://docs.germainux.com/deploy/germain-ux-engine.md) runs on the BI Publisher host.
* The Engine's account can read the AdminServer log directory and the `bi_server1` log directory, for example `<DOMAIN_HOME>/servers/AdminServer/logs` and `<DOMAIN_HOME>/servers/bi_server1/logs`.
* The BI Publisher managed server is named `bi_server1`, as in a default installation. The log monitor picks up its log files by that name.
* The host is a [host data source](https://docs.germainux.com/management/data-source.md) in GermainUX.

## Deploy

**1. Open the BIP App Server wizard**

In the left menu, go to **Settings > Wizards**. On the **BIP App Server** card, click **Add**.

**2. Select the BI Publisher host**

In **Servers**, select the BI Publisher host, and then click **Apply**.

**3. Enter the log directories**

Fill in the fields, and then finish:

| Field | Value |
| - | - |
| **Admin Log Directory** | The AdminServer log directory, for example `<DOMAIN_HOME>/servers/AdminServer/logs`. Select it, or create it. |
| **Server Log Directory** | The `bi_server1` log directory, for example `<DOMAIN_HOME>/servers/bi_server1/logs` |
| **Application** | The application the data belongs to. The default is `BIP - Oracle Business Intelligence Publisher`. |

![BIP App Server profile fields with the Admin Log Directory, Server Log Directory and Application filled in](https://mintcdn.com/germain-ux/qPS41_DNCFigAODI/images/main/oracle-bi-publisher-monitoring/bip-app-server-profile-fields.png?fit=max\&auto=format\&n=qPS41_DNCFigAODI\&q=85\&s=591397cf8b785c9a04eb1342e43da822)

BIP App Server Profile Fields - GermainUX

GermainUX deploys the components to the Engine on the host and starts reading the logs. Repeat the wizard for each BI Publisher host.

## Validate

**1. Check the server counts**

In GermainUX Workspace, open the **WebLogic Server Count** KPI. Within two minutes, the BI Publisher host shows the number of WebLogic servers running on it, for example `2` for the AdminServer and `bi_server1`.

**2. Check the events**

Open the **BIP Diagnostic Event** and **BIP Server Event** KPIs. They show the errors and warnings that the logs receive after deployment. If the servers write none, run a report with a parameter you know fails, and look for its error.

## Troubleshooting

> [accordion] No BI Publisher events appear
>
> Check that the Engine runs on the BI Publisher host, that its account can read both log directories, and that the managed server's logs are named `bi_server1.log` and `bi_server1-diagnostic.log`. Log files of a managed server with another name aren't picked up.

> [accordion] WebLogic Server Count shows 0
>
> No WebLogic server process runs on the host, or the Engine runs on another host. Start the servers, or deploy the profile to the Engine on the BI Publisher host.

> [accordion] Only some log messages appear
>
> The parsers keep errors and warnings only. Informational and notification messages aren't stored.

## Security and Privacy

Oracle BI Publisher monitoring data includes personal data:

* **Identity data**: the BI Publisher user ID of the request that logged the event
* **Free text**: the log message in each event, which can contain report names, parameters, email addresses and host names. Treat it as possibly containing personal or customer data.

To mask, anonymize or exclude this data, see [Data Privacy](https://docs.germainux.com/management/compliance-privacy-and-security/data-privacy.md).

## KPIs

| KPI | What it holds | Default SLA |
| - | - | - |
| **BIP Diagnostic Event** | One event per error or warning in the diagnostic logs | Flags every event |
| **BIP Server Event** | One event per warning or error in the WebLogic server logs | Flags every event |
| **WebLogic Server Count** | The number of WebLogic server processes running on the host | OK when greater than `0`, per host |
| **WebLogic Node Manager Count** | The number of Node Manager processes running on the host | OK when greater than `0`, per host |

The event KPIs are data model `GenericEvent`, and the count KPIs `GenericMetric`. The count KPIs are shared with [OBIEE](https://docs.germainux.com/integrations/obiee-monitoring.md). See [KPIs](https://docs.germainux.com/analytics/kpis.md) and [SLAs](https://docs.germainux.com/analytics/slas.md).

## Related Documentation

> [card] [Oracle WebLogic](https://docs.germainux.com/integrations/oracle-weblogic-monitoring.md)
>
> The servers BI Publisher runs on

> [card] [File and Log Monitoring](https://docs.germainux.com/integrations/file-log-monitoring.md)
>
> How GermainUX reads log files

> [card] [Automation](https://docs.germainux.com/automation.md)
>
> More Automation Features

## Get Help

The GermainUX team can help you monitor BI Publisher installations with other managed server names or log locations.

> [card] [Contact GermainUX Support](https://docs.germainux.com/getting-started/support.md)
>
> The GermainUX team helps you get up and running faster, empower your team, turn data into actionable insights, and optimize performance to deliver measurable business outcomes.

> [card] Can't Find What You Need?
>
> Search all GermainUX docs with **Ctrl + K**, or use the feedback buttons at the bottom of this page to tell us what is missing.

The content of this document is proprietary to GERMAIN SOFTWARE.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.