Skip to content

Commit 0734180

Browse files
committed
Create a Dashboard for Child Orgs (MSSPs)
1 parent b3c888c commit 0734180

File tree

5 files changed

+86
-0
lines changed

5 files changed

+86
-0
lines changed
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
id: dashboard-child-orgs
3+
title: Create a Dashboard for Child Orgs (MSSPs)
4+
description: Learn how to create your own custom Dashboard with a panel and query to child org level, then customize a chart and add the chart to the dashboard.
5+
---
6+
7+
import useBaseUrl from '@docusaurus/useBaseUrl';
8+
9+
Dashboard allows you to view log data on the same dashboard in an integrated and seamless view. This page demonstrates on how to create a dashboard, a panel query, and then add a panel to the dashboard at the child orgs level.
10+
11+
## Create a dashboard
12+
13+
There are two ways to create a **Dashboard**, either by using the following method or by creating it directly from the [Log Search page](#log-search-page). Follow the steps below to create a dashboard under a selected child org:
14+
15+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). Go to the **Home** screen and select **Dashboard**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu, select **Dashboards > New Dashboard**. You can also click the **Go To...** menu at the top of the screen and select **New Dashboard**.
16+
1. Select the Dashboard text field at the top of the window and enter a unique name for your new dashboard.
17+
1. From the **Select Org** dropdown, select the child org under which you need to create the dashboard.<br/><img src={useBaseUrl('/img/dashboards/create-dashboard/select-org-for-dashboard.png')} alt="select-org-for-dashboard" style={{border: '1px solid gray'}} width="800" />
18+
19+
## Add a panel
20+
21+
Now that you have created a new Dashboard, you can populate it with panels that visually display your data. This task shows you how to add a panel to your new dashboard and customize the display.
22+
23+
To add a panel to a new Dashboard, do the following:
24+
25+
1. Select a panel type by clicking the corresponding icon. To know more about panels, refer to [Choosing a panel type](/docs/dashboards/panels).<br/><img src={useBaseUrl('/img/dashboards/create-dashboard/panel-types.png')} alt="panel types" style={{border: '1px solid gray'}} width="600" />
26+
1. You are prompted to [provide a query](#add-log-query]).
27+
1. If you have selected the parent org while creating the dashboard, you will be able to select the child org under which the panel query need to run.
28+
:::note
29+
The autocomplete feature while writing the query will run with respect to the selected child org.
30+
:::
31+
1. Click the **Add to Dashboard** button on the top right of the window to add the panel to your dashboard. <br/><img src={useBaseUrl('/img/dashboards/create-dashboard/Add-to-Dashboard-button.png')} alt="Add to Dashboard button" style={{border: '1px solid gray'}} width="300" />
32+
1. Once the panel is added the the dashboard, panel query will display the results based on the [default org set for the dashboard](#set-a-default-org).
33+
34+
You can customize a chart on a dashboard panel in a variety of ways. To include changing the chart type to analyze the data in another format. See [Modify a Chart](./panels/modify-chart.md) for details on all the available options.
35+
36+
:::note
37+
- Currently, this capability is limited only to Log data.
38+
- We only support selecting one child org to perform the log search.
39+
:::
40+
41+
## Add a log query
42+
43+
Enter your aggregate [search query](/docs/search/search-query-language/group-aggregate-operators) in the input field and press enter. A few important things to note are:
44+
45+
* Only search results that have been aggregated using a group or aggregate operator can be charted. See [Group or Aggregate Operators](/docs/search/search-query-language/group-aggregate-operators) for a list. 
46+
* By default, the query builder is set to **Logs**
47+
* Joining log queries in a separate query is not supported.<br/><img src={useBaseUrl('/img/dashboards/create-dashboard/Add-log-query.png')} alt="Add log query" style={{border: '1px solid gray'}} width="800" />
48+
49+
## Set a default org
50+
51+
Follow the below steps to change the default child org by following the below steps:
52+
53+
1. In the **Select Org** dropdown, select the org of your choice.
54+
1. Click the kebab icon against the **Select Org** option, and select **Set as Default**.<br/><img src={useBaseUrl('/img/dashboards/create-dashboard/set-as-default.png')} alt="set-as-default" style={{border: '1px solid gray'}} width="400" />
55+
56+
## Log Search page
57+
58+
To create a Dashboard from the [Log Search page](/docs/search):
59+
60+
1. **Classic UI.** Go to the **Log Search** page.
61+
**New UI.** In the main Sumo Logic menu, select **Logs** > **Log Search**. You can also click the **Go To...** menu at the top of the screen and select **Log Search**.
62+
1. Click the <img src={useBaseUrl('img/search/get-started-search/search-page/child-org-select-button.png')} alt="child-org-select-button" style={{border: '1px solid gray'}} width="30"/>  button to select the child org where you want to query. <br/><img src={useBaseUrl('img/search/get-started-search/search-page/child-org-dropdown.png')} alt="child-org-dropdown" style={{border: '1px solid gray'}} width="800"/> 
63+
1. Enter the required query and click the search button to obtain the search results.
64+
1. From the Log Search page click the **Add to Dashboard** button on the Aggregates tab after running your aggregate query you want to add to a Dashboard panel.<br/><img src={useBaseUrl('/img/dashboards/create-dashboard/Add-to-dashboard-new-logs.png')} alt="Add to dashboard new logs" style={{border: '1px solid gray'}} width="700" />
65+
1. In the **Add Panel to Dashboard** window provide a **Panel Title** and a name for the **Dashboard**. Once the name is entered you will have an option to select **Create New Dashboard** with your name. Select that option.<br/><img src={useBaseUrl('/img/dashboards/create-dashboard/Enter-dashboard-new-name-logs.png')} alt="Enter dashboard new name logs" style={{border: '1px solid gray'}} width="400" />
66+
1. In the updated window toggle the **Create as Dashboard** option.<br/><img src={useBaseUrl('/img/dashboards/create-dashboard/Create-new-dashboard-new-from-search-page.png')} alt="Create new dashboard new from search page" style={{border: '1px solid gray'}} width="400" />
67+
1. Click **Add** and your new Dashboard is created.
68+
69+
## Delete a Panel
70+
71+
You can delete a panel that you no longer need.
72+
73+
1. Go to the Dashboard in Sumo Logic that has the panel you want to delete.
74+
1. Hover the cursor over the **Details** icon to display the pop-up menu.<br/><img src={useBaseUrl('/img/dashboards/panels/delete-panel/details-option.png')} alt="details option" style={{border: '1px solid gray'}} width="700" />
75+
1. Select **Delete**.<br/><img src={useBaseUrl('/img/dashboards/panels/delete-panel/delete-a-panel.png')} alt="delete a panel" style={{border: '1px solid gray'}} width="700" />
76+
77+
## Share a dashboard
78+
79+
If required, toggle off the **Include current variable values in the URL** option to hide the variables and organiation details from the URL when you share the dashboard.

docs/dashboards/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,12 @@ In this section, we'll introduce the following concepts:
3838
<p>Create and customize dashboards with panels and queries.</p>
3939
</div>
4040
</div>
41+
<div className="box smallbox card">
42+
<div className="container">
43+
<a href="/docs/dashboards/dashboard-child-orgs"><img src={useBaseUrl('img/icons/dashboards.png')} alt="icon" width="40"/><h4>Create a Dashboard for Child Orgs (MSSPs)</h4></a>
44+
<p>Create and customize dashboards with panels and queries for child orgs.</p>
45+
</div>
46+
</div>
4147
<div className="box smallbox card">
4248
<div className="container">
4349
<a href="/docs/dashboards/panels"><img src={useBaseUrl('img/icons/dashboards.png')} alt="icon" width="40"/><h4>Dashboard Panels</h4></a>

sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1248,6 +1248,7 @@ module.exports = {
12481248
items: [
12491249
'dashboards/about',
12501250
'dashboards/create-dashboard-new',
1251+
'dashboards/dashboard-child-orgs',
12511252
'dashboards/explore-view',
12521253
'dashboards/drill-down-to-discover-root-causes',
12531254
{
162 KB
Loading
36.9 KB
Loading

0 commit comments

Comments
 (0)