Skip to content

Commit

Permalink
Update BI documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mikhail-vl committed Jan 14, 2025
1 parent 5fff20f commit 7fce4bf
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 8 deletions.
3 changes: 2 additions & 1 deletion big/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,12 @@ The Business Intelligence platform utilize Docker containers to be modular and s

The `docker-compose.yml` file consists of the following containers and can be used to start the platform:

- **Grafana** includes the provisioned dashboards and datasources.
- **Grafana** includes the provisioned dashboards and data sources.
- **Timescale** is required to store Business Engine configuration.
- **Business Engine** has a service account key to access Grafana HTTP APIs. It evaluates alert rules and calls actions when alert statuses change.
- **Prometheus** collects and store performance metrics from Business Engine.
- **JSON server** is an action example based on NodeJS, which accepts alert payload and saves it to the files for testing purposes.
- **Data Emulator** is a NodeJS scripts to populate data to Timescale database and demonstrate variables functionality.

<Code
url="https://github.com/VolkovLabs/business-intelligence/blob/main/docker-compose.yml"
Expand Down
24 changes: 17 additions & 7 deletions big/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,22 @@ This is how the idea of the Business Intelligence platform was born. With time,

The Grafana Business Intelligence platform consists of the following:

- Business Studio. It is your control panel. It features a user-friendly interface with an overview of the whole system. Users only need one Business Studio to work with the rest of the platform.
- Business Engine. One Business Engines serves one Grafana instance. It does all the heavy lifting and all the necessary computing for all setup tasks.
- Business Alerting. It is the first part of the Busines Engine that is available. It features alert systems based on Grafana panel queries, with support for customizable thresholds and variables, ensuring timely and relevant notifications for business metrics.
- Business Reporting. It is a Busines Engine part that is coming soon.
- More Business modules will be added after that. One of them is anomaly detection.
- Grafana is not part of the Business Intelligence. You can work with any Grafana instance type, such as OSS, Enterprise, or Cloud.
- Business Studio
- It is your control panel.
- Features a user-friendly interface with an overview of the whole system.
- Users only need one Business Studio to work with the rest of the platform.
- Business Engine
- One Business Engines serves one Grafana instance.
- Does all the heavy lifting and all the necessary computing for all setup tasks.
- Business Alerting
- It is the first part of the Busines Engine that is available.
- Features alert systems based on Grafana panel queries, with support for customizable thresholds and variables, ensuring timely and relevant notifications for business metrics.
- Business Reporting
- It is a Busines Engine part that is coming soon.
- More Business modules will be added
- One of them is anomaly detection.
- Grafana is not part of the Business Intelligence
- You can work with any Grafana instance type, such as OSS, Enterprise, or Cloud.

Such architecture allows users:

Expand All @@ -46,7 +56,7 @@ There is a possibility of facilitating all Grafana instances version control, ne

## Subscription

We offer the Business Intelligence as a subscription-based product, and a Community version is available.
We offer the Business Intelligence as a subscription-based product for Enterprise customers. Community version is available for small projects.

The community version is limited to 10 Business Alerts and a single cluster of Business Engines.

Expand Down

0 comments on commit 7fce4bf

Please sign in to comment.