[go] Go 언어를 사용한 RESTful API의 로깅 및 추적 기능

07 Dec 2023

RESTful API를 개발할 때, 로깅(logging)과 추적(tracing)은 매우 중요한 요소입니다. 이를 통해 시스템의 동작을 모니터링하고 디버깅할 수 있습니다. 이번 블로그 포스트에서는 Go 언어를 사용하여 RESTful API에서 로깅과 추적을 구현하는 방법에 대해 알아보겠습니다.

로깅(logging)

Go 언어에서 로깅을 구현하는 가장 간단하고 효율적인 방법은 log 패키지를 사용하는 것입니다. 다음은 로깅을 위한 코드 예시입니다.

package main

import (
	"log"
	"net/http"
)

func main() {
	http.HandleFunc("/api", func(w http.ResponseWriter, r *http.Request) {
		log.Println("Received a request to /api")
		// ...
	})
	http.ListenAndServe(":8080", nil)
}

위 코드에서는 /api로 요청이 들어올 때마다 log.Println 함수를 사용하여 로그를 출력합니다. 따라서 서버가 동작하는 동안 로그를 모니터링할 수 있습니다.

로그의 수준(level)을 설정하여 로그의 정보량을 조절할 수도 있습니다. log.SetOutput 함수를 사용하여 로그를 출력하는 위치를 변경할 수도 있습니다.

추적(tracing)

로그를 기록해도, 실제로 시스템에서 어떻게 동작하고 있는지 추적하기는 어렵습니다. 따라서 추적은 로그 외에 추가적인 정보를 기록하는 것을 의미합니다.

Go 언어에서 추적을 구현하기 위해 opentracing이라는 라이브러리를 사용할 수 있습니다. 이 라이브러리를 사용하면 서버와 클라이언트 간의 연결 관계를 추적할 수 있습니다.

package main

import (
	"io"
	"log"
	"net/http"
	"os"

	"github.com/opentracing/opentracing-go"
	"github.com/opentracing/opentracing-go/ext"
	"github.com/uber/jaeger-client-go"
	"github.com/uber/jaeger-client-go/config"
)

func main() {
	cfg, err := config.FromEnv()
	if err != nil {
		log.Fatalf("Failed to load Jaeger config from environment variables: %v", err)
	}

	tracer, closer, err := cfg.NewTracer(config.Logger(jaeger.NullLogger))
	if err != nil {
		log.Fatalf("Failed to initialize Jaeger Tracer: %v", err)
	}
	defer closer.Close()

	opentracing.SetGlobalTracer(tracer)

	http.HandleFunc("/api", func(w http.ResponseWriter, r *http.Request) {
		sp := opentracing.StartSpan("api-request")
		defer sp.Finish()

		ext.SpanKindRPCServer.Set(sp)

		ctx := opentracing.ContextWithSpan(r.Context(), sp)
		r = r.WithContext(ctx)

		// ...
	})

	http.HandleFunc("/another/api", func(w http.ResponseWriter, r *http.Request) {
		sp, ctx := opentracing.StartSpanFromContext(r.Context(), "another-api-request")
		defer sp.Finish()

		ext.SpanKindRPCServer.Set(sp)

		r = r.WithContext(ctx)

		// ...
	})

	http.ListenAndServe(":8080", nil)
}

위 코드에서는 Jaeger를 사용하여 추적을 구현하고 있는 예제입니다. 이를 통해 /api와 /another/api로 요청이 들어올 때마다 추적 정보를 생성하고 추적 스팬을 생성합니다.

추적 정보는 엔드포인트 간의 흐름을 시각화할 수 있으며, 개발자들이 진행 중인 작업을 파악할 수 있도록 도움을 줍니다.

결론

Go 언어를 사용하여 RESTful API의 로깅(logging)과 추적(tracing) 기능을 구현하는 방법에 대해 알아보았습니다. 로깅은 간단한 log 패키지를 사용하여 구현할 수 있으며, 추적은 opentracing 라이브러리를 사용하여 구현할 수 있습니다.

로깅과 추적은 API 개발에서 중요한 역할을 합니다. 이를 통해 시스템을 효율적으로 모니터링하고, 디버깅하는 데 도움이 됩니다.