Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 24 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
[![GitHub Actions](https://github.com/cube-js/cube/workflows/Build/badge.svg)](https://github.com/cube-js/cube/actions?query=workflow%3ABuild+branch%3Amaster)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcube-js%2Fcube.js.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fcube-js%2Fcube.js?ref=badge_shield)

__Cube Core is an open-source semantic layer.__ Cube Core can be used to build embedded analytics in your applications, create your own business intelligence tool or provide context about data to AI agents. Cube Core is headless and comes with multiple APIs for embedded analytics and BI: REST, GraphQL, and SQL.
__Cube Core is the open-source semantic layer.__ Define metrics, dimensions, joins, and access rules once in code, then expose them through SQL, REST, and GraphQL APIs to anything downstream — BI tools, custom applications, or AI agents. Cube Core is headless: it doesn't ship a UI, so you can build the analytics experience that fits your product.

If you are looking for a fully integrated platform, check out [Cube](https://cube.dev), a modern AI-first business intelligence platform. We use Cube Core to power it.
Cube Core works with all SQL data sources, including cloud data warehouses like Snowflake, Databricks, and BigQuery; query engines like Presto and Amazon Athena; and application databases like Postgres. It has a built-in relational caching engine to provide sub-second latency and high concurrency for API requests.

<img
src="https://lgo0ecceic.ucarecd.net/418db1f9-7597-4e00-8c10-eba19fcac20f/"
Expand All @@ -24,19 +24,17 @@ If you are looking for a fully integrated platform, check out [Cube](https://cub
<i>Learn more about connecting Cube to <a href="https://cube.dev/cube-core/getting-started/create-a-project?ref=github-readme" target="_blank">data sources</a> and <a href="https://cube.dev/docs/integrations?ref=github-readme" target="_blank">analytics & visualization tools</a>.</i>
</p>

Cube Core was designed to work with all SQL data sources, including cloud data warehouses like Snowflake, Databricks, and BigQuery; query engines like Presto and Amazon Athena; and application databases like Postgres. Cube Core has a built-in relational caching engine to provide sub-second latency and high concurrency for API requests.

## Why Cube Core?

Every business intelligence tool relies on a semantic layer as its core engine—a critical component that defines metrics, dimensions, and business logic while abstracting the complexity of underlying data sources. However, most semantic layers are proprietary, tightly coupled to specific BI platforms, and cannot be reused across different applications.
Every BI tool relies on a semantic layer as its core engine — the component that defines metrics, dimensions, and business logic and hides the complexity of the underlying data sources. Most semantic layers are proprietary, tightly coupled to a single BI platform, and can't be reused across other tools.

Cube Core is an open-source project that aims to create an open, modern semantic layer that can be used to power any analytics applications and AI agents. By decoupling the semantic layer from specific tools and making it accessible through standard APIs, Cube Core enables organizations to define their metrics once and use them everywhere—from BI tools to embedded analytics to AI agents.
Cube Core is an open, standalone semantic layer that any analytics application or AI agent can consume through standard APIs. Define your metrics once and use them everywhere — internal BI, embedded analytics, AI agents — without re-implementing the model in each place.

## Getting Started 🚀
## Getting Started

You can get started with Cube locally or self-host it with [Docker](https://www.docker.com/).
You can run Cube Core locally or self-host it with [Docker](https://www.docker.com/).

Once Docker is installed, in a new folder for your project, run the following command:
Once Docker is installed, in a new folder for your project, run:

```bash
docker run -p 4000:4000 \
Expand All @@ -46,15 +44,28 @@ docker run -p 4000:4000 \
cubejs/cube
```

Then, open http://localhost:4000 in your browser to continue setup.
Then open http://localhost:4000 in your browser to continue setup.

For a step-by-step guide, [see the docs](https://cube.dev/cube-core/getting-started/create-a-project?ref=github-readme).

### Cube — Complete Modern BI Tool from Cube Core Creators
## Cube Core vs. Cube

[Cube](https://cube.dev?ref=github-readme) is our commercial product — an agentic analytics platform built on Cube Core. Same semantic layer underneath, plus the rest of what makes it a full BI platform: Analytics Chat, workbooks and dashboards, embedded analytics surfaces, managed deployment, RBAC, multi-tenancy, and integrations with Tableau, Power BI, Excel, and Google Sheets.

The data model is fully compatible both ways: a model you build in Cube Core runs unchanged in Cube, and vice versa. Cube Core stays open-source and is what we run inside Cube ourselves.

- **Use Cube Core** when you want to own the stack — a custom BI experience, deeply integrated embedded analytics, or AI agents that need a governed semantic foundation.
- **Use Cube** when you want a managed, full-featured BI platform out of the box — internal analytics or customer-facing embedded analytics without building the surrounding platform yourself.

For more on how we think about the split, see [The Future of Cube Core and Cube](https://cube.dev/blog/cube-core-and-cube).

For a tour of what's in Cube today, watch the workshop:

[Cube](https://cube.dev?ref=github-readme) is a complete modern agentic analytics platform built on Cube Core. It provides a fully integrated solution with a user-friendly interface, advanced analytics capabilities, and managed infrastructure.
<a href="https://www.youtube.com/watch?v=7ZQGGepDjUQ" target="_blank">
<img src="https://img.youtube.com/vi/7ZQGGepDjUQ/maxresdefault.jpg" alt="Cube agentic analytics workshop on YouTube" width="600">
</a>

<a href="https://cubecloud.dev/auth/signup?ref=github-readme"><img src="https://cubedev-blog-images.s3.us-east-2.amazonaws.com/f1f1eac0-0b44-4c47-936e-33b5c06eedf0.png" alt="Get started now" width="200px"></a>
Or [try Cube for free](https://cubecloud.dev/auth/signup?ref=github-readme).

## Resources

Expand Down
18 changes: 5 additions & 13 deletions docs-mintlify/admin/account-billing/pricing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ of deployments within a Cube Cloud account. The consumption is measured in 5-min
| Cube Store Worker | <nobr>1..2</nobr> | Depends on a [chosen tier](#cube-store-worker-tiers) |
| [Semantic Catalog][ref-semantic-catalog] | <nobr>2..4</nobr> | Depends on a [chosen tier](#semantic-catalog-tiers) |
| [Query History][ref-query-history] | <nobr>0..20</nobr> | Depends on a [chosen tier](#query-history-tiers) |
| [Monitoring Integrations][ref-monitoring-integrations] | <nobr>1..4</nobr> | Depends on a [chosen tier](#monitoring-integrations-tiers) |
| [Monitoring Integrations][ref-monitoring-integrations] | | Available as an [add-on](#monitoring-integrations) on the Enterprise plan |

The following resource types incur CCU consumption and apply to the _whole Cube Cloud
account_:
Expand Down Expand Up @@ -169,18 +169,11 @@ features analyze and visualize the data available under the following tiers:
You can upgrade to a chosen tier in the
**Settings** of your deployment.

### Monitoring Integrations tiers
### Monitoring Integrations

[Monitoring Integrations][ref-monitoring-integrations] feature has the following tiers:

| Tier | CCUs per hour | Exported data | Dependent features |
| ---- | :-----------: | -------------- | --- |
| XS | 1 | Up to 10 GB/mo | — |
| S | 2 | Up to 25 GB/mo | — |
| M | 4 | Up to 50 GB/mo | [Query History export][ref-query-history-export] |

You can [upgrade][ref-monitoring-integrations-config] to a chosen tier in the
**Settings** of your deployment.
[Monitoring Integrations][ref-monitoring-integrations], including [Query History
export][ref-query-history-export], are available as an add-on on the Enterprise
plan. [Contact us][cube-contact-us] for pricing.

### Audit Log tiers

Expand Down Expand Up @@ -330,7 +323,6 @@ for the AI token consumption at the **Billing** page of their Cube Cloud account
[ref-cloud-deployment-prod-cluster]: /docs/deployment/cloud/deployment-types#dedicated
[ref-cloud-limits]: /docs/deployment/cloud/limits
[ref-monitoring-integrations]: /docs/monitoring/integrations
[ref-monitoring-integrations-config]: /admin/deployment/monitoring-integrations#configuration
[ref-cloud-acl]: /admin/users-and-permissions/custom-roles
[ref-cloud-deployment-prod-multicluster]: /docs/deployment/cloud/deployment-types#multi-cluster
[ref-cloud-custom-domains]: /docs/deployment/cloud/custom-domains
Expand Down
9 changes: 4 additions & 5 deletions docs-mintlify/admin/deployment/limits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ types][ref-deployment-types] and [product tiers][ref-pricing]:
| [Query History][ref-query-history] — queries processed per day for each deployment | 1,000 | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] |
| [Audit Log][ref-audit-log] — retention period | — | — | — | 30 days |
| [Audit Log][ref-audit-log] — events collected | — | — | — | 10,000 |
| [Monitoring Integrations][ref-monitoring-integrations] — exported data | — | Depends on the [tier][ref-monitoring-integrations-tiers] | Depends on the [tier][ref-monitoring-integrations-tiers] | Depends on the [tier][ref-monitoring-integrations-tiers] |
| [Monitoring Integrations][ref-monitoring-integrations] — exported data | — | — | — | Available as an [add-on][ref-monitoring-integrations] |

### Number of deployments

Expand Down Expand Up @@ -82,8 +82,8 @@ support][cube-contact-us] for further assistance.

### Data exported via Monitoring Integrations

This is a hard limit. Consider upgrading to the next [Monitoring Integrations tier][ref-monitoring-integrations-tiers].
Usage is calculated per Cube Cloud deployment.
This is a hard limit. Usage is calculated per Cube Cloud deployment. [Contact
support][cube-contact-us] for higher quotas.

## Quotas

Expand All @@ -105,5 +105,4 @@ response.
[ref-prod-cluster]: /docs/deployment/cloud/deployment-types#dedicated
[cube-contact-us]: https://cube.dev/contact
[ref-query-history-tiers]: /admin/account-billing/pricing#query-history-tiers
[ref-audit-log]: /admin/monitoring/audit-log
[ref-monitoring-integrations-tiers]: /admin/account-billing/pricing#monitoring-integrations-tiers
[ref-audit-log]: /admin/monitoring/audit-log
35 changes: 18 additions & 17 deletions docs-mintlify/admin/monitoring/monitoring-integrations/index.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,15 @@
---
title: Strategy, credentials, etc.
title: Overview
description: Export Cube Cloud logs and metrics to external monitoring tools like Datadog, Grafana Cloud, and New Relic.
---

Monitoring Integrations

Cube Cloud allows exporting logs and metrics to external monitoring tools so you
can leverage your existing monitoring stack and retain logs and metrics for the
long term.

<Note>

Available on [Enterprise plan](https://cube.dev/pricing).
You can also choose a [Monitoring Integrations tier](/admin/account-billing/pricing#monitoring-integrations-tiers).
Available as an add-on on the [Enterprise plan](https://cube.dev/pricing).

</Note>

Expand Down Expand Up @@ -47,25 +44,29 @@ destinations][vector-docs-sinks], also known as _sinks_.
Monitoring integrations work with various popular monitoring tools. Check the
following guides and configuration examples to get tool-specific instructions:

<CardGroup cols={2}>
<Card title="Amazon CloudWatch" img="https://static.cube.dev/icons/aws.svg" href="/admin/monitoring/monitoring-integrations/cloudwatch">
<CardGroup cols={3}>
<Card title="Amazon CloudWatch" href="/admin/monitoring/monitoring-integrations/cloudwatch">
Export logs and metrics to Amazon CloudWatch.
</Card>
<Card title="Amazon S3" img="https://static.cube.dev/icons/aws.svg" href="/admin/monitoring/monitoring-integrations/s3">
<Card title="Amazon S3" href="/admin/monitoring/monitoring-integrations/s3">
Archive logs to an Amazon S3 bucket.
</Card>
<Card title="Datadog" img="https://static.cube.dev/icons/datadog.svg" href="/admin/monitoring/monitoring-integrations/datadog">
<Card title="Datadog" href="/admin/monitoring/monitoring-integrations/datadog">
Export logs and metrics to Datadog.
</Card>
<Card title="Grafana Cloud" img="https://static.cube.dev/icons/grafana.svg" href="/admin/monitoring/monitoring-integrations/grafana-cloud">
<Card title="Grafana Cloud" href="/admin/monitoring/monitoring-integrations/grafana-cloud">
Export logs and metrics to Grafana Cloud.
</Card>
<Card title="New Relic" img="https://static.cube.dev/icons/new-relic.svg" href="/admin/monitoring/monitoring-integrations/new-relic">
<Card title="New Relic" href="/admin/monitoring/monitoring-integrations/new-relic">
Export logs and metrics to New Relic.
</Card>
</CardGroup>

## Configuration

To enable monitoring integrations, navigate to **Settings → Monitoring
Integrations** and click **Enable Vector** to add a Vector agent to
your deployment. You can use the dropdown to select a [Monitoring Integrations
tier](/admin/account-billing/pricing#monitoring-integrations-tiers).
your deployment.

<Frame>
<img src="https://ucarecdn.com/bf05182f-bbb0-4c20-a95e-ca7aeb03829e/" />
Expand Down Expand Up @@ -283,12 +284,12 @@ external monitoring solution for further analysis, for example:
* Set up alerts for queries that exceed a certain duration.
* Attribute usage to specific users and implement chargebacks.

<Info>
<Note>

Requires the [M tier](/admin/account-billing/pricing#monitoring-integrations-tiers)
of Monitoring Integrations.
Query History export is part of the Monitoring Integrations add-on,
available on the [Enterprise plan](https://cube.dev/pricing).

</Info>
</Note>

<iframe
width="100%"
Expand Down
1 change: 1 addition & 0 deletions docs-mintlify/admin/monitoring/query-history-export.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Analyzing data from Query History export
sidebarTitle: Query History export
description: Walk through exporting Query History to Amazon S3 with Vector and analyzing the files with DuckDB inside Cube.
---

Expand Down
Loading
Loading