requestid

package
v1.60.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 30, 2025 License: MIT Imports: 3 Imported by: 2

README

Package requestid

Пакет requestid предоставляет утилиты для генерации и хранения уникального идентификатора запроса (request-id) в контексте.

Constants

Header

Константа Header содержит строку "x-request-id", которая представляет собой стандартное имя HTTP-заголовка, используемого для передачи идентификатора запроса.

LogKey

Константа LogKey содержит строку "requestId" — ключ, под которым request-id может сохраняться в логах.

Types

Данный пакет не экспортирует пользовательских типов.

Functions

ToContext(ctx context.Context, value string) context.Context

Сохраняет request-id в переданном контексте и возвращает новый контекст с сохранённым значением.

FromContext(ctx context.Context) string

Извлекает request-id из контекста. Если значение отсутствует, возвращается пустая строка.

Next() string

Генерирует новый случайный request-id длиной 16 байт (в hex-представлении — 32 символа). Использует криптографически безопасный генератор случайных чисел. В случае ошибки вызывает panic.

Usage

import (
	"net/http"
	"github.com/txix-open/isp-kit/requestid"
)

func handler(w http.ResponseWriter, r *http.Request) {
	id := r.Header.Get(requestid.Header)
	if id == "" {
		id = requestid.Next()
	}
	r = r.WithContext(requestid.ToContext(r.Context(), id))
	// теперь можно использовать FromContext(r.Context()) в любом месте
}

Documentation

Index

Constants

View Source
const (
	Header = "x-request-id"
	LogKey = "requestId"
)

Variables

This section is empty.

Functions

func FromContext

func FromContext(ctx context.Context) string

func Next

func Next() string

func ToContext

func ToContext(ctx context.Context, value string) context.Context

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL