Skip to content

Commit

Permalink
Add Business Intelligence 2.4.0 blog (#907)
Browse files Browse the repository at this point in the history
* Add Business Intelligence 2.4.0 blog

* Update index.mdx

* Big 2.4.0 blog post update

* Formatting

* Updates

---------

Co-authored-by: daria-vl <[email protected]>
  • Loading branch information
mikhail-vl and daria-vl authored Feb 7, 2025
1 parent cdb547c commit d0deee4
Show file tree
Hide file tree
Showing 13 changed files with 211 additions and 3 deletions.
2 changes: 1 addition & 1 deletion big/engine-spec.json

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions big/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,12 @@ and login as 'admin' with 'admin' password.

5. Update `GRAFANA_TOKEN` in the `docker-compose.yml` file

:::note Version 2.4.0

Grafana token and URL can be set using Business Studio to avoid changing environment variables.

:::

<Image
title="Update GRAFANA_TOKEN in the docker-compose.yml file."
src="/img/big/getting-started/token-yml.png"
Expand Down
8 changes: 6 additions & 2 deletions big/release.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ Release Notes for the Business Intelligence platform for Grafana.

**This is a public preview release of Business Studio 2.4.0 compatible with Business Engine 2.4.0.**

### Breaking Changes in Engine API
:::warning Breaking Changes in Engine API

- Updated data routes from /grafana to /grafana-data.
Updated data routes from /grafana to /grafana-data.

:::

### Business Studio 2.4.0

Expand All @@ -34,6 +36,8 @@ Release Notes for the Business Intelligence platform for Grafana.
- Added API to get alert data preview.
- Updated alert event structure for consistency.

<BlogPost id="business-intelligence-2.4.0" />

### Downloads from GitHub

:::info Security risks
Expand Down
198 changes: 198 additions & 0 deletions blog/big/2025-02-05-big-2.4.0/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
---
authors: [daria]
slug: business-intelligence-2.4.0/
tags: [Business Intelligence]
image: /img/blog/2025-02-05-big-2.4.0/banner.png
keywords: [Business Intelligence, Alerting, Grafana]
---

import Code from "@theme/Code";
import Feedback from "@site/big/_feedback.mdx";
import Image from "@theme/Image";
import Shorts from "@theme/Shorts";
import Youtube from "@theme/Youtube";

# Streamlined connection to Grafana, improved alert details, simplified scheduler, and more in Business Intelligence 2.4.0

We are excited to announce the public preview release of the Business Intelligence 2.4.0. It includes the following updates:

- Possibility to connect a Business Engine to Grafana instance via Business Studio.
- Improved the alert event details for better troubleshooting.
- Added high availability (HA) state in the Business Engine overview.
- Simplified schedule entry for creating alert rules.
- Added Grafana data frames review in the Business Studio.
- Enhanced user prompts to improve configuration clarity.
- Updated Business Engine API documentation.

## Connect a Business Engine to Grafana instance via Business Studio

Previously, the connection between the Business Engine and the Grafana instance had to be made manually, updating the `GRAFANA_TOKEN` environment variable in the configuration file.

Starting from this release, the Business Studio allows you to establish that connection in the comfort of a user-friendly interface.

To accomplish that, follow the steps:

1. Open Business Engine -> **Environment** tab.
2. Scroll to the **Grafana** section.
3. Click the **Edit** button.
4. Provide Grafana instance URL.
5. Provide Service account token.

<Image
title="Connect a Business Engine to Grafana instance via Business Studio."
src="/img/blog/2025-02-05-big-2.4.0/token.png"
/>

With this user action, the `grafana_token` column of the `environments` table is updated. That means if multiple business engines are connected to the same Grafana instance (HA scenario), then with updating the settings only for one business engine, all others are automatically updated since they all point to the same database field.

:::info High Availability

If multiple Business Engines are connected to the same Grafana instance, then updating ONLY one Business Engine is required. The rest of the connected business engines will be updated automatically.

:::

## Improved the alert event details

:::info terminology
An alert event is an alternative term for an [alert record](/big/alerting/#alert-components). Technically, it is a record in a database about the alert event.
:::

### All alert rules

1. Open a Business Engine of your interest.
2. Open the **Overview** tab.
3. Review the **Alert history** of all alert records generated for the selected Business Engine.

<Image
title="Review all alert rules events in one listing."
src="/img/blog/2025-02-05-big-2.4.0/all-alerts.png"
/>

### One alert rule

1. Open a Business Engine of your interest.
2. Open the **Alert rules** tab.
3. Click on the alert rule of interest.
4. Review the **Alert history** of the selected alert rule.

<Image
title="Review one alert rule event history."
src="/img/blog/2025-02-05-big-2.4.0/one-alert.png"
/>

You can click on any alert record to review details. If the latest alert state (**New state**) is **Alerting**, the **Alert evaluations** section shows the values that triggered the alert action.

You can always review the payload by clicking on the **View as code** button.

<Image
title="Alert evaluations show the values that triggered the alert action. You can review the complete payload by clicking on the View as code button."
src="/img/blog/2025-02-05-big-2.4.0/alerting-state.png"
/>

In the case of any other alert state (**New state**), the alert rule payload is displayed right away.

<Image
title="Review the alert action payload in the Alert evaluation section for all other states but Alerting."
src="/img/blog/2025-02-05-big-2.4.0/other-states.png"
/>

## High availability (HA) state in the Business Engine overview

High availability can be:

- **Disabled**. If a Business Engine is the only one in the cluster.
- **Enabled**. If there are multiple (more than one) Business Engines in the cluster.

<Image
title="High availability state for a Business Engine."
src="/img/blog/2025-02-05-big-2.4.0/enabled-disabled.png"
/>

## Simplified schedule entry for creating alert rules

In addition to a Cron expression, for simplicity, you can choose one of the easy-to-use templates and then adjust if needed.

<Image
title="Simplified schedule entry for an alert rules creation."
src="/img/blog/2025-02-05-big-2.4.0/cron.png"
/>

## Review Grafana data frames in the Business Studio

To make the interaction between the Business Engine and Grafana more transparent, the Business Studio displays the Grafana data frames participating in the alert rule evaluation.

To review the Grafana data frame in the Business Studio:

1. Open the alert rule of interest.
2. Optionally, on the **Alert settings** tab confirm the alert rule is assigned to the dashboard(2.1) and panel(2.2) of interest.
3. Open the **Data preview** tab.
4. Optionally, verify the dashboard variable (data frame filter) is set up to the necessary value.
5. Review the Grafana data frame in the Business Studio.
6. Optionally, review the same data frame in Grafana. Open the panel in the Edit mode and switch to the **Table view**.

- Verify the dashboard variable (data frame filter) is set up to the necessary value.
- Review the data frame in Grafana.

<Image
title="Data preview tab to review Grafana data frames in the Business Studio."
src="/img/blog/2025-02-05-big-2.4.0/data-preview.png"
/>

A Grafana data frame can be reviewed as a code by clicking on the **View as code** button.

## Enchanced user prompts to improve configuration clarity.

This is done throughout the Business Studio UI to eliminate ambiguity and uncertainty about the parameters' meaning.

## Updated Business Engine API documentation.

We maintain the ease of the 3rd party Business Engine integration by timely updating the [OpenAPI specification](/big/api/).

## Business Studio Downloads

:::info Security risks

MacOS and Windows installers are signed and notarized with encryption. End to end build process are fully automated using GitHub workflows to avoid any security risks.

:::

- MacOS:
- [Apple Disk Image for arm64 (Apple Mx processor)](https://github.com/VolkovLabs/business-intelligence/releases/download/v2.4.0/Business.Studio-2.4.0-arm64.dmg)
- [Apple Disk Image for x86 (Intel)](https://github.com/VolkovLabs/business-intelligence/releases/download/v2.4.0/Business.Studio-2.4.0-x64.dmg)
- [ZIP file for arm64 (Apple Mx processor)](https://github.com/VolkovLabs/business-intelligence/releases/download/v2.4.0/Business.Studio-darwin-arm64-2.4.0.zip)
- [ZIP file for x86 (Intel)](https://github.com/VolkovLabs/business-intelligence/releases/download/v2.4.0/Business.Studio-darwin-x64-2.4.0.zip)
- Linux:
- [RPM for arm64](https://github.com/VolkovLabs/business-intelligence/releases/download/v2.4.0/business-studio-2.4.0-1.arm64.rpm)
- [RPM for x64](https://github.com/VolkovLabs/business-intelligence/releases/download/v2.4.0/business-studio-2.4.0-1.x86_64.rpm)
- [Debian for arm64](https://github.com/VolkovLabs/business-intelligence/releases/download/v2.4.0/business-studio_2.4.0_arm64.deb)
- [Debian for x86](https://github.com/VolkovLabs/business-intelligence/releases/download/v2.4.0/business-studio_2.4.0_amd64.deb)
- Windows
- [Executable](https://github.com/VolkovLabs/business-intelligence/releases/download/v2.4.0/Business.Studio-2.4.0.Setup.exe)

## Release Notes

:::warning Breaking Changes in Engine API

Updated data routes from /grafana to /grafana-data.

:::

### Business Studio 2.4.0

- Added Engine environment management to update Grafana connection details.
- Added alert event details to review conditions and view as a code to troubleshoot issues.
- Added verification process for backend query operations in panels.
- Added high availability state in engines overview.
- Added enhanced scheduler for alerts to streamline the setting of alert rules.
- Added alert data preview for reviewing data frames in Grafana.
- Updated user interface messages and forms to include more context and specifics.

### Business Engine 2.4.0

- Added API to update Grafana configuration in real-time.
- Added API to get alert event details.
- Added API to get high availability state.
- Added API to get alert data preview.
- Updated alert event structure for consistency.

<Feedback />
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/blog/2025-02-05-big-2.4.0/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/blog/2025-02-05-big-2.4.0/cron.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/blog/2025-02-05-big-2.4.0/token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d0deee4

Please sign in to comment.