The only tool you need to know what is happening and how to fix it.
Go alertingexception-trackerissue-trackinglogsmetricsmonitoringobservability-platformopen-telemetryotelsession-replaytelemetrytraces
feat: Docs updated with print screens
ddux8bc29e245766
diff --git a/docs/pages/client/chi-middleware/index.mdx b/docs/pages/client/chi-middleware/index.mdxindex cb613cf0..cbaa9567 100644--- a/docs/pages/client/chi-middleware/index.mdx+++ b/docs/pages/client/chi-middleware/index.mdx@@ -44,14 +44,14 @@ func main() {The middleware automatically captures for every request:-| Data | Description |-|------|-------------|-| **Endpoint** | HTTP method + URL path (e.g., `GET /api/users`) |-| **Duration** | Request processing time |-| **Status Code** | HTTP response status |-| **Body Size** | Response body size in bytes |-| **Client IP** | Detected from headers or connection |-| **Panics** | Recovered and captured with full stack trace |+| Data | Description |+| --------------- | ----------------------------------------------- |+| **Endpoint** | HTTP method + URL path (e.g., `GET /api/users`) |+| **Duration** | Request processing time |+| **Status Code** | HTTP response status |+| **Body Size** | Response body size in bytes |+| **Client IP** | Detected from headers or connection |+| **Panics** | Recovered and captured with full stack trace |## Client IP Detection@@ -78,6 +78,22 @@ When a panic occurs, the middleware:2. Captures the full stack trace as an issue3. Either re-panics (default, `WithRepanic(true)`) or responds with 500+## Connection package++The connection page in the sidebar will have your projects unique API key and the integration instructions.++<img+ src="/connection.png"+ alt="SDK Connection Setup"+ style={{+ maxWidth: "100%",+ height: "auto",+ marginTop: "16px",+ borderRadius: "8px",+ border: "1px solid #e5e7eb",+ }}+/>+## Next Steps- [Configuration](/client/chi-middleware/configuration) — All options including filtering and passthrough settingsdiff --git a/docs/pages/client/fasthttp-middleware/index.mdx b/docs/pages/client/fasthttp-middleware/index.mdxindex b53f1155..a9c64584 100644--- a/docs/pages/client/fasthttp-middleware/index.mdx+++ b/docs/pages/client/fasthttp-middleware/index.mdx@@ -40,14 +40,14 @@ func main() {The middleware automatically captures for every request:-| Data | Description |-|------|-------------|-| **Endpoint** | HTTP method + URL path (e.g., `GET /api/users`) |-| **Duration** | Request processing time |-| **Status Code** | HTTP response status |-| **Body Size** | Response body size in bytes |-| **Client IP** | Detected from headers or connection |-| **Panics** | Recovered and captured with full stack trace |+| Data | Description |+| --------------- | ----------------------------------------------- |+| **Endpoint** | HTTP method + URL path (e.g., `GET /api/users`) |+| **Duration** | Request processing time |+| **Status Code** | HTTP response status |+| **Body Size** | Response body size in bytes |+| **Client IP** | Detected from headers or connection |+| **Panics** | Recovered and captured with full stack trace |## Client IP Detection@@ -91,6 +91,22 @@ func handler(ctx *fasthttp.RequestCtx) {Context is stored in FastHTTP's `UserValue` store, not in Go's standard `context.Context`.+## Connection package++The connection page in the sidebar will have your projects unique API key and the integration instructions.++<img+ src="/connection.png"+ alt="SDK Connection Setup"+ style={{+ maxWidth: "100%",+ height: "auto",+ marginTop: "16px",+ borderRadius: "8px",+ border: "1px solid #e5e7eb",+ }}+/>+## Next Steps- [Configuration](/client/fasthttp-middleware/configuration) — All options including filtering and passthrough settingsdiff --git a/docs/pages/client/fiber-middleware/index.mdx b/docs/pages/client/fiber-middleware/index.mdxindex dbb36a50..153cc5db 100644--- a/docs/pages/client/fiber-middleware/index.mdx+++ b/docs/pages/client/fiber-middleware/index.mdx@@ -40,15 +40,15 @@ func main() {The middleware automatically captures for every request:-| Data | Description |-|------|-------------|-| **Endpoint** | HTTP method + route path (e.g., `GET /api/users/:id`) |-| **Duration** | Request processing time |-| **Status Code** | HTTP response status |-| **Body Size** | Response body size in bytes |-| **Client IP** | From Fiber's `c.IP()` |-| **Panics** | Recovered and captured with full stack trace |-| **Handler Errors** | Errors returned from handlers |+| Data | Description |+| ------------------ | ----------------------------------------------------- |+| **Endpoint** | HTTP method + route path (e.g., `GET /api/users/:id`) |+| **Duration** | Request processing time |+| **Status Code** | HTTP response status |+| **Body Size** | Response body size in bytes |+| **Client IP** | From Fiber's `c.IP()` |+| **Panics** | Recovered and captured with full stack trace |+| **Handler Errors** | Errors returned from handlers |## Error Detection@@ -109,6 +109,22 @@ app.Get("/api/users", func(c *fiber.Ctx) error {Context is stored in Fiber's `Locals` store.+## Connection package++The connection page in the sidebar will have your projects unique API key and the integration instructions.++<img+ src="/connection.png"+ alt="SDK Connection Setup"+ style={{+ maxWidth: "100%",+ height: "auto",+ marginTop: "16px",+ borderRadius: "8px",+ border: "1px solid #e5e7eb",+ }}+/>+## Next Steps- [Configuration](/client/fiber-middleware/configuration) — All options including filtering and passthrough settingsdiff --git a/docs/pages/client/gin-middleware/index.mdx b/docs/pages/client/gin-middleware/index.mdxindex 5c35c7c2..5a43625d 100644--- a/docs/pages/client/gin-middleware/index.mdx+++ b/docs/pages/client/gin-middleware/index.mdx@@ -40,15 +40,15 @@ func main() {The middleware automatically captures for every request:-| Data | Description |-|------|-------------|-| **Endpoint** | HTTP method + route template (e.g., `GET /api/users/:id`) |-| **Duration** | Request processing time |-| **Status Code** | HTTP response status |-| **Body Size** | Response body size in bytes |-| **Client IP** | From Gin's `ClientIP()` |-| **Panics** | Recovered and captured with full stack trace |-| **Gin Errors** | Errors added via `c.Error()` |+| Data | Description |+| --------------- | --------------------------------------------------------- |+| **Endpoint** | HTTP method + route template (e.g., `GET /api/users/:id`) |+| **Duration** | Request processing time |+| **Status Code** | HTTP response status |+| **Body Size** | Response body size in bytes |+| **Client IP** | From Gin's `ClientIP()` |+| **Panics** | Recovered and captured with full stack trace |+| **Gin Errors** | Errors added via `c.Error()` |## Error Detection@@ -91,6 +91,22 @@ func handler(c *gin.Context) {If the error wraps a `StackTraceError` (from `traceway.NewStackTraceErrorf`), the embedded stack frames are used. Otherwise, the error type and message are recorded.+## Connection package++The connection page in the sidebar will have your projects unique API key and the integration instructions.++<img+ src="/connection.png"+ alt="SDK Connection Setup"+ style={{+ maxWidth: "100%",+ height: "auto",+ marginTop: "16px",+ borderRadius: "8px",+ border: "1px solid #e5e7eb",+ }}+/>+## Next Steps- [Configuration](/client/gin-middleware/configuration) — All options including route filtering and passthrough settingsdiff --git a/docs/pages/client/http-middleware/index.mdx b/docs/pages/client/http-middleware/index.mdxindex 99643aa0..36e9cea8 100644--- a/docs/pages/client/http-middleware/index.mdx+++ b/docs/pages/client/http-middleware/index.mdx@@ -40,14 +40,14 @@ The `New` function returns `func(http.Handler) http.Handler`, so you chain it arThe middleware automatically captures for every request:-| Data | Description |-|------|-------------|-| **Endpoint** | HTTP method + URL path (e.g., `GET /api/users`) |-| **Duration** | Request processing time |-| **Status Code** | HTTP response status |-| **Body Size** | Response body size in bytes |-| **Client IP** | Detected from headers or connection |-| **Panics** | Recovered and captured with full stack trace |+| Data | Description |+| --------------- | ----------------------------------------------- |+| **Endpoint** | HTTP method + URL path (e.g., `GET /api/users`) |+| **Duration** | Request processing time |+| **Status Code** | HTTP response status |+| **Body Size** | Response body size in bytes |+| **Client IP** | Detected from headers or connection |+| **Panics** | Recovered and captured with full stack trace |## ResponseWriter Wrapping@@ -78,6 +78,22 @@ When a panic occurs, the middleware:2. Captures the full stack trace as an issue3. Either re-panics (default, `WithRepanic(true)`) or responds with 500+## Connection package++The connection page in the sidebar will have your projects unique API key and the integration instructions.++<img+ src="/connection.png"+ alt="SDK Connection Setup"+ style={{+ maxWidth: "100%",+ height: "auto",+ marginTop: "16px",+ borderRadius: "8px",+ border: "1px solid #e5e7eb",+ }}+/>+## Next Steps- [Configuration](/client/http-middleware/configuration) — All options and passthrough settingsdiff --git a/docs/pages/client/index.mdx b/docs/pages/client/index.mdxindex e999278c..a7957ff4 100644--- a/docs/pages/client/index.mdx+++ b/docs/pages/client/index.mdx@@ -2,6 +2,6 @@ import FrameworkPicker from "../../components/FrameworkPicker";# Traceway-Traceway is an open-source error tracking and monitoring platform for Go applications. It provides real-time visibility into your application's health through exception tracking, endpoint monitoring, background tasks, and system metrics.+Traceway is an open-source error tracking and monitoring platform for Go applications. It provides real-time visibility into your application's health through exception tracking, endpoint monitoring, background tasks, and system metrics. To learn more about the core concepts of Traceway <a href="/learn">Click Here</a>.<FrameworkPicker />diff --git a/docs/pages/client/sdk/metrics.mdx b/docs/pages/client/sdk/metrics.mdxindex 6e36d854..eecdfd1c 100644--- a/docs/pages/client/sdk/metrics.mdx+++ b/docs/pages/client/sdk/metrics.mdx@@ -2,6 +2,8 @@Metrics are time-series measurements of your application's health. System metrics are collected automatically; you can also capture custom metrics.+<img src="/metrics.png" alt="Metrics Dashboard" style={{ maxWidth: '100%', height: 'auto', marginTop: '16px', borderRadius: '8px', border: '1px solid #e5e7eb' }} />+## CaptureMetricRecord a metric value:diff --git a/docs/pages/learn/attributes.mdx b/docs/pages/learn/attributes.mdxindex 4baaa208..e6717f22 100644--- a/docs/pages/learn/attributes.mdx+++ b/docs/pages/learn/attributes.mdx@@ -54,3 +54,7 @@ service: user-api service: user-api- **Issues** (exceptions and messages) — attributes in scope at capture time are attached to the issueIn the dashboard, attributes appear in the detail view for endpoints, tasks, and issues.++<img src="/attributes-in-endpoint-table.png" alt="Attributes in Endpoint Table" style={{ maxWidth: '100%', height: 'auto', marginTop: '16px', borderRadius: '8px', border: '1px solid #e5e7eb' }} />++<img src="/attributes.png" alt="Attributes on Issue" style={{ maxWidth: '100%', height: 'auto', marginTop: '16px', borderRadius: '8px', border: '1px solid #e5e7eb' }} />diff --git a/docs/pages/learn/issues.mdx b/docs/pages/learn/issues.mdxindex a453a5a0..402d5673 100644--- a/docs/pages/learn/issues.mdx+++ b/docs/pages/learn/issues.mdx@@ -2,6 +2,8 @@Issues capture problems in your application — exceptions, panics, and explicitly sent messages.+<img src="/issues.png" alt="Issues Dashboard" style={{ maxWidth: '100%', height: 'auto', marginTop: '16px', borderRadius: '8px', border: '1px solid #e5e7eb' }} />+## What Creates an IssueAn issue is created when:@@ -29,6 +31,8 @@ This linkage means:- Viewing a trace shows any issues that occurred during execution- Attributes from the trace context are included in the issue+<img src="/endpoint-exception.png" alt="Endpoint with Exception" style={{ maxWidth: '100%', height: 'auto', marginTop: '16px', borderRadius: '8px', border: '1px solid #e5e7eb' }} />+Issues captured outside of a trace context (no active request or task) are recorded as standalone issues without a trace link.## Automatic Groupingdiff --git a/docs/pages/learn/spans.mdx b/docs/pages/learn/spans.mdxindex 17408346..25070b04 100644--- a/docs/pages/learn/spans.mdx+++ b/docs/pages/learn/spans.mdx@@ -32,6 +32,8 @@ In the dashboard:3. Individual traces show their spans as a timeline4. Each span displays its name and duration+<img src="/spans.png" alt="Spans Timeline" style={{ maxWidth: '100%', height: 'auto', marginTop: '16px', borderRadius: '8px', border: '1px solid #e5e7eb' }} />+This helps identify bottlenecks — if a request takes 500ms and 450ms is in a database span, you know where to optimize.## Naming Conventionsdiff --git a/docs/pages/learn/traces.mdx b/docs/pages/learn/traces.mdxindex 23cbe89c..bde89c43 100644--- a/docs/pages/learn/traces.mdx+++ b/docs/pages/learn/traces.mdx@@ -16,6 +16,8 @@ DELETE /api/sessions/:tokenEndpoints are ordered in the dashboard by **Impact**, which factors in both performance and error frequency.+<img src="/endpoints.png" alt="Endpoints Dashboard" style={{ maxWidth: '100%', height: 'auto', marginTop: '16px', borderRadius: '8px', border: '1px solid #e5e7eb' }} />+The middleware captures:| Field | Description |@@ -39,6 +41,8 @@ Tasks are traces created manually for background operations that run outside HTTTasks carry the same data as endpoints (duration, attributes, spans) but without HTTP-specific fields like status code or client IP.+<img src="/tasks.png" alt="Tasks Dashboard" style={{ maxWidth: '100%', height: 'auto', marginTop: '16px', borderRadius: '8px', border: '1px solid #e5e7eb' }} />+## Trace Lifecycle1. A trace is created — either automatically by the client sdk (endpoints) or manually by starting a trace or measuring a taskdiff --git a/docs/public/attributes-in-endpoint-table.png b/docs/public/attributes-in-endpoint-table.pngnew file mode 100644index 00000000..d0f4af0bBinary files /dev/null and b/docs/public/attributes-in-endpoint-table.png differdiff --git a/docs/public/attributes.png b/docs/public/attributes.pngnew file mode 100644index 00000000..c20ae2e0Binary files /dev/null and b/docs/public/attributes.png differdiff --git a/docs/public/connection.png b/docs/public/connection.pngnew file mode 100644index 00000000..17a3a8d1Binary files /dev/null and b/docs/public/connection.png differdiff --git a/docs/public/endpoint-exception.png b/docs/public/endpoint-exception.pngnew file mode 100644index 00000000..4659e371Binary files /dev/null and b/docs/public/endpoint-exception.png differdiff --git a/docs/public/endpoints.png b/docs/public/endpoints.pngnew file mode 100644index 00000000..8ca1d841Binary files /dev/null and b/docs/public/endpoints.png differdiff --git a/docs/public/issues.png b/docs/public/issues.pngnew file mode 100644index 00000000..2e4a94daBinary files /dev/null and b/docs/public/issues.png differdiff --git a/docs/public/metrics.png b/docs/public/metrics.pngnew file mode 100644index 00000000..bef0b17dBinary files /dev/null and b/docs/public/metrics.png differdiff --git a/docs/public/spans.png b/docs/public/spans.pngnew file mode 100644index 00000000..14946483Binary files /dev/null and b/docs/public/spans.png differdiff --git a/docs/public/tasks.png b/docs/public/tasks.pngnew file mode 100644index 00000000..b8d656caBinary files /dev/null and b/docs/public/tasks.png differdiff --git a/printscreens/attributes-in-endpoint-table.png b/printscreens/attributes-in-endpoint-table.pngnew file mode 100644index 00000000..d0f4af0bBinary files /dev/null and b/printscreens/attributes-in-endpoint-table.png differdiff --git a/printscreens/attributes.png b/printscreens/attributes.pngnew file mode 100644index 00000000..c20ae2e0Binary files /dev/null and b/printscreens/attributes.png differdiff --git a/printscreens/connection.png b/printscreens/connection.pngnew file mode 100644index 00000000..17a3a8d1Binary files /dev/null and b/printscreens/connection.png differdiff --git a/printscreens/endpoint-exception.png b/printscreens/endpoint-exception.pngnew file mode 100644index 00000000..4659e371Binary files /dev/null and b/printscreens/endpoint-exception.png differdiff --git a/printscreens/endpoints.png b/printscreens/endpoints.pngnew file mode 100644index 00000000..8ca1d841Binary files /dev/null and b/printscreens/endpoints.png differdiff --git a/printscreens/issues.png b/printscreens/issues.pngnew file mode 100644index 00000000..2e4a94daBinary files /dev/null and b/printscreens/issues.png differdiff --git a/printscreens/metrics.png b/printscreens/metrics.pngnew file mode 100644index 00000000..bef0b17dBinary files /dev/null and b/printscreens/metrics.png differdiff --git a/printscreens/spans.png b/printscreens/spans.pngnew file mode 100644index 00000000..14946483Binary files /dev/null and b/printscreens/spans.png differdiff --git a/printscreens/tasks.png b/printscreens/tasks.pngnew file mode 100644index 00000000..b8d656caBinary files /dev/null and b/printscreens/tasks.png differ