Go SDK

Module github.com/kingtechies/linearjeph-sdk/go 1.0.0, MIT licensed, Go 1.21+, standard library only.

Install

go get github.com/kingtechies/linearjeph-sdk/go

The module lives in the public repository github.com/kingtechies/linearjeph-sdk (folder go/, tags go/vX.Y.Z). Pin a version with go get github.com/kingtechies/linearjeph-sdk/[email protected].

Quickstart

package main

import (
	"net/http"
	"os"
	"time"

	linearjeph "github.com/kingtechies/linearjeph-sdk/go"
)

func main() {
	linearjeph.Init(linearjeph.Options{Key: os.Getenv("LINEARJEPH_KEY"), Release: "1.4.2"})
	defer linearjeph.Flush(5 * time.Second)

	mux := http.NewServeMux()
	mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { w.Write([]byte("ok")) })
	http.ListenAndServe(":8080", linearjeph.Recover(mux))
}

Get the key from Dashboard > Maintenance > your application > Reveal key. Go has no exit hook, so call Flush (or Close) before main returns; defer does not run on os.Exit or log.Fatal.

Options

Init(o Options) error returns an error only when Key is empty (the SDK then stays disabled). Calling it again replaces the configuration.

Functions

Every function is safe for concurrent use, returns promptly and recovers from its own panics.

net/http middleware

Recover records one transaction per request (status error for 5xx responses and panics) and captures panics, then re-panics so net/http logs the panic and closes the connection exactly as it would without the SDK. http.ErrAbortHandler is passed through without being reported.

Transaction names are METHOD pattern from the ServeMux pattern on Go 1.23+ (for example GET /items/{id}) and METHOD path on older versions. To avoid one transaction name per id with another router, give a name function:

h := linearjeph.RecoverWith(router, linearjeph.RecoverOptions{
	IgnorePaths: []string{"/health"},
	Name: func(r *http.Request) string { return r.Method + " " + routePattern(r) },
	NoRepanic:   false, // true: answer 500 instead of re-panicking
})

Chi, Gin, Echo and Gorilla all work by wrapping the router as the http.Handler, or with their own middleware that calls CaptureError and StartTransaction.

Panics in goroutines

go func() {
	defer func() { linearjeph.Capture(recover()) }()
	work()
}()

(This swallows the panic. Re-panic after Capture if the process should still crash.)

Cron jobs and heartbeats

func main() {
	linearjeph.Init(linearjeph.Options{Key: os.Getenv("LINEARJEPH_KEY")})
	err := linearjeph.Monitor("nightly-report", 86400, buildReport)
	linearjeph.Flush(5 * time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

The first check-in creates the monitor. A failed run, or no check-in within the interval plus 5 minutes, opens an incident and sends alerts.

Dependency audit

linearjeph.ReportPackages()                  // modules in the running binary
linearjeph.ReportGoSum("go.sum")             // or from files, for example in CI

Each call replaces the previously reported Go package list, so call it once per deploy.

Release tracking in CI

Inject the release at build time:

go build -ldflags "-X main.release=${GITHUB_REF_NAME}+${GITHUB_RUN_NUMBER}" ./cmd/app

var release = "dev"
// ...
linearjeph.Init(linearjeph.Options{Key: key, Release: release})

Sampling, scrubbing and BeforeSend

linearjeph.Init(linearjeph.Options{
	Key:        key,
	SampleRate: 0.5,
	TracesRate: 0.1,
	ScrubKeys:  []string{"ssn"},
	BeforeSend: func(e linearjeph.Event) linearjeph.Event {
		if tags, ok := e["tags"].(map[string]string); ok {
			tags["tenant"] = "acme"
		}
		return e // return nil to drop
	},
})

Tag values under keys containing password, secret, token, authorization, auth, cookie, api_key, session, csrf, bearer, credential or private_key (plus ScrubKeys) become [Filtered], and password=... or Bearer ... in messages is masked. The SDK never reads request headers, bodies or cookies. Sampling is applied before BeforeSend.

Troubleshooting

• Set Debug: true to see dropped requests.
• A 401 prints "ingest key rejected" once and stops sending.
• Events missing at exit: Flush was not called, or the process ended through os.Exit.
• Stack frames from the Go standard library, the module cache and the SDK itself are marked not in-app, so issues group by your code.
• See Troubleshooting and the Ingest HTTP API.