Skip to content

The only tool you need to know what is happening and how to fix it.

feat: fe and docs updated for the new installation instructions

ddux08889b75e4db
diff --git a/docs/pages/getting-started/local-setup.mdx b/docs/pages/getting-started/local-setup.mdx
index 783dc791..513883db 100644
--- a/docs/pages/getting-started/local-setup.mdx
+++ b/docs/pages/getting-started/local-setup.mdx
@@ -117,7 +117,7 @@ The project token is used by the SDK to send telemetry data.
Once you have a project token, you can connect your Go application:
```go
-import "github.com/tracewayapp/go-client/traceway_gin"
+tracewaygin "go.tracewayapp.com/tracewaygin"
func main() {
router := gin.Default()
diff --git a/docs/pages/gin-middleware/configuration.mdx b/docs/pages/gin-middleware/configuration.mdx
index ac33cee7..aeee885d 100644
--- a/docs/pages/gin-middleware/configuration.mdx
+++ b/docs/pages/gin-middleware/configuration.mdx
@@ -72,7 +72,7 @@ import (
"github.com/gin-gonic/gin"
traceway "go.tracewayapp.com"
- tracewaygin "go.tracewayapp.com/traceway_gin"
+ tracewaygin "go.tracewayapp.com/tracewaygin"
)
func main() {
diff --git a/docs/pages/gin-middleware/index.mdx b/docs/pages/gin-middleware/index.mdx
index 8ed888ff..1b16c8dc 100644
--- a/docs/pages/gin-middleware/index.mdx
+++ b/docs/pages/gin-middleware/index.mdx
@@ -1,11 +1,12 @@
# Gin Middleware
-The `traceway_gin` package provides middleware for the [Gin](https://gin-gonic.com/) web framework. It automatically creates a trace for each request, captures panics, and detects errors from Gin's error chain.
+The `tracewaygin` package provides middleware for the [Gin](https://gin-gonic.com/) web framework. It automatically creates a trace for each request, captures panics, and detects errors from Gin's error chain.
## Installation
```bash
go get go.tracewayapp.com
+go get go.tracewayapp.com/tracewaygin
```
## Basic Setup
@@ -15,7 +16,7 @@ package main
import (
"github.com/gin-gonic/gin"
- tracewaygin "go.tracewayapp.com/traceway_gin"
+ tracewaygin "go.tracewayapp.com/tracewaygin"
)
func main() {
diff --git a/docs/pages/go-client/index.mdx b/docs/pages/go-client/index.mdx
index 2f112668..f6bde764 100644
--- a/docs/pages/go-client/index.mdx
+++ b/docs/pages/go-client/index.mdx
@@ -13,9 +13,9 @@ go get go.tracewayapp.com
| Package | Import | Purpose |
|---------|--------|---------|
| Core | `go.tracewayapp.com` | All tracing, exception, message, metric, and span APIs |
-| Gin Middleware | `go.tracewayapp.com/traceway_gin` | Automatic instrumentation for Gin applications |
-| HTTP Middleware | `go.tracewayapp.com/traceway_http` | Automatic instrumentation for `net/http` servers |
-| DB Instrumentation | `go.tracewayapp.com/traceway_db` | Automatic span creation for `database/sql` operations |
+| Gin Middleware | `go.tracewayapp.com/tracewaygin` | Automatic instrumentation for Gin applications |
+| HTTP Middleware | `go.tracewayapp.com/tracewayhttp` | Automatic instrumentation for `net/http` servers |
+| DB Instrumentation | `go.tracewayapp.com/tracewaydb` | Automatic span creation for `database/sql` operations |
## When to Use Core vs Middleware
diff --git a/docs/pages/go-client/initialization.mdx b/docs/pages/go-client/initialization.mdx
index c65622a3..89ed6d2e 100644
--- a/docs/pages/go-client/initialization.mdx
+++ b/docs/pages/go-client/initialization.mdx
@@ -38,7 +38,7 @@ func main() {
`Init` can only be called once. A second call returns an error.
-When using middleware (`traceway_gin.New` or `traceway_http.New`), initialization is handled automatically — do not call `Init` separately.
+When using middleware (`tracewaygin.New` or `tracewayhttp.New`), initialization is handled automatically — do not call `Init` separately.
## Configuration Options
diff --git a/docs/pages/http-middleware/configuration.mdx b/docs/pages/http-middleware/configuration.mdx
index d97a5dfb..978c0e9c 100644
--- a/docs/pages/http-middleware/configuration.mdx
+++ b/docs/pages/http-middleware/configuration.mdx
@@ -85,7 +85,7 @@ import (
"time"
traceway "go.tracewayapp.com"
- tracewayhttp "go.tracewayapp.com/traceway_http"
+ tracewayhttp "go.tracewayapp.com/tracewayhttp"
)
func main() {
diff --git a/docs/pages/http-middleware/index.mdx b/docs/pages/http-middleware/index.mdx
index d2c3bcc3..a834755c 100644
--- a/docs/pages/http-middleware/index.mdx
+++ b/docs/pages/http-middleware/index.mdx
@@ -1,11 +1,12 @@
# HTTP Middleware
-The `traceway_http` package provides middleware for standard `net/http` servers. It automatically creates a trace for each request, captures panics, and detects client IP addresses.
+The `tracewayhttp` package provides middleware for standard `net/http` servers. It automatically creates a trace for each request, captures panics, and detects client IP addresses.
## Installation
```bash
go get go.tracewayapp.com
+go get go.tracewayapp.com/tracewayhttp
```
## Basic Setup
@@ -16,7 +17,7 @@ package main
import (
"net/http"
- tracewayhttp "go.tracewayapp.com/traceway_http"
+ tracewayhttp "go.tracewayapp.com/tracewayhttp"
)
func main() {
diff --git a/frontend/src/lib/utils/framework-code.ts b/frontend/src/lib/utils/framework-code.ts
index 9f7f98ed..283a2061 100644
--- a/frontend/src/lib/utils/framework-code.ts
+++ b/frontend/src/lib/utils/framework-code.ts
@@ -1,10 +1,10 @@
import type { Framework } from '$lib/state/projects.svelte';
export function getInstallCommand(framework: Framework): string {
- const base = 'go get github.com/traceway-io/go-client';
+ const base = 'go get go.tracewayapp.com';
switch (framework) {
case 'gin':
- return `${base}`;
+ return `${base} && go get go.tracewayapp.com/tracewaygin`;
case 'fiber':
case 'chi':
case 'fasthttp':
@@ -26,12 +26,12 @@ export function getFrameworkCode(framework: Framework, token: string, backendUrl
import (
"github.com/gin-gonic/gin"
- "github.com/traceway-io/go-client/traceway_gin"
+ tracewaygin "go.tracewayapp.com/tracewaygin"
)
func main() {
r := gin.Default()
- r.Use(traceway_gin.New("${connectionString}"))
+ r.Use(tracewaygin.New("${connectionString}"))
r.Run(":8080")
}`;
@@ -46,14 +46,14 @@ func main() {
// We welcome contributions! Please visit our GitHub repository
// to help implement support for ${framework === 'custom' ? 'custom frameworks' : framework}:
//
-// https://github.com/traceway-io/go-client
+// https://github.com/tracewayapp/go-client
//
// In the meantime, you can use the core SDK directly:
package main
import (
- "github.com/traceway-io/go-client"
+ "go.tracewayapp.com"
)
func main() {
diff --git a/frontend/src/routes/+page.svelte b/frontend/src/routes/+page.svelte
index 0b8a8b3f..0431bbbd 100644
--- a/frontend/src/routes/+page.svelte
+++ b/frontend/src/routes/+page.svelte
@@ -93,7 +93,7 @@
const installCommand = $derived(
projectWithToken
? getInstallCommand(projectWithToken.framework)
- : 'go get github.com/traceway-io/go-client'
+ : 'go get go.tracewayapp.com'
);
const testingRouteCode = getTestingRouteCode();
diff --git a/frontend/src/routes/connection/+page.svelte b/frontend/src/routes/connection/+page.svelte
index f2015ed5..6bb728f5 100644
--- a/frontend/src/routes/connection/+page.svelte
+++ b/frontend/src/routes/connection/+page.svelte
@@ -39,7 +39,7 @@
const installCommand = $derived(
projectWithToken
? getInstallCommand(projectWithToken.framework)
- : 'go get github.com/traceway-io/go-client'
+ : 'go get go.tracewayapp.com'
);
async function copyCode() {
diff --git a/website/app/page.tsx b/website/app/page.tsx
index 27caec95..3e6c110a 100644
--- a/website/app/page.tsx
+++ b/website/app/page.tsx
@@ -79,7 +79,7 @@ export default function Home() {
<code className="block">
<span className="text-purple-600 font-semibold">func</span> <span className="text-blue-600 font-semibold">main</span>() {"{"}{"\n"}
{" "}r := gin.<span className="text-blue-600">Default</span>(){"\n"}
- {" "}r.<span className="text-blue-600">Use</span>(traceway_gin.<span className="text-blue-600">New</span>(<span className="text-green-600">"{`{TOKEN}`}@https://{`{SERVER_URL}`}/api/report"</span>)){"\n"}
+ {" "}r.<span className="text-blue-600">Use</span>(tracewaygin.<span className="text-blue-600">New</span>(<span className="text-green-600">"{`{TOKEN}`}@https://{`{SERVER_URL}`}/api/report"</span>)){"\n"}
{"\n"}
{" "}r.<span className="text-blue-600">GET</span>(<span className="text-green-600">"/test"</span>, <span className="text-purple-600 font-semibold">func</span>(ctx *gin.Context) {"{"}{"\n"}
{" "}ctx.<span className="text-blue-600">AbortWithError</span>(<span className="text-orange-600">500</span>, fmt.<span className="text-blue-600">Errorf</span>(<span className="text-green-600">"Worked!"</span>)){"\n"}