Skip to content
Snippets Groups Projects
Unverified Commit ab6a473b authored by Jeff Bruemmer's avatar Jeff Bruemmer Committed by GitHub
Browse files

docs - updates to auditing, landing page, and more (#18266)

parent 3d7a1c53
Branches
Tags
No related merge requests found
## Getting Help
# Metabase documentation and resources
### [Troubleshooting Guide](troubleshooting-guide/index.md)
## Tutorials
### [Learn Metabase][learn]
Learn how to set Metabase up, build out your analytics, organize things and set permissions, and how to do data ops right.
## Getting help
### [Troubleshooting Guide][troubleshooting]
Problems, their causes, how to detect them, and how to fix them.
### [FAQs](faq/start.md)
### [Metabase forum][forum]
A place to get help on installation, setting up as well as sharing tips and tricks.
### [FAQs][faq]
Frequently asked questions about Metabase.
## Metabase guides
## Metabase reference guides
### [Users Guide](users-guide/start.md)
Documentation guides for the Metabase application.
### [Users Guide][users-guide]
How to ask questions, how to visualize answers, as well as how to share questions and create dashboards.
### [Admin Guide](administration-guide/start.md)
### [Admin Guide][admin-guide]
How to set up Metabase, configure common settings, manage accounts and permissions, and add databases.
### [Operations Guide](operations-guide/start.md)
### [Operations Guide][operations-guide]
Learn how to install Metabase for production use. The guide covers topics like SSL termination, deploying via Docker Containers vs. JAR files, as well as the tradeoffs involved.
### [Enterprise Guide](./enterprise-guide/start.md)
### [Enterprise Guide][enterprise]
Here’s where to go for help using the features included in [Metabase Enterprise Edition](https://www.metabase.com/enterprise/).
Here’s where to go for help using the features included in [Metabase Enterprise Edition][enterprise-landing].
## For developers
## Metabase for developers
### [Developers Guide](developers-guide/start.md)
### [Developers Guide][developers]
Learn how to contribute to the Metabase open source project.
Learn how to contribute to the Metabase open source project.
### [Driver Development](developers-guide-drivers.md)
### [Driver Development][drivers]
This guide lists existing community drivers, and shows how to get started with driver development.
### [Embedding reference apps][embedding-ref-apps]
Code examples for embedding Metabase in applications.
## Metabase community
Connect with others using Metabase and catch up on the latest news.
### [Metabase forum][forum]
A place to get help on installation, setting up as well as sharing tips and tricks.
### [Data stories][data-stories]
Real stories about teams working and learning with data. You can also share your own stories.
### [Case studies][case-studies]
See how other organizations, big and small, have leveled up using Metabase.
### [Blog][blog]
Stay up to date on the latest from Metabase.
### [Source code repository on GitHub][source-code]
Metabase is open source: come on over and check out the code.
## Reference
### [Anonymous Information Collection Reference](information-collection.md)
### [Anonymous Information Collection Reference][info-collection]
This page describes the anonymous usage information we collect (only if you opt-in), why we collect it, and how we use it to improve Metabase.
[admin-guide]: administration-guide/start.md
[blog]: /blog
[case-studies]: https://www.metabase.com/case_studies/
[embedding-ref-apps]: https://github.com/metabase/embedding-reference-apps
[enterprise]: enterprise-guide/start.md
[enterprise-landing]: /enterprise
[data-stories]: /community
[developers]: developers-guide/start.md
[drivers]: developers-guide-drivers.md
[faq]: faq/start.md
[forum]: https://discourse.metabase.com/
[info-collection]: information-collection.md
[learn]: /learn
[operations-guide]: operations-guide/start.md
[source-code]: https://github.com/metabase/metabase
[troubleshooting]: troubleshooting-guide/index.md
[users-guide]: users-guide/start.md
......@@ -36,6 +36,12 @@ Right now, the only special role someone can have is Admin. The only difference
To make someone an admin, click on the Groups dropdown and click the check mark next to the Administrators group.
### Unsubscribe from all subscriptions / alerts
This action will delete any dashboard subscriptions or alerts the person has created, and remove them as a recipient from any other subscriptions or alerts.
This action doesn't affect email distribution lists that are managed outside of Metabase.
### Adding people to Groups
Adding people to groups allows you to assign [data access](05-setting-permissions.md) and [collection permissions](06-collections.md) to them. To add someone to one or more groups, just click the Groups dropdown and click the checkboxes next to the group(s) you want to add the person to.
......
## Audit Logs
# Audit Logs
As an administrator of Metabase, you already know the importance of using data to understand your users. With the Audit tool, you can use Metabase to understand your Metabase users' usage. It's, well, meta!
As an administrator of Metabase, you already know the importance of using data to understand your how people interact with your products or services. With the Audit tool, you can use Metabase to understand how people in your organization use Metabase. It's, well, meta!
Access the tool by clicking the gear icon in the upper right and then clicking Audit in the top navigation. There's a lot of data available, not only about your people, but also about your questions, dashboards, databases and more! We'll walk you through each of the sections below.
Access the tool by clicking the gear icon in the upper right and then clicking __Audit__ in the top navigation. There's a lot of data available, not only about your people, but also about your questions, dashboards, databases and more! We'll walk you through each of the sections below.
### People
## People
Use the People section to gain a better understanding of how your end-users are interacting with Metabase. You'll want to pay attention to the Overview tab, especially when you first launch Metabase at your organization — it will give you data around how many active and newly created users you have each day. Further down the page, you'll see charts showing you which of your users are most engaged. Use these charts to find your power users!
### Team members
![Team Members](./images/audit-team.png)
Use the __People__ section to gain a better understanding of how people are interacting with Metabase. You'll want to pay attention to the __Overview__ tab, especially when you first launch Metabase at your organization — it will give you data around how many active and newly created accounts you have each day. Further down the page, you'll see charts showing you which people are most engaged.
The Team Members panel has a view of other options for viewing your team's usage data. The All Members tab will give you a list of your team members, and stats about their activity, such as when they were last active.
![Team Members](./images/audit-team.png)
The Audit Log tab will display, in chronological order, each query, who viewed it, and when. Note that if the user did not save their query, its name will be listed as `Ad-hoc`. Each query name can be clicked to view more details about your users' interactions with it, including a full revision history. You will also be able to view the query in Metabase. Note that this link will always show the latest version of the query - use the revision history to see changes over time.
The __Team Members__ panel has a view of other options for viewing your team's usage data. The __All Members__ tab will give you a list of your team members, and stats about their activity, such as when they were last active.
#### Drilling In
The __Audit Log__ tab will display, in chronological order, each query, who viewed it, and when. Note that if the person didn't save their query, its name will be listed as `Ad-hoc`. Each query name can be clicked to view more details about the person's interactions with it, including a full revision history. You'll also be able to view the query in Metabase. Note that this link will always show the latest version of the query - use the revision history to see changes over time.
Throughout the People section, names can be clicked to access the profile of a specific user’s activity. This profile includes:
Throughout the People section, names can be clicked to access the profile of a specific person’s activity. This profile includes:
- Dashboard views
- Query views
- Downloads
- Subscriptions & Alerts
![Team Members](./images/audit-teammember.png)
### Data
## Data
The Data section focuses on your databases, schemas and tables, and is divided into corresponding sections. Look here if you're trying to uncover queries and schemas that need optimization. Each section provides visualizations around the use and speed of querying against your databases, schemas or tables. You will also be able to view lists of stats about all of your databases, schemas and tables.
![Data](./images/audit-data.png)
### Items
## Items
The Items section focuses on questions, dashboards and downloads, and is divided into corresponding sections. Use these pages to gain a better understanding of what your users are interacting with.
The __Items__ section focuses on questions, dashboards, downloads, and Subscriptions and Alerts.
#### Questions
### Questions
The Questions section will show you your most popular queries, as well as your slowest queries. If queries you think are important aren't appearing on your most popular queries list, you may want to make sure your team is focusing on the right things.
......@@ -53,22 +54,47 @@ A list of all of your questions is available as well, and you can see various da
- Collection
- Public Link
#### Drilling In
You can also click on any question to drill into a more detailed profile showing:
- View activity
- Revision History
- A full audit log of who viewed the question, and when
#### Dashboards
### Dashboards
The Dashboards section is another great way to understand what your users who are dashboard-focused are looking at, and to make sure they're having a smooth experience. If you notice that a popular dashboard has a high average question loading time, you can investigate further using the Questions section outlined above.
The __Dashboards__ section helps you understand what dashboards people are looking at, and to make sure they're having a smooth experience. If you notice that a popular dashboard has a high average question loading time, you can investigate further using the Questions section outlined above.
![Items](./images/audit-dashboards.png)
A list of all of your dashboards is available as well, and you can see various data points about each dashboard at a glance, such as number of views and average question execution time.
A list of all of your dashboards is available as well, and you can see various data points about each dashboard at a glance, such as:
- Number of views
- Average question execution time(ms)
- Number of cards
- Saved by
- Cache duration
- Public link
- Saved on
- Last edited on
### Downloads
Use the __Downloads__ section to understand which people are downloading (or exporting) data, and the size (number of rows) of the downloads they're performing. This section contains some visualizations, as well as a list of all downloads.
### Subscriptions & Alerts
Here Admins can get an overview of all of the [Dashboard subscriptions][dashboard-subscriptions] and [Alerts][alerts] that are currently active for that Metabase.
- Dashboard name (or Question name for Alerts)
- Recipients
- Type (e.g., email or Slack)
- Collection
- Frequency
- Created By
- Created At
- Filters
#### Downloads
Admins can add and remove people from a subscription or alert by clicking on the item's __Recipients__. Admins can also delete the subscription or alert entirely by clicking on the **X** on the relevant line.
Use the Downloads section to understand which of your users are downloading (or exporting) data and the size (number of rows) of the downloads they're performing. This section contains some visualizations, as well as a list of all downloads.
[alerts]: ../users-guide/15-alerts.md
[dashboard-subscriptions]: ../users-guide/dashboard-subscriptions.md
\ No newline at end of file
......@@ -73,7 +73,7 @@ For quick answers to common questions, check out our [Frequently Asked Questions
Metabase adds new features and squashes bugs with each release. [Upgrading to the latest and greatest][upgrade] may resolve your issue. If you're using [Metabase Cloud][cloud], we'll handle the upgrades for you. You can checkout the [release notes][releases] to see what's new.
[appdb]: ./application-database.html
[appdb]: ./loading-from-h2.html
[bugs]: ./bugs.html
[cant-see-tables]: ./cant-see-tables.html
[chrome]: https://developers.google.com/web/tools/chrome-devtools/open#console
......
......@@ -46,9 +46,9 @@ To make a dashboard or pulse, click the plus (+) icon in the top-right of the ma
### Use search to quickly find things
![Search results](images/sharing-answers/search-results.gif)
![Search results](images/basic-exploration/search-results.gif)
The search bar at the top of the screen helps you find tables, dashboards, collections, saved questions, metrics, segments, and pulses in an instant.
The search bar at the top of the screen helps you find tables, dashboards, collections, saved questions, metrics, segments, and pulses in an instant.
## A primer on databases
......
## Dashboards
# Dashboards
![Interactive dashboard](images/dashboards/interactive-dashboard.png)
......@@ -9,7 +9,7 @@ Quick links:
- [Make your dashboards interactive](interactive-dashboards.md)
- [Learn how to build great dashboards](https://www.metabase.com/learn/dashboards/index.html)
### What is a dashboard?
## What is a dashboard?
**Dashboards** group questions and present them on a single page. You can think of dashboards as shareable reports that feature a set of related questions. You can set up [subscriptions to dashboards](dashboard-subscriptions.md) via email or Slack to receive the exported results of the dashboard's questions.
......@@ -19,15 +19,15 @@ You can add [filter widgets to dashboards](08-dashboard-filters.md) that filter
You can make as many dashboards as you want. Go nuts.
### How to create a dashboard
## How to create a dashboard
In the top right of the screen, click the **+** icon to open the **Create** menu, and select **New Dashboard**. Give your new dashboard a name and a description, choose which [collection](06-sharing-answers.md#collections) the dashboard should go in, then click **Create**, and Metabase will take you to your shiny new dashboard.
In the top right of the screen, click the **+** icon to open the **Create** menu, and select **New Dashboard**. Give your new dashboard a name and a description, choose which [collections](collections.md) the dashboard should go in, then click **Create**, and Metabase will take you to your shiny new dashboard.
![Create Dashboard](images/dashboards/DashboardCreate.png)
If you don't want to build a dashboard from scratch, or want to experiment by making changes to an existing dashboard without affecting the original, you can **duplicate** an existing dashboard. From an existing dashboard, click on the **...** menu in the upper right, and select **Duplicate**.
### Adding saved questions to a dashboard
## Adding saved questions to a dashboard
There are two ways to add questions to a dashboard: from the dashboard, or from the question you want to add.
......@@ -39,7 +39,7 @@ Once you add a question to your dashboard, it’ll look something like this:
![First Dashboard](images/dashboards/FirstDashboard.png)
### Adding headings or descriptions with text cards
## Adding headings or descriptions with text cards
Another neat thing you can do is add text cards to your dashboards. Text cards allow you to include descriptions, explanations, notes, or even images and GIFs to your dashboards. You can also use text cards to create separations between sections of charts in your dashboards, or include links to other dashboards, questions, or websites.
......@@ -61,7 +61,7 @@ Click the **eye** icon to see what your formatted Markdown will look like when y
To learn more, see [Fun with Markdown in your dashboards](https://www.metabase.com/blog/markdown-in-dashboards/index.html).
### Arranging cards
## Arranging cards
Each question on a dashboard is in its own card that you can move around or resize as you see fit. Just click the **pencil** icon in the top right of a dashboard to enter the dashboard's editing interface.
......@@ -75,13 +75,13 @@ Once you're in edit mode, you'll see a grid appear. You can move and resize the
Metabase will automatically update a question's display to make sure your data looks great at any size you choose.
### Changing a question's visualization settings
## Changing a question's visualization settings
You can change a question's visualization settings on a dashboard (to add a goal line, for example,) without affecting the original question. Click on the **pencil** icon to enter dashboard edit mode, hover over the question you want to edit, and click on the palette icon to edit the question's visualization's settings.
![Visualization settings](images/dashboards/visualization-settings.png).
### Finding dashboards
## Finding dashboards
You can search for any dashboard (or question, collection, or pulse) by its title in the big search box at the top of Metabase.
......@@ -89,7 +89,7 @@ After a while, your team might accumulate a lot of dashboards. To make it easier
![Pinning a dashboard in a collection](images/dashboards/pinning-dashboard.png)
### Fullscreen dashboards
## Fullscreen dashboards
After you've made your ideal dashboard, you may want to put the dashboard on a TV to help keep your team up to date throughout the day.
......@@ -99,7 +99,7 @@ Once you've entered fullscreen mode, you can also switch the dashboard into "Nig
![Night mode](images/dashboards/DashboardNightMode.png)
### Auto refresh
## Auto refresh
If your data updates frequently, you can set up your dashboard to refresh automatically by clicking on the **clock** icon.
......@@ -111,6 +111,14 @@ Enabling auto refresh will re-run all the queries on the dashboard at the interv
Combining fullscreen mode and auto refresh is a great way to keep your team in sync with your data throughout the day.
## Caching dashboards
{% include plans-blockquote.html %}
If your results don't change frequently, you may want to cache your results, that is: store your results in Metabase so that the next time you visit the dashboard, Metabase can retrieve the stored results rather than query the database(s) again. For example, if your data only updates once a day, there's no point in querying the database more than once a day, as they data won't have changed. Returning cached results can be significantly faster, as the database won't have to redo the work to answer your query.
You can set cache duration for a dashboard by clicking on the _..._ > __Edit dashboard details__ > __More options__.
## Sharing dashboards with public links
If your Metabase administrator has enabled [public sharing](../administration-guide/12-public-links.md) on a saved question or dashboard, you can go to that question or dashboard and click on the **sharing** icon to find its public links.
......@@ -119,7 +127,7 @@ If your Metabase administrator has enabled [public sharing](../administration-gu
Public links can be viewed by anyone, even if they don't have access to Metabase. You can also use the public embedding code to embed your question or dashboard in a simple web page or blog post. Check out examples of simple apps with embedded dashboards in our [embedding-reference-apps repository](https://github.com/metabase/embedding-reference-apps). To learn more about [embedding](../administration-guide/13-embedding.md), check out our article on [How to use Metabase to deliver analytics to your customers](https://www.metabase.com/blog/external-facing-analytics/index.html), as well as an article on how to combine branding, Single Sign-On, full app embedding, and data sandboxing to deliver [multi-tenant, self-service analytics](https://www.metabase.com/blog/embedding/index.html).
### Configuring a dashboard through its URL
## Configuring a dashboard through its URL
You can amend the URL of a dashboard to automatically enter fullscreen, enable night mode, or auto-refresh the dashboard. Customizing the dashboard's URL allows you to configure the dashboard - even when you do not have any input access to the device where the dashboard will be displayed, like scripted screens, for example.
......@@ -131,10 +139,10 @@ The part that says `refresh=60` sets the dashboard to automatically refresh ever
There is one important limitation with the `fullscreen` option: for security reasons, many browsers require user interaction to initiate fullscreen. In those browsers, using the `fullscreen` option will enable the fullscreen UI in Metabase, but it won't expand the browser content to fill the screen. To ensure the dashboard occupies the entire screen, either activate fullscreen by clicking the button in the UI, or use the `fullscreen` URL option and launch the browser in fullscreen or kiosk mode.
### Archiving a dashboard
## Archiving a dashboard
Archiving a dashboard removes the dashboard from searches and collections. Archiving a dashboard does not archive the individual saved questions on it — it just archives the dashboard.
To archive a dashboard, click the **pencil** icon to enter edit mode, then click the **...** menu, and select **Archive**.
To view all archived items, click the **menu** icon in the top-right of any collection page. You can **unarchive** a dashboard by clicking the icon of the box with the upward arrow next to that dashboard.
......@@ -145,7 +153,7 @@ To make a great dashboard, you first need to decide what you want the dashboard
Some tips:
- **Emphasize the most important questions**. To draw people’s attention to what matters most, place the most important saved question cards near the top of the dashboard, and/or make them bigger than the other cards,
- **Emphasize the most important questions**. To draw people’s attention to what matters most, place the most important saved question cards near the top of the dashboard, and/or make them bigger than the other cards,
- **Keep dashboards focused**. If you have more than 10 cards on a dashboard, think about breaking the dashboard into two separate ones. You don't want to overwhelm people with too much information, and each dashboard should revolve around one theme or topic. Remember — you can make as many dashboards as you want, so you don’t have to cram everything into just one.
- **Add filters to your dashboard**. [Adding filters](08-dashboard-filters.md) to dashboards makes them more useful. For example, instead of your dashboard being full of questions that are restricted to a specific time span, you can make more general questions and use dashboard filters to change the time span you're looking at.
- **Make your dashboards interactive.** [Customize what happens when users click on a chart or table in your dashboard](interactive-dashboards.md).
......
......@@ -43,16 +43,6 @@ To move a question, dashboard, or pulse into a collection, or from one collectio
Note that you have to have Curate permission for the collection that you're moving a question into _and_ the collection you're moving the question out of.
### Search
![Search results](./images/collections/search-results.gif)
Use the search bar to find dashboards, questions, collections, and pulses. You can select from the typeahead's dropdown results, or hit enter to view a search results page. You can also activate the search bar from anywhere by pressing the `/` key.
Searches take into account items’ titles, descriptions, and other metadata — you can even search the contents of your SQL queries. For example, you can search for things like `SELECT escape_pod FROM mothership` and find that one question you worked on six months ago. The results will display an item’s description, which collection it’s saved in, what kind of object it is, and whether it’s pinned. Note that you'll only ever see items in collections you have permission to view.
![Search results](./images/collections/search-results.png)
### Archiving items
Sometimes questions outlive their usefulness and need to be sent to Question Heaven. To archive a question or dashboard, just click on the `…` menu that appears on the far right when you hover over a question and pick the Archive action. You'll only see that option if you have "curate" permission for the current collection. You can also archive multiple items at once, the same way as you move multiple items. Note that archiving a question removes it from all dashboards or Pulses where it appears, so be careful!
......
......@@ -17,6 +17,7 @@
**Sharing results**
- [Sharing and organizing your saved questions](06-sharing-answers.md)
- [Collections](collections.md)
- [Creating dashboards](07-dashboards.md)
- [Adding filters to dashboards](08-dashboard-filters.md)
- [Making dashboards interactive](interactive-dashboards.md)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment