-
Notifications
You must be signed in to change notification settings - Fork 125
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* small nit fixes to docs * Reworking Manage Section and small fixes * more nit changes, start rewrite of metric-view.md * fixing metrics-view to metrics view * fixing UI to Rill Cloud where appropriate * fixed linkes * small fixes * metrics view + small changes * small fixes and media addition to manage * Update _category_.yml * updating OLAP img
- Loading branch information
Showing
31 changed files
with
361 additions
and
304 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1,34 @@ | ||
--- | ||
title: "What is a Metrics View?" | ||
title: "What is a Metrics Layer?" | ||
sidebar_label: "What is a Metrics View?" | ||
sidebar_position: 11 | ||
hide_table_of_contents: true | ||
--- | ||
|
||
What is a metrics layer, and why did we decide to split the dashboard into two individual components? | ||
|
||
|
||
## What is a Metrics Layer? | ||
|
||
A metrics layer is a `centralized framework` used to define and organize **key metrics** for your organization. Having a centralized layer allows an organization to easily manage and re-use calculations across various reports, dashboard, and data tools. As Rill continues to grow, we decided to separate metrics layer from the dashboard configuration. | ||
|
||
|
||
### Historically, in Rill... | ||
<img src = '/img/concepts/metrics-view/old-dashboard.png' class='rounded-gif' /> | ||
<br /> | ||
|
||
Historically in Rill, the metrics layer and dashboard configuration were a single file. As seen above, the metrics would be defined **inside** a dashboard YAML file along with the dashboard components and dashboard customizations. However, as we continue to create more features, we found that this was not the best approach. In order to create a metrics layer in Rill as a first class resource and not a consequence of dashboards, we found it necessary to split the two resources into their own files. Thus, the metrics-view was born. | ||
|
||
:::tip | ||
Starting from version 0.50, the operation of creating a dashboard via AI will create a metrics-view and dashboard separately in their own respective folders and navigate you to a preview of your dashboard. If you find that some of the metrics need to be modified, you will need to navigate to your [metrics/model_name_metrics.yaml](/build/metrics-view/) file. | ||
Starting from version 0.50, the operation of creating a dashboard via AI will create a metrics view and dashboard separately in their own respective folders and navigate you to a preview of your dashboard. If you find that some of the metrics need to be modified, you will need to navigate to your [metrics/model_name_metrics.yaml](/build/metrics-view/) file. | ||
|
||
|
||
Assuming that you have the ' * ', select all, in your dashboard configurations, any changes will automatically be changed on your [explore dashboard](/build/dashboards/). | ||
::: | ||
|
||
## Splitting the Dashboard into two components, Metrics-view and Dashboard Configuration | ||
Splitting the metrics view into its own component allows us more freedom to continue building Rill and adding new additional features. Instead of querying a dashboard for data, we would be querying the metrics-layer. The dashboard will directly query the metrics-view along with many new components that are currently being developed. | ||
|
||
### New Metrics View as an independent object in Rill | ||
## Introducing Metrics View | ||
Within Rill, we refer to Metrics layers as a metrics view. It's a single view or file that contains all of your measures and dimensions that will be used to display the data in various ways. The metrics view also contains some configurations settings that are required to ensure that the data being displayed is as accurate as you need. | ||
|
||
![img](/img/concepts/metrics-view/metrics-view-components.png) | ||
|
||
### (Explore) Dashboard | ||
![img](/img/tutorials/102/new-viz-editor.png) | ||
|
||
With the split of metrics view, dashboard configurations experienced an overhaul. Instead of defining measure and dimensions, you will now reference the object into your dashboard. What this allows is creating customized dashboards for specific viewers and reusability of a single metrics-view in multiple dashboards! | ||
:::tip | ||
It is possible to develop the metrics layer in a traditional BI-as-code manner as well as via the UI. To switch between the two, select the toggle in the top right corner. | ||
::: | ||
|
||
![img](/img/concepts/metrics-view/explore-dashboard.png) | ||
## Interfacing with a Metrics view | ||
|
||
For more information on what is changed, please review the [migrations](/manage/migration) and the [reference page](/reference/project-files/explore-dashboards). | ||
A metrics view on its own does not have any visualization capabilities. Instead, the metrics view is the building block for all of the visualization and components within Rill. Please see below for the currently available and soon to be released features of Rill! | ||
|
||
## More to come! | ||
![img](/img/concepts/metrics-view/metrics-view-components.png) | ||
|
||
New features are being developed as we speak! If you're curious, feel free to [contact us](/contact)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
position: 90 | ||
label: Changes | ||
collapsible: false | ||
collapsed: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,146 @@ | ||
--- | ||
title: "Dashboard split into two components" | ||
description: For documenting required migrations | ||
sidebar_label: "Changes to Dashboards" | ||
sidebar_position: 60 | ||
--- | ||
As we continue to develope more features within Rill, it became clear that we needed to separate the dashboard into two components. | ||
1. Metrics view | ||
2. Dashboard configuration | ||
|
||
### Historically, in Rill... | ||
<img src = '/img/concepts/metrics-view/old-dashboard.png' class='rounded-gif' /> | ||
<br /> | ||
|
||
Historically in Rill, the metrics layer and dashboard configuration were a single file. As seen above, the metrics would be defined **inside** a dashboard YAML file along with the dashboard components and dashboard customizations. We found that this was not the best approach as we continued developement. In order to create a metrics layer in Rill as a first class resource and not a consequence of dashboards, we found it necessary to split the two resources into their own files. Thus, the metrics view was born. | ||
|
||
## Splitting the Dashboard into two components, Metrics view and Dashboard Configuration | ||
Splitting the metrics view into its own component allows us more freedom to continue building Rill and adding new additional features. Instead of querying a dashboard for data, we would be querying the metrics-layer. The dashboard will directly query the metrics view along with many new components that are currently being developed. | ||
|
||
### New Metrics View as an independent object in Rill | ||
|
||
![img](/img/concepts/metrics-view/metrics-view-components.png) | ||
|
||
### (Explore) Dashboard | ||
|
||
With the split of metrics view, dashboard configurations experienced an overhaul. Instead of defining measure and dimensions, you will now reference the object into your dashboard. What this allows is creating customized dashboards for specific viewers and reusability of a single metrics view in multiple dashboards! | ||
|
||
![img](/img/concepts/metrics-view/explore-dashboard.png) | ||
|
||
## How to migrate your current Dashboards | ||
|
||
### version 0.49 -> version 0.50 | ||
|
||
Due to the [separation of dashboards to metrics layer and dashboards](/concepts/metrics-layer), you will need to review your current dashboards and make the following changes (note: Legacy dashboards will continue to function.): | ||
|
||
**[Sample Legacy Dashboard Contents](https://docs.rilldata.com/reference/project-files/explore-dashboards):** | ||
|
||
```yaml | ||
title: #defined on metrics view and dashboard | ||
model: #defined on metrics view | ||
type: #defined on both, explore or metrics view | ||
timeseries: #defined on metrics view | ||
|
||
smallest_time_grain: #defined in metrics view, | ||
|
||
default_dimensions: #separate default | ||
default_measures: #values defined in | ||
default_comparisons: #dashboard config | ||
... | ||
|
||
|
||
|
||
measures: #defined in metrics view, | ||
... | ||
|
||
dimensions: #defined in metrics view, | ||
... | ||
|
||
security: #defined on both metrics view and dashboard but different capabilities | ||
... | ||
|
||
theme: #defined in dashboard | ||
|
||
available_time_zones: #defined in dashboard as time_zones: | ||
available_time_ranges: #defined in dashboard as time_ranges: | ||
|
||
first_day_of_week: #defined in metrics view, | ||
first_month_of_year: #defined in metrics view, | ||
|
||
``` | ||
--- | ||
**[Metrics View YAML](/reference/project-files/metrics-view):** | ||
Please check the reference for the required parameters for a metrics view. | ||
```yaml | ||
version: 1 #defines version | ||
type: metrics_view # metrics_view | ||
|
||
title: The title of your metrics_view | ||
display_name: The display_name | ||
description: A description | ||
model / table: reference to the model or table, | ||
database / database_schema: #if using a different OLAP engine, refers to database and schema (usually not required) | ||
|
||
timeseries: your timeseries column | ||
|
||
smallest_time_grain: #defines the smallest time grain | ||
|
||
first_day_of_week: #defines first day of week | ||
first_month_of_year: #defines first month of year | ||
|
||
dimensions: #your dimensions, can be copied from dashboard.yaml | ||
- name: | ||
label: | ||
column/expression: | ||
property: | ||
description: | ||
unnest: | ||
uri: | ||
|
||
measures: #your measures, can be copied from dashboard.yaml | ||
- name: | ||
label: | ||
type: | ||
expressions: | ||
window: | ||
per: | ||
requires: | ||
description: | ||
format_preset / format_d3: | ||
valid_percent_of_total: | ||
|
||
security: #your security policies can be copied from dashboard.yaml | ||
``` | ||
**[Explore dashboard YAML](/reference/project-files/explore-dashboards):** | ||
Please check the reference for the required parameters for an explore dashboard. | ||
```yaml | ||
type: explore | ||
|
||
title: Title of your explore dashboard | ||
description: a description | ||
metrics_view: <your-metric-view-file-name> | ||
|
||
dimensions: '*' #can use regex | ||
measures: '*' #can use regex | ||
|
||
theme: #your default theme | ||
|
||
time_ranges: #was available_time_ranges | ||
time_zones: #was available_time_zones | ||
|
||
defaults: #define all the defaults within here | ||
dimensions: | ||
measures: | ||
time_range: | ||
comparison_mode: | ||
comparison_dimension: | ||
|
||
security: | ||
access: #only access can be set on dashboard level, see metric view for detailed access policy | ||
``` | ||
For any questions, please [contact the team](https://docs.rilldata.com/contact) via Slack, email, Discord or the in-app chat! |
Oops, something went wrong.