Мониторинг Go приложений с помощью Proto Observability

FROM golang:1.24

WORKDIR /home/apm-tutorial-golang

COPY go.mod ./
COPY go.sum ./
RUN go mod download

#Copy notes application
COPY notes notes/
COPY cmd/notes cmd/notes/ 

# добавление инструментации
RUN go install github.com/DataDog/orchestrion@latest
RUN orchestrion pin
RUN orchestrion go build -o cmd/notes/notes ./cmd/notes

#Set sample rate
ENV DD_TRACE_SAMPLE_RATE 1

#Run application
ENTRYPOINT ["./cmd/notes/notes"]  

POBP_DOGSTATSD_NON_LOCAL_TRAFFIC=true

package main

import (
    "git.proto.group/protoobp/pobp-trace-go/pobptrace/tracer"
)

func main() {
	tracer.Start(
		tracer.WithService("test-server"), 				// имя сервиса 
		tracer.WithRuntimeMetrics(),       				// включение передачи Go метрик
		tracer.WithAgentAddr("protoobp-agent"),	        // адрес по которому доступен ProtoOBP агент
		tracer.WithDogstatsdAddress("protoobp-agent"),	// адрес по которому доступен ProtoOBP агент
	)

    defer tracer.Stop()
}

package main

import (
    "git.proto.group/protoobp/pobp-trace-go/pobptrace/tracer"
)

func main() {
	tracer.Start(
		tracer.WithService("test-server"), 				// имя сервиса 
		tracer.WithRuntimeMetrics(),       				// включение передачи Go метрик
	)

    defer tracer.Stop()
}

//Создание спана с эндпонитом /user, который дочерный к родительскому спану.
span := tracer.StartSpan("mainOp", tracer.ResourceName("/user"), tracer.ChildOf(parentSpan))

// Создание спана, который будет дочерним к спану в контексте ctx, если в контексте есть спан.
// Возвращает новый спан, и новый контекст, содержащий спан.
span, ctx := tracer.StartSpanFromContext(ctx, "mainOp", tracer.ResourceName("/user"))

package main

import (
	"io/ioutil"
	"log"

	"git.proto.group/protoobp/pobp-trace-go/pobptrace/ext"
	"git.proto.group/protoobp/pobp-trace-go/pobptrace/tracer"
)

func main() {
	// Запускаем трейсер и не забывает про Stop.
	tracer.Start(tracer.WithAgentAddr("host:port"))
	defer tracer.Stop()

	// Начинаем корневой спан.
	span := tracer.StartSpan("get.data")
	defer span.Finish()

	// Создаем дочерный спан, вычисляем время, необходимое для открытия файла.
	child := tracer.StartSpan("read.file", tracer.ChildOf(span.Context()))
	child.SetTag(ext.ResourceName, "test.json")

	// Выполняем операцию.
	_, err := ioutil.ReadFile("~/test.json")

	// Мы можем завершить дочерный спан используя возвращаемую ошибку. Если это 
	// nil, будет отброшено.
	child.Finish(tracer.WithError(err))
	if err != nil {
		log.Fatal(err)
	}
}

package main

import (
    "log"
    "net/http"

    "git.proto.group/protoobp/pobp-trace-go/pobptrace/tracer"
)

func handler(w http.ResponseWriter, r *http.Request) {
    // Создание спана для web request для запросов к /posts.
	// ResourceName - имя эндпоинта в Proto OBP
    span := tracer.StartSpan("web.request", tracer.ResourceName("/posts"))
    defer span.Finish()

    // Добавляем тег
    span.SetTag("http.url", r.URL.Path)
    span.SetTag("<TAG_KEY>", "<TAG_VALUE>")
}

func main() {
    tracer.Start(tracer.WithService("<SERVICE_NAME>"))
    defer tracer.Stop()
    http.HandleFunc("/posts", handler)
    log.Fatal(http.ListenAndServe(":8080", nil))
}

package main

import (
    "log"
    "net/http"

    "git.proto.group/protoobp/pobp-trace-go/pobptrace/tracer"
)

func handler(w http.ResponseWriter, r *http.Request) {
    // Создание спана для web request для запросов к /posts.
	// ResourceName - имя эндпоинта в Proto OBP
    span := tracer.StartSpan("web.request", tracer.ResourceName("/posts"))
    defer span.Finish()

    // Добавляем тег
    span.SetTag("http.url", r.URL.Path)
	//Добавляем HTTP заголовк в тэг трейса
    span.SetTag("http.request.headers.x-request-id", "<VALUE>")
}

func main() {
    tracer.Start(tracer.WithService("<SERVICE_NAME>"))
    defer tracer.Stop()
    http.HandleFunc("/posts", handler)
    log.Fatal(http.ListenAndServe(":8080", nil))
}

package main

import (
    "net/http"

    "git.proto.group/protoobp/pobp-trace-go/pobptrace/tracer"
)

func handler(w http.ResponseWriter, r *http.Request) {
    // Спан для веб запроса связанный с Go Context.
    if span, ok := tracer.SpanFromContext(r.Context()); ok {
        // добавляем тег.
        span.SetTag("http.url", r.URL.Path)
    }
}

package main

import (
    "net/http"

    "git.proto.group/protoobp/pobp-trace-go/pobptrace/tracer"
)

func handler(w http.ResponseWriter, r *http.Request) {
    span, ctx := tracer.StartSpanFromContext(r.Context(), "post.process")
    defer span.Finish()

    req, err := http.NewRequest("GET", "http://example.com", nil)
    req = req.WithContext(ctx)
    // Внедрение Context хедеры Request
    err = tracer.Inject(span.Context(), tracer.HTTPHeadersCarrier(req.Header))
    if err != nil {
        // Обработка или логгирование ошибки внедрения контекста
    }
    http.DefaultClient.Do(req)
}

package main

import (
    "net/http"

    "git.proto.group/protoobp/pobp-trace-go/pobptrace/tracer"
)

func handler(w http.ResponseWriter, r *http.Request) {
    // Извлекаем контекст спана и продолжаем трейс в этом сервисе
    sctx, err := tracer.Extract(tracer.HTTPHeadersCarrier(r.Header))
    if err != nil {
        // Обработка или логгирование ошибки извлечения контекста
    }

    span := tracer.StartSpan("post.filter", tracer.ChildOf(sctx))
    defer span.Finish()
}

err := someOperation()
span.Finish(tracer.WithError(err))

func main() {
	span, ctx := tracer.StartSpanFromContext(context.Background(), "mainOp")
	defer span.Finish()

	go func() {
		asyncSpan := tracer.StartSpanFromContext(ctx, "asyncOp")
		defer asyncSpan.Finish()
		performOp()
	}()
}

package main

import (
	opentracing "github.com/opentracing/opentracing-go"

	"git.proto.group/protoobp/pobp-trace-go/pobptrace/opentracer"
	"git.proto.group/protoobp/pobp-trace-go/pobptrace/tracer"
)

func main() {
	//Запускаем POBP tracer, опционально передаем опции (лучше все определить через переменные окружения),
	// возвращем opentracing.Tracer который оборачивает его.
	t := opentracer.New(tracer.WithAgentAddr("host:port"))
	defer tracer.Stop() // не забываем останавливать, иначе трейсы не придут

	// Используем с Opentracing API. Уже запущенный POBP tracer
	// может быть использован параллельно с Opentracing API если нужно.
	opentracing.SetGlobalTracer(t)
}