Skip to content

Commit 3fe874c

Browse files
authored
Rename Explore to SQL Workbench in docs (#2097)
1 parent 86f2514 commit 3fe874c

19 files changed

Lines changed: 41 additions & 41 deletions

File tree

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ When you're iterating on AI applications with a coding agent, the agent needs to
216216

217217
*Logfire uses [Apache DataFusion](https://datafusion.apache.org/) as its query engine, with syntax designed to match PostgreSQL conventions.*
218218

219-
[SQL Explorer](guides/web-ui/explore.md)
219+
[SQL Workbench](guides/web-ui/explore.md)
220220

221221
---
222222

docs/guides/onboarding-checklist/add-manual-tracing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ Note that:
4141
2. Spans have a start and an end time, and thus a duration. This span took 3 seconds to complete.
4242
3. For logs, the start and end time are the same, so they don't have a duration. But you can still see in the UI that the log was created 1 second after the span started and 2 seconds before it ended.
4343

44-
If you click on the 'Explore' link in the top navbar, you can write SQL to explore further, e.g:
44+
If you click on the **SQL Workbench** link in the top navbar, you can write SQL to explore further, e.g:
4545

46-
![Query in Explore view: select extract('seconds' from end_timestamp - start_timestamp) as duration, kind, message, trace_id, span_id, parent_span_id from records order by start_timestamp ](../../images/guide/manual-tracing-explore-basic.png)
46+
![Query in SQL Workbench: select extract('seconds' from end_timestamp - start_timestamp) as duration, kind, message, trace_id, span_id, parent_span_id from records order by start_timestamp ](../../images/guide/manual-tracing-explore-basic.png)
4747

4848
Note:
4949

@@ -90,7 +90,7 @@ for name in ['Alice', 'Bob', 'Carol']:
9090
logfire.info('Hello {name}', name=name)
9191
```
9292

93-
![Query in Explore view: select span_name, attributes->>'name' as name, message from records order by start_timestamp](../../images/guide/manual-tracing-span-names.png)
93+
![Query in SQL Workbench: select span_name, attributes->>'name' as name, message from records order by start_timestamp](../../images/guide/manual-tracing-span-names.png)
9494

9595
Here you can see that:
9696

docs/guides/web-ui/explore.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: "Logfire SQL Explorer: Query & Inspect Your Data"
3-
description: Run arbitrary SQL queries against traces and metric data. Use the Logfire SQL Explorer to investigate and analyze records.
2+
title: "Logfire SQL Workbench: Query & Inspect Your Data"
3+
description: Run arbitrary SQL queries against traces and metric data. Use the Logfire SQL Workbench to investigate and analyze records.
44
---
5-
With **Logfire**, you can use the Explore page to run arbitrary SQL queries against your trace and metric data to
5+
With **Logfire**, you can use SQL Workbench to run arbitrary SQL queries against your trace and metric data to
66
analyze and investigate your system.
77

8-
![Logfire explore screen](../../images/guide/browser-explore-full.png)
8+
![Logfire SQL Workbench](../../images/guide/browser-explore-full.png)
99

1010
## Querying Traces
1111

@@ -118,11 +118,11 @@ for the full list of metric functions.
118118

119119
To execute a query, type or paste it into the query editor and click the "Run Query" button.
120120

121-
![Logfire explore screen](../../images/guide/browser-explore-run-query.png)
121+
![Logfire SQL Workbench running a query](../../images/guide/browser-explore-run-query.png)
122122

123123
You can modify the time range of the query using the dropdown next to the button. There is also a "Limit" dropdown that
124124
controls the maximum number of result rows returned.
125125

126-
The Explore page provides a flexible interface to query your traces and metrics using standard SQL.
126+
SQL Workbench provides a flexible interface to query your traces and metrics using standard SQL.
127127

128128
Happy querying! :rocket:

docs/guides/web-ui/kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ If you have not set anything up yet, the empty state on each tab has a **Set up*
9696

9797
## Where Kubernetes events surface today
9898

99-
The chart's `kubernetesEvents` preset turns Kubernetes events (pod scheduling, OOMKills, image pull failures, deployment progress) into log records via the `k8sobjects` receiver and ships them to your project. There is no dedicated **Events** tab in the Kubernetes view yet. To read them, open the [Live View](live.md) and filter on the relevant pod, namespace or `k8s.*` attribute, or query the `records` table directly in the [SQL Explorer](explore.md). Watch this space. An events feed in the Kubernetes view is in our backlog.
99+
The chart's `kubernetesEvents` preset turns Kubernetes events (pod scheduling, OOMKills, image pull failures, deployment progress) into log records via the `k8sobjects` receiver and ships them to your project. There is no dedicated **Events** tab in the Kubernetes view yet. To read them, open the [Live View](live.md) and filter on the relevant pod, namespace or `k8s.*` attribute, or query the `records` table directly in [SQL Workbench](explore.md). Watch this space. An events feed in the Kubernetes view is in our backlog.
100100

101101
## Troubleshooting
102102

docs/guides/web-ui/live.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ As the greyed out `SELECT * FROM RECORDS WHERE` implies, you're searching inside
2525
It has auto-complete & schema hints, so try typing something to get a reminder. To run your query click `Run` or
2626
keyboard shortcut `cmd+enter` (or `ctrl+enter` on Windows/Linux).
2727

28-
Note: you can run more complex queries on the [explore screen](explore.md)
28+
Note: you can run more complex queries in [SQL Workbench](explore.md).
2929

3030
The records table fields are documented in the [SQL reference](../../reference/sql.md).
3131

docs/guides/web-ui/llms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ Refresh the LLMs page. A row for `gpt-4o-mini` (provider `openai`) should appear
134134

135135
## Slicing by environment, agent or user
136136

137-
The inventory groups rows by `(provider, model)`. Beyond the text search at the top, there are no dropdowns for filtering by environment, agent or user *on this page yet*. For per-environment, per-agent, per-user, per-feature or per-tenant breakdowns, query the `records` table directly in the [SQL Explorer](explore.md). Every GenAI span carries the `gen_ai.*` attributes alongside `deployment.environment.name` and any custom resource attributes you've set, so you can slice cost, latency or token usage by whatever dimension matters.
137+
The inventory groups rows by `(provider, model)`. Beyond the text search at the top, there are no dropdowns for filtering by environment, agent or user *on this page yet*. For per-environment, per-agent, per-user, per-feature or per-tenant breakdowns, query the `records` table directly in [SQL Workbench](explore.md). Every GenAI span carries the `gen_ai.*` attributes alongside `deployment.environment.name` and any custom resource attributes you've set, so you can slice cost, latency or token usage by whatever dimension matters.
138138

139139
## Troubleshooting
140140

docs/guides/web-ui/metrics-explorer.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Step 3 shows you a small chart per dimension (label) on the metric, with the car
2929
Each card has:
3030

3131
- **View SQL**: opens a dialog with the exact SQL that produced the chart. Copy it for a dashboard, or send it to a teammate.
32-
- **Open in Explore**: drops you into the [SQL Explorer](explore.md) with that query already populated, so you can extend it.
32+
- **Open in SQL Workbench**: opens [SQL Workbench](explore.md) with that query already populated, so you can extend it.
3333

3434
Aggregations default sensibly by metric kind, with the rest available from the dropdown:
3535

@@ -41,11 +41,11 @@ Aggregations default sensibly by metric kind, with the rest available from the d
4141
| Exponential histogram | `avg` | `avg`, `sum`, `min`, `max`, `count` |
4242

4343
!!! note "Percentiles on histograms"
44-
The wizard does not expose `p50`/`p95`/`p99` directly on histogram-typed metrics today: pre-aggregated histograms (e.g. `http.server.request.duration` from OTel SDK instrumentations) report `avg`, `min`, `max`, `count` and `sum` in the wizard. For percentiles over a histogram, switch to the [SQL Explorer](explore.md) and use the histogram bucket columns; the **Open in Explore** button on every card hands you a query you can extend.
44+
The wizard does not expose `p50`/`p95`/`p99` directly on histogram-typed metrics today: pre-aggregated histograms (e.g. `http.server.request.duration` from OTel SDK instrumentations) report `avg`, `min`, `max`, `count` and `sum` in the wizard. For percentiles over a histogram, switch to [SQL Workbench](explore.md) and use the histogram bucket columns; the **Open in SQL Workbench** button on every card hands you a query you can extend.
4545

4646
## When the wizard isn't enough
4747

48-
The wizard is for discovery. The [SQL Explorer](explore.md) is for the real work. The **View SQL** and **Open in Explore** buttons on every card are the on-ramp between them, so you can do as much as the wizard handles and graduate without retyping anything.
48+
The wizard is for discovery. [SQL Workbench](explore.md) is for the real work. The **View SQL** and **Open in SQL Workbench** buttons on every card are the on-ramp between them, so you can do as much as the wizard handles and graduate without retyping anything.
4949

5050
The columns you see in the wizard live on the `metrics` table; the full schema is in the [SQL reference](../../reference/sql.md).
5151

@@ -96,4 +96,4 @@ Refresh the Metrics view. `hello` appears in **Recently active** and as its own
9696
| Custom metric lands in **Everything else** instead of its own namespace | The metric name has no dot (e.g. `requests_total` instead of `app.requests.total`). The grouping is structural: give the name a dotted prefix to create a namespace. |
9797
| Step 1 shows no namespaces at all | The project hasn't received any metric samples yet. The wizard reads from `metrics`-table data; if you're sending only spans, no namespaces will appear here. |
9898
| Two metric sources show up under `system.*` with overlapping series | The SDK's [system-metrics integration](../../integrations/system-metrics.md) and an OpenTelemetry Collector running `hostmetricsreceiver` are both running on the same host. See the [double-counting note](#how-the-data-flows-in). |
99-
| Promoting a dimension shows fewer series than the cardinality card claimed | The chart truncates after a fixed number of series. For full breakdowns of a high-cardinality dimension, jump into the [SQL Explorer](explore.md) via the **Open in Explore** button on the card. |
99+
| Promoting a dimension shows fewer series than the cardinality card claimed | The chart truncates after a fixed number of series. For full breakdowns of a high-cardinality dimension, open [SQL Workbench](explore.md) from the **Open in SQL Workbench** button on the card. |

docs/guides/web-ui/saved-searches.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,5 +88,5 @@ flowchart TD
8888

8989
**Next Steps:**
9090

91-
- [Explore more about querying with SQL](explore.md)
91+
- [Learn more about querying with SQL](explore.md)
9292
- [Learn about dashboards and alerts](dashboards.md), (alerts.md)

docs/guides/web-ui/services.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: "Browse every service shipping spans to your Logfire project. See r
66

77
The **Services view** is the entry point for finding the service you want to investigate. Each service that ships spans to your project appears as one row, sorted by whatever metric matters right now (requests, error rate, latency). Click a row to drill into its detail page, click a recent failed trace, and you land in the [Live View](live.md) with the failing trace open.
88

9-
You'll find Services in the project sidebar, between [Explore](explore.md) and [Hosts](hosts.md).
9+
You'll find Services in the project sidebar, between [SQL Workbench](explore.md) and [Hosts](hosts.md).
1010

1111
![Services inventory page](../../images/services/inventory.png)
1212

@@ -36,7 +36,7 @@ You'll see:
3636
- **Top operations**: the highest-traffic and slowest spans inside the service.
3737
- **Recent errors**: a short list of failed traces, each linking straight to the [Live View](live.md) so you can investigate.
3838

39-
Two buttons in the header ([Live view](live.md) and [Explore](explore.md)) hand the whole service off to the live view or the SQL editor in one click. The detail page defaults to the last 30 minutes.
39+
Two buttons in the header ([Live view](live.md) and [SQL Workbench](explore.md)) hand the whole service off to the live view or SQL Workbench in one click. The detail page defaults to the last 30 minutes.
4040

4141
The topology graph and the operations / errors tables below the trends:
4242

docs/how-to-guides/environments.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Once set, you will see your environment in the environment picker in the Logfire
3030
The picker lives in the side navigation, directly below the project picker, and reads
3131
`all envs` until you narrow it down. It applies to observability pages like
3232
[Live View](../guides/web-ui/live.md), [Dashboards](../guides/web-ui/dashboards.md)
33-
and [Explore](../guides/web-ui/explore.md) (on pages where environments don't apply,
33+
and [SQL Workbench](../guides/web-ui/explore.md) (on pages where environments don't apply,
3434
the picker is shown disabled):
3535

3636
![Environments](../images/guide/environments.png)
@@ -46,7 +46,7 @@ Note that by default there are system generated environments:
4646
So `env not specified` is a subset of `all envs`.
4747

4848
Any environments you create via the SDK will appear below the system generated environments.
49-
When you select an environment, all subsequent queries (e.g. on live view, dashboards or explore)
49+
When you select an environment, all subsequent queries (e.g. in Live view, Dashboards, or SQL Workbench)
5050
will filter by that environment. You can select more than one environment at a time, and
5151
hovering an environment reveals a pin icon to save it as your personal default for the
5252
project: that default is applied whenever you open the project.

0 commit comments

Comments
 (0)