-
Notifications
You must be signed in to change notification settings - Fork 66
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
Dashboard updates #781
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
230ac56
updates
tanushree-sharma 66f9b38
lint
tanushree-sharma e0ffc4c
changes
tanushree-sharma ca7c33b
minor changes
tanushree-sharma e4b7f30
index change
tanushree-sharma 791853f
Merge branch 'main' into dashboard-updates
tanushree-sharma File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
 | ||
 | ||
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 | ||
 | ||
|
||
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. | ||
tanushree-sharma marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
| Section | What it shows | | ||
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
tanushree-sharma marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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. | | ||
tanushree-sharma marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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). | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | | ||
tanushree-sharma marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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. | | ||
tanushree-sharma marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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. | | ||
tanushree-sharma marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### 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. | ||
tanushree-sharma marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
:::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] | ||
tanushree-sharma marked this conversation as resolved.
Show resolved
Hide resolved
|
||
::: | ||
|
||
### Time selector | ||
tanushree-sharma marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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 | ||
tanushree-sharma marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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. | ||
|
||
 | ||
### 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 | ||
|
||
 | ||
#### 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. | ||
|
||
 | ||
|
||
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): | ||
|
||
 | ||
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. | ||
tanushree-sharma marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## 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] | ||
 | ||
|
||
 | ||
#### 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. | ||
|
||
 | ||
|
||
## 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: | ||
|
||
|
@@ -76,9 +110,18 @@ Click the expand icon in the top right corner of a chart to view it in full scre | |
|
||
 | ||
|
||
## 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. | ||
|
||
 | ||
|
||
## 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: | ||
|
||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
- [Set up alerts for your project](./how_to_guides/alerts) | ||
|
||
## Automations | ||
|
Binary file not shown.
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+203 KB
docs/observability/how_to_guides/static/tracing_project_to_dashboard.png
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
32
docs/observability/how_to_guides/use_monitoring_charts.mdx
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.