O ClickStack usa o padrão OpenTelemetry para coletar dados de telemetria (logs e traces). Os traces são gerados automaticamente com a instrumentação automática, então a instrumentação manual não é necessária para aproveitar o tracing.
Este guia integra:
| ✅ Logs | ✅ Métricas | ✅ Traces |
Primeiros passos
Instale os pacotes de instrumentação do OpenTelemetry
Para instalar os pacotes Go do OpenTelemetry e do HyperDX, use o comando abaixo. Recomenda-se consultar os pacotes de instrumentação atuais e instalar os pacotes necessários para garantir que as informações de rastreamento sejam associadas corretamente.
go get -u go.opentelemetry.io/otel
go get -u github.com/hyperdxio/otel-config-go
go get -u github.com/hyperdxio/opentelemetry-go
go get -u github.com/hyperdxio/opentelemetry-logs-goExemplo de servidor HTTP nativo (net/http)
Neste exemplo, usaremos net/http/otelhttp.
go get -u go.opentelemetry.io/contrib/instrumentation/net/http/otelhttpConsulte as seções comentadas para saber como instrumentar sua aplicação em Go.
package main
import (
"context"
"io"
"log"
"net/http"
"os"
"github.com/hyperdxio/opentelemetry-go/otelzap"
"github.com/hyperdxio/opentelemetry-logs-go/exporters/otlp/otlplogs"
"github.com/hyperdxio/otel-config-go/otelconfig"
"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
"go.opentelemetry.io/otel/trace"
"go.uber.org/zap"
sdk "github.com/hyperdxio/opentelemetry-logs-go/sdk/logs"
semconv "go.opentelemetry.io/otel/semconv/v1.21.0"
"go.opentelemetry.io/otel/sdk/resource"
)
// configura atributos comuns para todos os logs
func newResource() *resource.Resource {
hostName, _ := os.Hostname()
return resource.NewWithAttributes(
semconv.SchemaURL,
semconv.ServiceVersion("1.0.0"),
semconv.HostName(hostName),
)
}
// anexa o trace id ao log
func WithTraceMetadata(ctx context.Context, logger *zap.Logger) *zap.Logger {
spanContext := trace.SpanContextFromContext(ctx)
if !spanContext.IsValid() {
// ctx não contém um span válido.
// Não há trace metadata para adicionar.
return logger
}
return logger.With(
zap.String("trace_id", spanContext.TraceID().String()),
zap.String("span_id", spanContext.SpanID().String()),
)
}
func main() {
// Inicializa a configuração do OTel e a utiliza em todo o aplicativo
otelShutdown, err := otelconfig.ConfigureOpenTelemetry()
if err != nil {
log.Fatalf("error setting up OTel SDK - %e", err)
}
defer otelShutdown()
ctx := context.Background()
// configura o provider de logger do OpenTelemetry
logExporter, _ := otlplogs.NewExporter(ctx)
loggerProvider := sdk.NewLoggerProvider(
sdk.WithBatcher(logExporter),
)
// encerra o logger de forma controlada para fazer flush dos sinais acumulados antes do término do programa
defer loggerProvider.Shutdown(ctx)
// cria um novo logger com o core zap do OpenTelemetry e o define globalmente
logger := zap.New(otelzap.NewOtelCore(loggerProvider))
zap.ReplaceGlobals(logger)
logger.Warn("hello world", zap.String("foo", "bar"))
http.Handle("/", otelhttp.NewHandler(wrapHandler(logger, ExampleHandler), "example-service"))
port := os.Getenv("PORT")
if port == "" {
port = "7777"
}
logger.Info("** Service Started on Port " + port + " **")
if err := http.ListenAndServe(":"+port, nil); err != nil {
logger.Fatal(err.Error())
}
}
// Use isto para encapsular todos os handlers e adicionar trace metadata ao logger
func wrapHandler(logger *zap.Logger, handler http.HandlerFunc) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
logger := WithTraceMetadata(r.Context(), logger)
logger.Info("request received", zap.String("url", r.URL.Path), zap.String("method", r.Method))
handler(w, r)
logger.Info("request completed", zap.String("path", r.URL.Path), zap.String("method", r.Method))
}
}
func ExampleHandler(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Type", "application/json")
io.WriteString(w, `{"status":"ok"}`)
}Exemplo de aplicação com Gin
Neste exemplo, usaremos gin-gonic/gin.
go get -u go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelginConsulte as seções comentadas para aprender a instrumentar sua aplicação Go.
package main
import (
"context"
"log"
"net/http"
"github.com/gin-gonic/gin"
"github.com/hyperdxio/opentelemetry-go/otelzap"
"github.com/hyperdxio/opentelemetry-logs-go/exporters/otlp/otlplogs"
sdk "github.com/hyperdxio/opentelemetry-logs-go/sdk/logs"
"github.com/hyperdxio/otel-config-go/otelconfig"
"go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin"
"go.opentelemetry.io/otel/trace"
"go.uber.org/zap"
)
// anexa o trace id ao log
func WithTraceMetadata(ctx context.Context, logger *zap.Logger) *zap.Logger {
spanContext := trace.SpanContextFromContext(ctx)
if !spanContext.IsValid() {
// ctx não contém um span válido.
// Não há trace metadata para adicionar.
return logger
}
return logger.With(
zap.String("trace_id", spanContext.TraceID().String()),
zap.String("span_id", spanContext.SpanID().String()),
)
}
func main() {
// Inicializa a configuração do OTel e a utiliza em toda a aplicação
otelShutdown, err := otelconfig.ConfigureOpenTelemetry()
if err != nil {
log.Fatalf("error setting up OTel SDK - %e", err)
}
defer otelShutdown()
ctx := context.Background()
// configura o provider de logger do OpenTelemetry
logExporter, _ := otlplogs.NewExporter(ctx)
loggerProvider := sdk.NewLoggerProvider(
sdk.WithBatcher(logExporter),
)
// encerra o logger de forma controlada para fazer o flush dos sinais acumulados antes do término do programa
defer loggerProvider.Shutdown(ctx)
// cria um novo logger com o core zap do OpenTelemetry e o define globalmente
logger := zap.New(otelzap.NewOtelCore(loggerProvider))
zap.ReplaceGlobals(logger)
// Cria um novo roteador Gin
router := gin.Default()
router.Use(otelgin.Middleware("service-name"))
// Define uma rota que responde a requisições GET na URL raiz
router.GET("/", func(c *gin.Context) {
_logger := WithTraceMetadata(c.Request.Context(), logger)
_logger.Info("Hello World!")
c.String(http.StatusOK, "Hello World!")
})
// Inicia o servidor na porta 7777
router.Run(":7777")
}Configurar variáveis de ambiente
Em seguida, você precisará configurar as seguintes variáveis de ambiente no shell para enviar telemetria ao ClickStack por meio do coletor do OpenTelemetry:
export OTEL_EXPORTER_OTLP_ENDPOINT=https://your-otel-collector:4318 \
OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \
OTEL_SERVICE_NAME='<NAME_OF_YOUR_APP_OR_SERVICE>' \export OTEL_EXPORTER_OTLP_ENDPOINT=https://your-otel-collector:4318 \
OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \
OTEL_SERVICE_NAME='<NAME_OF_YOUR_APP_OR_SERVICE>' \
OTEL_EXPORTER_OTLP_HEADERS='authorization=<YOUR_INGESTION_API_KEY>'A variável de ambiente OTEL_EXPORTER_OTLP_HEADERS contém a chave de API disponível no aplicativo HyperDX em Team Settings → API Keys.