> For the complete documentation index, see [llms.txt](https://docs.brigge.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.brigge.ai/documentation/brigge-for-operators/dashboard.md).

# Dashboard

## Introduction

The [*Dashboard*](#user-content-fn-1)[^1] is your primary view into [pipeline](/documentation/brigge-for-transformers/pipelines.md) activity across your Brigge environments. It provides a real-time summary of run outcomes, pipeline-level status, efficiency metrics, and run volume over time:

<div data-full-width="true" data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2F3DD3zcK6y27qBIri4f6p%2FDashboard%202605%20b.svg?alt=media&amp;token=103526bc-acb3-4596-95dd-308e110558db" alt=""><figcaption></figcaption></figure></div>

## Token usage summary

The token usage panel shows token usage and availability for the current billing period. For example:&#x20;

<div align="left" data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2Fmi0wmeN8V6XWNywtOmwB%2FToken%20usage%20-%20dashboard%20widget.svg?alt=media&amp;token=f2da6e90-ac03-4fb4-9297-ae5c3efc44c0" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
Token usage is shown for the current subscription billing period ([data selector settings](#data-selectors) are ignored).
{% endhint %}

At a glance, you'll see a visual indicator for the number of tokens used during the current billing period, and whether you have moved into overage. For specific counts, move your cursor between the different coloured sections. For example:

<div align="left" data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2Fny2wn8pdgAwL6W2mAdv7%2Fdahsboard%20token%20widget.gif?alt=media&amp;token=f07aa0f0-fbcf-4f72-9de2-cc2caf7b42b8" alt=""><figcaption></figcaption></figure></div>

Beneath the visual, two counts are shown:

<table><thead><tr><th width="243.24481201171875">Count</th><th>Summary</th></tr></thead><tbody><tr><td>Total usage</td><td><p>The total number of tokens used versus your token allowance for the current billing period. The usage count includes overage, which means it may be greater than the token allowance number.</p><p> </p><p>This count is updated immediately after any <a href="/documentation/account-and-plans/brigge-subscriptions-and-tokens.md#token-usage-per-activity-activity-logs">token adjustment activity</a> occurs (i.e. a pipeline run or an AI action). </p></td></tr><tr><td>Overage buffer</td><td>Shows the <a href="/documentation/account-and-plans/brigge-subscriptions-and-tokens.md#setting-an-overage-limit">monthly overage limit set for your subscription</a>, if applicable. This is the defined limit, not overage used. To see an overage count, hover your cursor over the visual at the point your token allowance ends.  </td></tr></tbody></table>

{% hint style="info" %}
For more information and guidance to manage your subscription, see [About Brigge tokens](/documentation/account-and-plans/brigge-subscriptions-and-tokens.md).
{% endhint %}

## Data selectors

Use selectors at the top of the page to control what data is visualised:

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th></tr></thead><tbody><tr><td><h4>Switch environments</h4></td><td><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FNACiupRlHGTq8AFLLd5p%2Fdash%20data%20selectors%20-%20env.png?alt=media&amp;token=ebc0fbbf-396a-4f01-947c-59cc2ddaeafa" alt=""></td><td>Use the <code>environment</code> selector to view and select from all environments defined for your organisation.</td></tr><tr><td><h4>Choose a time period</h4></td><td><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FzOkXgu7YmYln4Mt8bRfg%2Fdash%20data%20selectors%20-%20date.png?alt=media&amp;token=214d973b-8b7a-4d96-8b05-dd5e725358fd" alt=""></td><td>By default, data is visualised for the last month. Use the <code>date</code> selector to choose a different period within the last 45 days.</td></tr></tbody></table>

## Pipeline run status summary

The run status panel provides a snapshot of how your pipelines have performed for the [selected time period and environment](#data-selectors):&#x20;

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FwsqDa8f5kxb4MFF3Dum6%2Frun%20status%20example.png?alt=media&amp;token=c850997a-f4f2-4283-9853-953d33073a69" alt=""><figcaption></figcaption></figure></div>

A donut chart shows the proportion of each outcome at a glance, while a run status breakdown shows exact counts. For specific counts, move your cursor between the different coloured sections. For example:

<div align="left" data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FyeNzDwm72phsNdAv4atw%2Frun%20status%20widget%20demo.gif?alt=media&amp;token=714341fb-d9ff-435d-a431-e08bf3537728" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
If the failed count is greater than zero, scroll down to the [pipeline status](#pipeline-status-information) panel to identify which pipeline needs attention.
{% endhint %}

### What do the run statuses actually mean?

<table><thead><tr><th width="188.18359375">Status</th><th>Summary</th></tr></thead><tbody><tr><td>Queued</td><td>Runs waiting to execute</td></tr><tr><td>Running</td><td>Runs currently in progress</td></tr><tr><td>Success</td><td>Runs completed without errors</td></tr><tr><td>Failed</td><td>Runs that did not complete successfully</td></tr></tbody></table>

## Usage & efficiency metrics

Usage and efficiency metrics show performance indicators for the [selected time period and environment](#data-selectors). Use these to confirm the environment is running within normal parameters, or to spot performance degradation over time.

<div align="left" data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FlAPx11uk1dVcH321tlWq%2Fusage%20and%20efficiency.png?alt=media&amp;token=0164c321-46cd-4d91-91ad-fbff6de5371d" alt=""><figcaption></figcaption></figure></div>

Available metrics (for the selected environment and period) are summarised below:

<table><thead><tr><th width="200.99609375">Metric</th><th>Summary</th></tr></thead><tbody><tr><td>AVG run</td><td>Average time to complete a single pipeline run.</td></tr><tr><td>CPU time</td><td>Total CPU processing time across all pipeline runs.</td></tr><tr><td>Data</td><td>Total volume of data processed.</td></tr><tr><td>Score</td><td><p>An overall efficiency score for pipelines that ran in the given period, based on a rating from 0 to 1000. Scores are calculated from CPU time and the data volume processed - in a nutshell:</p><ul><li>Fast with a high data throughput is good</li><li>Fast with a low data throughput is bad</li><li>Slow with an excessive data throughput is bad</li></ul><p>So pipelines handling reasonable volumes of data quickly receive a higher score. If your score is on the low side, it's worth reviewing your pipelines to ensure data is processed efficiently.</p></td></tr><tr><td>Tokens</td><td>Tokens used for pipeline runs.</td></tr></tbody></table>

## Pipeline status information

The *Pipeline Status* panel displays all your saved pipelines (irrespective of deployment status), with run status insights for your [selected time period and environment](#data-selectors). For example:

<figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FODBsSKm912cqhN4XwvWB%2Fpipeline%20status%201.png?alt=media&amp;token=27b76318-0647-46d5-8c25-387b48cf49dc" alt=""><figcaption></figcaption></figure>

Each pipeline shows the following information for the  [selected time period and environment](#data-selectors):

<figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FsTMKn7BSzGm2QMeiVJHC%2FDashboard%20-%20anatomy%20of%20a%20status%20entry%20b.svg?alt=media&amp;token=0b7703ab-6326-41b6-86b3-dd764ddfc806" alt=""><figcaption></figcaption></figure>

These details are summarised below:

<table><thead><tr><th width="79.6796875">#</th><th>Summary</th></tr></thead><tbody><tr><td>1</td><td>The percentage of successful runs in the <a href="#data-selectors">selected time period and environment</a>.</td></tr><tr><td>2</td><td>The pipeline name is displayed as a hyperlink. Click this name to access the pipeline in edit mode. </td></tr><tr><td>3</td><td><p>A coloured marker is displayed for each day in your selected time period - click a marker to update the <a href="#daily-run-totals">Pipeline run totals graph</a> for that day.</p><p></p><p>The colour of this marker indicates the outcome of the latest, completed run for the given day:</p><ul><li>Green - run completed successfully</li><li>Yellow - run completed with warnings</li><li>Red - run failed</li><li>Grey - no runs recorded for this pipeline in the selected period/environment</li></ul></td></tr><tr><td>4</td><td>Click the 'graph' icon to access the <a href="/documentation/brigge-for-transformers/pipelines.md">pipeline</a> in edit mode.</td></tr><tr><td>5</td><td>Click the 'time' icon to access <a href="/documentation/brigge-for-operators/history-and-retries.md">run history</a> information for the pipeline.</td></tr></tbody></table>

{% hint style="info" %}
If you're managing lots of pipelines, use the search field at the top of this panel to search by pipeline name.
{% endhint %}

## Pipeline run totals

The *Pipeline run totals* line chart shows run volume over the selected time period, by day. Use this to understand patterns - peak periods, dips in activity, or unusual spikes that might warrant investigation.

<div align="left"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FCZxAzrvnkIry72gugBq7%2Fpipeline%20run%20totals.png?alt=media&amp;token=6e60501a-bcee-4da3-893f-f9549fa81f88" alt=""><figcaption></figcaption></figure></div>

[^1]: **How do I get there?**\
    Select *environments* from the main navigation menu:

    ![](https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FK9g4XlBig24G2Sd6u3PV%2Faccess%20dashboard%202.png?alt=media\&token=6ecf206b-27c8-482e-a6b1-989517e4291b)<br>
