Go - Squasher

Send Go errors to Squasher in one of two ways: log them with the squasher-go handler for log/slog, or record them on spans with OpenTelemetry. This page is tested with squasher-go v0.1.0 and OpenTelemetry Go 1.46 on Go 1.27.

Path	Use it when
slog handler	Your service logs with `log/slog`, and you want no other setup.
OpenTelemetry	Your service has traces, or you want an environment on each issue.

Send logs with the slog handler

Install the module

go get github.com/squasher-ai/[email protected]

The module needs Go 1.21 or later. To get your ingest key and project ID, see Create an ingest key.

Create the handler

main.go

package main

import (
	"context"
	"errors"
	"log/slog"
	"os"
	"time"

	squasher "github.com/squasher-ai/squasher-go"
)

func main() {
	handler := squasher.NewHandler(
		os.Getenv("SQUASHER_API_KEY"),
		os.Getenv("SQUASHER_PROJECT_ID"),
		squasher.WithLevel(slog.LevelInfo),
	)
	defer handler.Close()

	logger := slog.New(handler).With("service", "checkout-api")
	slog.SetDefault(logger)

	logger.Error("checkout failed", "error", errors.New("card declined"), "order_id", "ord_123")

	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
	defer cancel()
	_ = handler.Flush(ctx)
}

The handler sends each record as one event. Records at slog.LevelError become issues, titled with the log message. The attributes go to the event as tags and extra data, and an error value becomes its message text. A service attribute sets the service name in Squasher. Flush waits until the queued records are sent. Close sends the rest and stops the handler. Call one of them before the process exits, or the last records are lost.

Handler options

Option	Default	Description
`WithLevel(level)`	`slog.LevelDebug`	The lowest level that the handler sends.
`WithBufferSize(n)`	`100`	The number of records that can wait to be sent.
`WithHTTPClient(client)`	An `http.Client` with a 5 s timeout	The client for requests to Squasher.
`WithEndpoint(url)`	`https://ingest.squasher.ai`	The ingest URL.

When the ingest key or the project ID is empty, the handler sends nothing.

Handler limits

The handler sends no environment. Automatic AI triage runs only on production issues, so it does not run on these issues. To triage one, select Run triage in the Squasher triage card on the issue page. For an environment, use OpenTelemetry.
The handler sends no stack traces.
It sends one HTTP request for each record, without batches or retries. When the queue is full, or when a request fails, the record is lost.

Send errors with OpenTelemetry

Install the modules

go get go.opentelemetry.io/otel go.opentelemetry.io/otel/sdk \
  go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp

Set the exporter variables

export OTEL_SERVICE_NAME=checkout-api
export OTEL_RESOURCE_ATTRIBUTES=deployment.environment.name=production
export OTEL_EXPORTER_OTLP_ENDPOINT=https://ingest.squasher.ai
export OTEL_EXPORTER_OTLP_HEADERS="x-squasher-key=$SQUASHER_API_KEY"

This guide uses the HTTP exporter. OTLP requests do not need the project ID. If your Go deployment uses the gRPC exporter, send it to the Collector URL on port 443 as described in Send over gRPC.

Start a tracer provider

main.go

package main

import (
	"context"
	"log"

	"go.opentelemetry.io/otel"
	"go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp"
	"go.opentelemetry.io/otel/sdk/resource"
	sdktrace "go.opentelemetry.io/otel/sdk/trace"
)

func main() {
	ctx := context.Background()

	// Reads OTEL_EXPORTER_OTLP_ENDPOINT and OTEL_EXPORTER_OTLP_HEADERS.
	exporter, err := otlptracehttp.New(ctx)
	if err != nil {
		log.Fatal(err)
	}

	// Reads OTEL_SERVICE_NAME and OTEL_RESOURCE_ATTRIBUTES.
	res, err := resource.New(ctx, resource.WithFromEnv())
	if err != nil {
		log.Fatal(err)
	}

	provider := sdktrace.NewTracerProvider(
		sdktrace.WithBatcher(exporter),
		sdktrace.WithResource(res),
	)
	defer provider.Shutdown(ctx)
	otel.SetTracerProvider(provider)

	// Start your server here.
}

provider.Shutdown sends the spans that are still queued.

Record errors on spans

checkout.go

package main

import (
	"context"

	"go.opentelemetry.io/otel"
	"go.opentelemetry.io/otel/codes"
)

func chargeCard(ctx context.Context, order Order) error {
	ctx, span := otel.Tracer("checkout").Start(ctx, "charge-card")
	defer span.End()

	if err := payments.Charge(ctx, order); err != nil {
		span.RecordError(err)
		span.SetStatus(codes.Error, err.Error())
		return err
	}
	return nil
}

A span with the error status becomes an issue, titled with the status description, for example card declined. RecordError on a span without the error status also makes an issue, titled with the error message.

Send a test error

slog handler: run slog.Error("Squasher test error"), then call handler.Flush.
OpenTelemetry: end a span with span.SetStatus(codes.Error, "Squasher test error"), then call provider.Shutdown.

Then select Issues in the sidebar of your project. If the error does not appear, see Troubleshooting. To post errors without a module, use the HTTP API.

Give the setup to a coding agent

Copy this prompt into your coding agent to set up Go the same way:

Send this Go service's errors to Squasher. If it logs with log/slog, run go get
github.com/squasher-ai/[email protected], create squasher.NewHandler(os.Getenv("SQUASHER_API_KEY"),
os.Getenv("SQUASHER_PROJECT_ID"), squasher.WithLevel(slog.LevelInfo)), set it as the default slog
logger, and call handler.Close() before exit. If the service uses OpenTelemetry, use the otlptracehttp
exporter with OTEL_EXPORTER_OTLP_ENDPOINT=https://ingest.squasher.ai and
OTEL_EXPORTER_OTLP_HEADERS=x-squasher-key=<key>, and call span.SetStatus(codes.Error, err.Error()) on
failures. Verify with one error named "Squasher test error".

Next steps

OpenTelemetry

See which OTLP data Squasher accepts.

HTTP API

Post events without a module.

Read AI triage

Learn what the triage summary tells you.

Troubleshooting

Find out why an event does not appear.

Get started

Guides

Go

Send logs with the slog handler

Handler options

Handler limits

Send errors with OpenTelemetry

Send a test error

Give the setup to a coding agent

Next steps

OpenTelemetry

HTTP API

Read AI triage

Troubleshooting

​Send logs with the slog handler

​Handler options

​Handler limits

​Send errors with OpenTelemetry

​Send a test error

​Give the setup to a coding agent

​Next steps

OpenTelemetry

HTTP API

Read AI triage

Troubleshooting

Send logs with the slog handler

Handler options

Handler limits

Send errors with OpenTelemetry

Send a test error

Give the setup to a coding agent

Next steps