Looking for the old docs site? You can still view it for a limited time here.

Works with:
Fusion Server

Compatible with: 4.1, 4.2, 5.0, 5.1

Use Dashboards in Fusion 4.1+

layout: howto title: Use Dashboards in Fusion 4.0.x toc: true product: fusion-server productVersion: 4.0 persona: search-engineer, devops, data-scientist objective: manage, troubleshoot, analyze-data ---

  • Open the default dashboard – Click Goto saved default Goto saved default.

  • Open a pre-built dashboard – See Use Built-in Dashboards.

  • Load a dashboard from Solr – At the top right of the open dashboard, click Load Load. Saved dashboards are listed at the bottom of the dialog box. Click a dashboard to open it. Filter dashboards by entering an exact-match string in the Filter box. If there are more that 20 saved dashboards, use the pagination controls to find a dashboard. To view the next set of pages, click Page forward. To view the prior set of pages, click Load. You must click a page number to view the dashboards on that page. This is an example of the controls:

    Pagination controls

  • Load a dashboard from a file – At the top right of the open dashboard, click Load Load. Click Choose File Choose File, browse to and select the file, and then click Open.

  • Load a dashboard from a GitHub gist – Perform these steps:

    1. At the top right of the open dashboard, click Load Load.

    2. Enter the gist URL or number (the last part of the URL). For example:

      https://gist.github.com/anonymous/#b10353f36c9fcaaade7db98889e9678b#

    3. Click Get Get. A link that opens the dashboard appears below a thin line. The link displays the dashboard name. Click the link to open the dashboard. This is an example of the Gist-loading dialog:

      Gist loading dialog

  • Set a default dashboard for a browser Click Save Dashboard Save Dashboard > Set as Browser Default Set as Browser Default.

  • Clear the default dashboard for a browser – Click Save Dashboard Save Dashboard > Clear Browser Default Clear Browser Default. The default dashboard for the browser becomes the system default dashboard default.json (the Fusion Logs dashboard).

Interact with data

  • Choose the collection from which to obtain data – If a dashboard was configured to let users choose among collections, then you can choose the collection from the Collections drop-down list at the top right of the dashboard.

  • Search – Enter a query term or phrase in a search bar in a Query panel, and then click Search Search.

  • Retrieve all data – In the Query panel, enter :, and then click Search Search.

  • Clear a search box and return to the most general query (:) – Click Clear Search Box Clear Search Box.

  • See that a query is in progress for a panel – At the top right of a panel, the Waiting for Data Waiting for Data indicator shows you that the panel is waiting for the data. If the indicator spins and spins while other panels display data, the panel is not configured correctly.

  • Select a specific data item – In a table, click a row. In a graphical-visualization panel, click a data item. Not all panel types let you select data in this way.

  • Export data – At the top of a panel, click Export Export.

  • Hide a row – At the left of the row, click Hide Row Hide row.

  • Expand a hidden row – At the left of the hidden row, click Expand Row Expand row.

Interact with specific types of panels

Following are interactions for specific types of panels.

Table panels

  • Show the field list – At the top left of a Table panel, click Show Field List Show Field List.

  • Hide the field list – At the top left of a Table panel, click Hide Field List Hide Field List.

  • Sort a column in a table into ascending order – At the top of a column, click Sort Ascending Sort Ascending.

  • Sort a column in a table into descending order – At the top of a column, click Sort Descending Sort Descending.

  • View the next page of hits – At the top or bottom of a page of hits in a Table panel, click Next Page Next Page.

  • View the previous page of hits – At the top or bottom of a page of hits in a Table panel, click Previous page Previous page.

  • View the first page of hits – At the top left of a Table panel, click View First Page View First Page

  • Show details for a record in a table – Click a row in a table. Click Table, JSON, or Raw to view the details in those formats.

  • Hide details for a record in a table – At the top right of the details, click Hide Details Hide Details.

Full Text Search panels

  • Show details for a record in a Full Text Search panel – Click a row in a Full Text Search panel. Click Table, JSON, or Raw to view the details in those formats.

  • Hide details for a record in a Full Text Search panel – At the top right of the details, click Hide Details Hide Details.

Histogram and Range Facet panels

  • Zoom in on a subset of data (Histogram and Range Facet panels) – On the histogram, drag the mouse across the range of data you want to zoom in on.

    Histogram zoomed in

  • Zoom out from a subset of data (Histogram and Range Facet panels) – Click Zoom Out Zoom Out.

    Histogram zoomed out

