Skip to content

Dashboard updates #781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 9, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 81 additions & 38 deletions docs/observability/how_to_guides/dashboards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,71 +3,105 @@ sidebar_label: Dashboards
sidebar_position: 3
---

# Create dashboards
import runDepth from "./static/run_depth_explained.png";

With dashboards you can create tailored collections of charts for tracking metrics that matter most to your application.
# Dashboards

## Creating a new dashboard
Dashboards give you high‑level insights into your trace data, helping you spot trends and monitor the health of your applications. LangSmith offers two dashboard types:

1. Navigate to the `Dashboards` tab in the left sidebar.
2. Click on the `+ Dashboard` button.
3. Give your dashboard a name and a description.
4. Click on `Create`.
- **Prebuilt dashboards**: Automatically generated for every tracing project.
- **Custom dashboards**: Fully configurable collections of charts tailored to your needs.

You'll see all of your dashboards displayed in a table view.
## Prebuilt dashboards

![Add dashboard](./static/add_dashboard.png)
![Dashboard table](./static/dashboard_table.png)
Prebuilt dashboards are created automatically for each project and cover essential metrics, such as trace count, error rates, token usage, and more.

## Adding charts to your dashboard
![prebuilt](./static/prebuilt.gif)

1. Within a dashboard, click on the `+ Chart` button to open up the chart creation pane.
2. Give your chart a name and a description.
3. Select one or more projects to track metrics for.
4. Choose a metric from the dropdown menu to set the y-axis of your chart.
### Dashboard sections

Prebuilt dashboards are broken down into sections that group relevant charts. Navigate between sections using the the navigation at the top.

