Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mikhail-vl committed Jan 6, 2025
1 parent c3ee70e commit 759fd2a
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,18 @@ Revolutionize Your Business Insights with High-Performance, Scalable, and Alert-
- **User-Friendly Business Studio**: Simplifies management of Business Engines, allowing non-technical users to configure, monitor, and maintain data workflows.
- **Advanced Business Alerts**: Features alert systems based on Grafana panel queries, with support for customizable thresholds and variables, ensuring timely and relevant notifications for business metrics.

![Business Studio](https://raw.githubusercontent.com/VolkovLabs/business-intelligence/main/img/studio.png)
[![Business Studio](https://raw.githubusercontent.com/VolkovLabs/business-intelligence/main/img/studio.png)](https://volkovlabs.io/big/)

## Requirements

- Business Intelligence 2.X supports **Grafana 11**.

## Getting started

The Business Intelligence platform utilize Docker containers to be modular and scalable.

### Grafana

1. Start Grafana container

```
Expand All @@ -27,18 +31,28 @@ docker compose --profile grafana up -d

2. Create Service Account and update `GRAFANA_TOKEN` in the `.env` file

### Business Engine

3. Start the Business Engine, Timescale database, and Prometheus containers

```
docker compose --profile engine up -d
```

4. Start JSON Server to test Actions (optional)
4a. Start JSON Server to test Actions (optional)

```
docker compose --profile actions up -d
```

4b. Start Data emulator to test dashboard variables and threshold overrides (optional)

```
docker compose --profile emulator up -d
```

### Business Studio

5. Download and start the Business Studio from [Releases](https://github.com/VolkovLabs/business-intelligence/releases)

6. Configure Actions and Alert Rules
Expand All @@ -48,6 +62,8 @@ docker compose --profile actions up -d

![Engine Alerts](https://raw.githubusercontent.com/VolkovLabs/business-intelligence/main/img/overview.png)

### Prometheus

7. Check performance and Prometheus metrics using provisioned `Business Engine` dashboard

![Engine Alerts](https://raw.githubusercontent.com/VolkovLabs/business-intelligence/main/img/prometheus.png)
Expand All @@ -57,6 +73,7 @@ docker compose --profile actions up -d
```
docker compose --profile engine down
docker compose --profile actions down
docker compose --profile emulator down
docker compose --profile grafana down
```

Expand Down

0 comments on commit 759fd2a

Please sign in to comment.