Filtering panels

  • Edit a filter – Click Edit Filter Edit Filter.

  • Toggle a filter on and off Click Toggle Filter Toggle Filter.

  • Remove a filter – For the filter that you want to remove, click Remove Filter Remove Filter.

    Note Exercise caution when removing filters. Some panels depend on specific filters being present. Fusion also creates filters based on your interactions with data. You can add a filter back, but there is no undo. You might want to just toggle the filter off instead.

Heat Map panels

  • Transpose rows and columns in a heat map – In a Heat Map panel, click Transpose Rows and Columns Transpose Rows and Columns.

Heat Map panels

  • Transpose rows and columns in a heat map – In a Heat Map panel, click Transpose Rows and Columns Transpose Rows and Columns.

Filter by Fusion request ID

To only display information about log entries with a specific Fusion request ID, you can filter the contents of a logs dashboard by the Fusion request ID.

You can do this in these ways:

  • Click a link in the error message or toast.

  • Filter in a logs dashboard.

  • Append a query filter parameter to the dashboard URL.

In an API error in the Fusion UI or in an error toast, a View logs dashboard link is present. Click the link to view the dashboard using a fiter for that request ID.

API error with link in Fusion UI:

View logs dashboard link in API error

API error toast with link:

View logs dashboard link in toast

Filtered Service Logs dashboard:

Clicking a View logs dashboard link opens the Service Logs dashboard and filters by the Fusion request ID. Notice the filtering query for the mdc_requestId_s field. In this example, the fusion-request-id is BWQSjPPYgB.

Service Logs dashboard filtered by request ID

Filter in a logs dashboard

In the Service Logs, Access Logs, or Combined Logs dashboard, you can filter by Fusion request ID.

To do so:

  1. Obtain the Fusion request ID returned by a request. For example, notice the Fusion request ID BWQSjPPYgB returned by this API command:

    curl -v -u admin:password http://127.0.0.1:8764/api/apps/inventory
*   Trying 127.0.0.1...
* TCP_NODELAY set
* Connected to 127.0.0.1 (127.0.0.1) port 8764 (#0)
* Server auth using Basic with user 'admin'
> GET /api/apps/inventory HTTP/1.1
> Host: 127.0.0.1:8764
> Authorization: Basic YWRtaW46UGFzc3dvcmQxMjM=
> User-Agent: curl/7.54.0
> Accept: */*
>
< HTTP/1.1 404 Not Found
< Content-Type: application/json
< fusion-request-id: BWQSjPPYgB
< Server: Jetty(9.3.8.v20160314)
< Set-Cookie: id=4962c806-f3b5-485f-8fb4-c20e608b700c;Path=/;HttpOnly
< Content-Length: 394
< Connection: close
<
{
  "type" : "RESTError",
  "httpStatusCode" : 404,
  "error" : "ERR-0003",
  "message" : "A web application error occurred",
  "details" : "The Fusion App with id 'inventory' does not exist",
  "cause" : null,
  "requestId" : "BWQSjPPYgB",
  "httpStatusMessage" : "Not Found",
  "localizedMessage" : "The Fusion App with id 'inventory' does not exist",
  "suppressed" : [ ],
  "class" : null
* Closing connection 0
}

  2. Open a logs dashboard.

  3. Specify the Fusion request ID in the Filter panel, with a query for the mdc_requestId_s field that specifies the value of fusion-request-id for which you want to search.

In this example, the fusion-request-id is BWQSjPPYgB:

Add a filter for the Fusion request ID

Append a query filter parameter to the dashboard URL

As an alternative to constructing a query filter in the dashboard, you can append a query filter parameter to the dashboard URL. In the query filter, use the field name mdc_requestID_s.

Example 1: Default dashboard (Service Logs)

Default dashboard URL

Example 2: Combined Logs dashboard

Combined Logs URL

Example 1: Default dashboard (Service Logs)

Default dashboard URL

Example 2: Combined Logs dashboard

Combined Logs URL

Open the Service Logs dashboard from a job history

  1. Open the job history. For most jobs, click Collections Collections > Jobs, select a job, and then click Job History. For datasource jobs, click Indexing Indexing > Datasources, select a datasource, and then click Job History.

    In the job history, you will see a link named runId:

    Job history

  2. Click the link to view the Service Logs dashboard filtered by the runId:

    Service Logs dashboard filtered by runId