| Section | What it shows |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Traces | A [trace](/observability/concepts#traces) is a collection of [runs](/observability/concepts#runs) related to a single operation. For example, if a user request triggers an agent, all runs for that agent invocation would be part of the same trace. |
| LLM Calls | All runs where run type is "llm". |
| Cost & Tokens | Costs are measured using [LangSmith's cost tracking](/observability/how_to_guides/log_llm_trace#manually-provide-token-counts). |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure this link here is needed / what i would expect to be linked to

| Tools | Includes runs where run type is "tool". Limits to top [N] tools. |
| Run Types | Includes runs that are immediate children of the root run. For example, for the following trace, the following runs have a depth of 1: <img src={runDepth} alt="run_depth" style= {{ display: 'block', width: 200 }} />. Limits to top [N] runs. |
| Feedback Scores | Feedback provided as part of [online evaluators](/observability/how_to_guides/online_evaluations). Limits to top the top 4 feedback scores by volume. |

### Group by

Group by [run tag or metadata](/observability/how_to_guides/add_metadata_tags) can be used to split data over arbitrary metrics that are important to your application. The group by setting appears on the top right hand side of the dashboard. Note that the Tool and Run Type charts already have a group by applied, so the global group by won't take effect.

:::tip
When adding metadata to runs, we reccomend having the same metadata on the trace, as well has the specific run (eg. LLM call). [WHY]
:::

### Time selector

Choose a time window in the dropdown on the top right hand side of the dashboard. You can set a default time window, by hovering over the values in the dropdown and clicking "Set default". Maximum time horizon is 30d.

:::note
You cannot modify a prebuilt dashboard. In the future, we plan to allow you to clone a default dashboard in order to have a starting point to customize it.
:::

## Custom Dashboards

With a project and a metric selected, you'll see a preview of your chart and the matching runs.
Create tailored collections of charts for tracking metrics that matter most for your application.

![Add chart](./static/add_chart.png)
### Creating a new dashboard

## Filtering traces in your chart
1. Navigate to the **Monitor** tab in the left sidebar.
2. Click on the **+ New Dashboard** button.
3. Give your dashboard a name and a description.
4. Click on **Create**.

### Adding charts to your dashboard

1. Within a dashboard, click on the **+ New Chart** button to open up the chart creation pane.
2. Give your chart a name and a description.
3. Configure the chart.

Use the **Chart filters** section to refine the matching runs. These are the same filters available on the Projects page and apply to all data series in the chart. (See [Filter traces in application](./filter_traces_in_application) for more information on filtering traces.)
### Chart configuration

![Chart filters](./static/chart_filters.png)
#### Select tracing projects and filter runs

## Comparing data within a chart
- Select one or more tracing projects to track metrics for.
- Use the **Chart filters** section to refine the matching runs. This filter applies to all data series in the chart. For more information on filtering traces, view our guide on [filtering traces in application](./filter_traces_in_application).

There are two ways to compare data in a chart (i.e. create multiple lines in a chart):
#### Pick a metric

1. **Multiple metrics**: Add multiple metrics with the same unit to a single chart. Each metric appears as a separate line. For example, compare P99 with P50 latency.
When you pick an initial metric, the comparison metrics dropdown will only show metrics with the same unit.
- Choose a metric from the dropdown menu to set the y-axis of your chart. With a project and a metric selected, you'll see a preview of your chart and the matching runs.
- For certain metrics (such as latency, token usage, cost), we support comparing multiple metrics with the same unit. For example, you may wany one chart where you can see prompt tokens and completion tokens. Each metric appears as a separate line.

![Multiple metrics](./static/compare_metrics.png)

Or
#### Split the data

2. **Data series**: Create multiple data series within a chart, each with its own filters. This is useful for comparing granular data within a single metric.
An example of using data series is to compare the performance of two different models or configurations. Name each series and apply specific filters.
There are two ways to create multiple series in a chart (i.e. create multiple lines in a chart):

![Multiple data series](./static/multiple_data_series.png)
1. **Group by**: Group runs by [run tag or metadata](/observability/how_to_guides/add_metadata_tags), run name or run type. Group by automatically splits the data into multiple series based on the field selected.

## Chart display options
2. **Data series**: Manually define multiple series with individual filters. This is useful for comparing granular data within a single metric.

- Choose between a line chart and a bar chart for visualizing (you can toggle this within the dashboard view)
- Optionally reassign the chart to a different dashboard
[need to retake screenshot, blocked on bug]
![Multiple data series](./static/multiple_data_series.png)

![Multiple data series](./static/bar_chart.png)
#### Pick a chart type

## Saving and managing charts
- Choose between a line chart and a bar chart for visualizing

### Save and manage charts

- Click `Save` to save your chart to the dashboard.
- Edit or delete a chart by clicking the triple line button in the top right of the chart.
- Clone a chart by clicking the triple line button in the top right of the chart and selecting `+ Clone`. This will open a new chart creation pane with the same configurations as the original.
- Edit or delete a chart by clicking the triple dot button in the top right of the chart.
- Clone a chart by clicking the triple line button in the top right of the chart and selecting **+ Clone**. This will open a new chart creation pane with the same configurations as the original.

![More actions bar](./static/more_actions_bar.png)

## View a chart in full screen
### View a chart in full screen

Click the expand icon in the top right corner of a chart to view it in full screen. This view offers:

Expand All @@ -76,9 +110,18 @@ Click the expand icon in the top right corner of a chart to view it in full scre

![Expanded chart](./static/expanded_chart.png)

## User journeys
## Linking a dashboard from a tracing project

You can link to a dashboard directly from a tracing project. By default, the prebuilt dashboard for your tracing project is selected. If you have a custom dashboard that you would like to link instead:

1. In your tracing project, click the pencil icon next to the Dashboard selector.
2. Choose a dashboard to set as the new default.

![Tracing project to dashboard](./static/tracing_project_to_dashboard.png)

## Example: User‑Journey Monitoring

1. **Use monitoring charts for mapping the decisions made by an agent at a particular node.**
Use monitoring charts for mapping the decisions made by an agent at a particular node.

Consider an email assistant agent. At a particular node it makes a decision about an email to:

Expand Down
1 change: 0 additions & 1 deletion docs/observability/how_to_guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ View and interact with your traces to debug your applications.
Use LangSmith custom and built-in dashboards to gain insight into your production systems.

- [Create and use custom dashboards](./how_to_guides/dashboards)
- [Use built-in monitoring dashboards](./how_to_guides/use_monitoring_charts)
Copy link
Contributor

@baskaryan baskaryan May 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- [Use built-in dashboards](./how_to_guides/dashboards#prebuilt-dashboards)
- [Create custom dashboards](./how_to_guides/dashboards#custom-dashboards)

- [Set up alerts for your project](./how_to_guides/alerts)

## Automations
Expand Down
Binary file not shown.
Binary file modified docs/observability/how_to_guides/static/compare_metrics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/observability/how_to_guides/static/expanded_chart.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/observability/how_to_guides/static/more_actions_bar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 0 additions & 32 deletions docs/observability/how_to_guides/use_monitoring_charts.mdx

This file was deleted.

Loading