Skip to content

Commit 0316059

Browse files
committed
Update docs to change to “observability” and “dashboards”
1 parent 719a44d commit 0316059

File tree

5 files changed

+33
-16
lines changed

5 files changed

+33
-16
lines changed

docs/docs.json

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -180,8 +180,8 @@
180180
]
181181
},
182182
{
183-
"group": "Insights",
184-
"pages": ["insights/query", "insights/metrics"]
183+
"group": "Observability",
184+
"pages": ["observability/query", "observability/dashboards"]
185185
},
186186
{
187187
"group": "Using the Dashboard",
@@ -239,11 +239,20 @@
239239
},
240240
{
241241
"group": "Tasks API",
242-
"pages": ["management/tasks/trigger", "management/tasks/batch-trigger", "management/tasks/trigger-batch"]
242+
"pages": [
243+
"management/tasks/trigger",
244+
"management/tasks/batch-trigger",
245+
"management/tasks/trigger-batch"
246+
]
243247
},
244248
{
245249
"group": "Batches API",
246-
"pages": ["management/batches/create", "management/batches/retrieve", "management/batches/retrieve-results", "management/batches/stream-items"]
250+
"pages": [
251+
"management/batches/create",
252+
"management/batches/retrieve",
253+
"management/batches/retrieve-results",
254+
"management/batches/stream-items"
255+
]
247256
},
248257
{
249258
"group": "Runs API",
@@ -712,6 +721,14 @@
712721
{
713722
"source": "/upgrade-to-v4",
714723
"destination": "/migrating-from-v3"
724+
},
725+
{
726+
"source": "/insights/query",
727+
"destination": "/observability/query"
728+
},
729+
{
730+
"source": "/insights/metrics",
731+
"destination": "/observability/dashboards"
715732
}
716733
]
717734
}

docs/logging.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ export const customTrace = task({
8282

8383
Trigger.dev collects system and runtime metrics automatically for deployed tasks, and provides an API for recording custom metrics using OpenTelemetry.
8484

85-
You can view metrics in the [Metrics dashboards](/insights/metrics), query them with [TRQL](/insights/query), and export them to external services via [telemetry exporters](/config/config-file#telemetry-exporters).
85+
You can view metrics in the [Dashboards](/observability/dashboards), query them with [TRQL](/observability/query), and export them to external services via [telemetry exporters](/config/config-file#telemetry-exporters).
8686

8787
### Custom metrics API
8888

@@ -175,7 +175,7 @@ All metrics (both automatic and custom) are tagged with run context so you can f
175175

176176
### Querying metrics
177177

178-
Use [TRQL](/insights/query) to query metrics data. For example, to see average CPU utilization over time:
178+
Use [TRQL](/observability/query) to query metrics data. For example, to see average CPU utilization over time:
179179

180180
```sql
181181
SELECT
@@ -188,7 +188,7 @@ ORDER BY timeBucket
188188
LIMIT 1000
189189
```
190190

191-
See the [Query page](/insights/query#metrics-table-columns) for the full `metrics` table schema.
191+
See the [Query page](/observability/query#metrics-table-columns) for the full `metrics` table schema.
192192

193193
### Exporting metrics
194194

docs/management/query/execute.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Execute a query"
33
openapi: "v3-openapi POST /api/v1/query"
44
---
55

6-
See the [Query documentation](/insights/query#example-queries) for comprehensive examples including:
6+
See the [Query documentation](/observability/query#example-queries) for comprehensive examples including:
77

88
- Failed runs analysis
99
- Task success rates over time
Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
2-
title: "Metrics dashboards"
2+
title: "Dashboards"
33
description: "Create custom dashboards with real-time metrics powered by TRQL queries."
44
---
55

66
## Overview
77

88
In the Trigger.dev dashboard we have built-in dashboards and you can create your own.
99

10-
Metrics dashboards are powered by [TRQL queries](/insights/query) with widgets that can be displayed as charts, tables, or single values. They automatically refresh to show the latest data.
10+
Dashboards are powered by [TRQL queries](/observability/query) with widgets that can be displayed as charts, tables, or single values. They automatically refresh to show the latest data.
1111

1212
### Available metrics data
1313

1414
Trigger.dev automatically collects process metrics (CPU, memory) and Node.js runtime metrics (event loop, heap) for all deployed tasks -- no configuration needed. Requires SDK version **4.4.1 or later**. You can also create custom metrics using the `otel.metrics` API from the SDK.
1515

16-
All of this data is available in the `metrics` table for use in dashboard widgets. See [Logging, tracing & metrics](/logging#metrics) for the full list of automatic metrics and how to create custom ones, or the [Query page](/insights/query#metrics-table-columns) for the `metrics` table schema.
16+
All of this data is available in the `metrics` table for use in dashboard widgets. See [Logging, tracing & metrics](/logging#metrics) for the full list of automatic metrics and how to create custom ones, or the [Query page](/observability/query#metrics-table-columns) for the `metrics` table schema.
1717

1818
![The built-in Metrics dashboard](/images/metrics-built-in.png)
1919

@@ -37,12 +37,12 @@ You can also filter the data by:
3737
- Tasks
3838
- Queues
3939

40-
## Creating custom metrics dashboards
40+
## Creating custom dashboards
4141

42-
1. In the sidebar click the + icon next to "Metrics".
42+
1. In the sidebar click the + icon next to "Dashboards".
4343
2. Name your custom dashboard.
4444
3. From the top-right you can "Add chart" or "Add title".
45-
4. For charts you write [TRQL queries](/insights/query) and choose a visualization type.
45+
4. For charts you write [TRQL queries](/observability/query) and choose a visualization type.
4646
5. You can resize and reposition widgets on your dashboards.
4747

4848
## Performance considerations
@@ -91,7 +91,7 @@ Export data from any metric widget:
9191

9292
## Limits
9393

94-
Metrics is powered by Query so have [the same limits](/insights/query#limits) as Query.
94+
Dashboards are powered by Query so have [the same limits](/observability/query#limits) as Query.
9595

9696
There is a separate concurrency limits for metric widgets.
9797

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ description: "Query allows you to write custom queries against your data using T
2525
| `environment_type` | string | `PRODUCTION`, `STAGING`, `DEVELOPMENT`, `PREVIEW` |
2626
| `attributes` | json | Raw JSON attributes for custom data |
2727

28-
See [Logging, tracing & metrics](/logging#automatic-system-and-runtime-metrics) for the full list of automatically collected metrics and how to create custom metrics.
28+
See [Logging, tracing & metrics](/logging#automatic-system-and-runtime-metrics) for the full list of automatically collected metrics and how to create custom metrics. You can visualize this data on [Dashboards](/observability/dashboards).
2929

3030
### `prettyFormat()`
3131

0 commit comments

Comments
 (0)