recorder

package module

Go to main page

Versions in this module

v0

v0.5.1

Jul 23, 2026

Changes in this version

type FileBodyStoreConfig

+ MaintenanceMode bool

v0.5.0

Jul 23, 2026

Changes in this version

type BodyValue

+ FinishTo func(io.Writer) error

type Config

+ func (c Config) Validate() error

v0.4.2

Jul 22, 2026

Changes in this version

+ var ErrDebugStreamRecorderClosed = errors.New("recorder: debug stream recorder is closed")

+ type DebugStreamRecorder struct

+ func NewDebugStreamRecorder(config DebugStreamRecorderConfig) (*DebugStreamRecorder, error)

+ func (r *DebugStreamRecorder) Close() error

+ func (r *DebugStreamRecorder) Record(entry *Entry) error

+ func (r *DebugStreamRecorder) ServeHTTP(w http.ResponseWriter, request *http.Request)

+ func (r *DebugStreamRecorder) Stats() DebugStreamRecorderStats

+ type DebugStreamRecorderConfig struct

+ AllowedOrigins []string

+ QueueCapacity int

+ func DefaultDebugStreamRecorderConfig() DebugStreamRecorderConfig

+ type DebugStreamRecorderStats struct

+ Dropped uint64

+ Published uint64

+ SubscriberActive bool

type Recorder

+ func NewMultiRecorder(first Recorder, others ...Recorder) Recorder

v0.4.1

Jul 21, 2026

Changes in this version

+ func RequestWithComment(req *http.Request, comment string) *http.Request

+ func WithRequestComment(ctx context.Context, comment string) context.Context

v0.4.0

Jul 21, 2026

Changes in this version

+ const DefaultMemoryRecorderCapacity

+ const RecorderExtensionVersion

+ var ErrAsyncRecorderClosed = errors.New("recorder: async recorder is closed")

+ func DecryptProtectedValueWith(token string, resolver ProtectionKeyResolver) ([]byte, error)

+ func ProtectedTokenKeyID(token string) (string, error)

+ func SamplingKeyFromContext(ctx context.Context) (string, bool)

+ func VerifyProtectedTokenWith(token string, value []byte, resolver ProtectionKeyResolver) (bool, error)

+ func WithSamplingKey(ctx context.Context, key string) context.Context

+ type AsyncBackpressurePolicy uint8

+ const AsyncBlock

+ const AsyncDropNewest

+ const AsyncDropOldest

+ type AsyncDropHandler func(*Entry, AsyncDropReason) error

+ type AsyncDropReason string

+ const AsyncDropClosed

+ const AsyncDropPolicyNewest

+ const AsyncDropPolicyOldest

+ const AsyncDropTimeoutNewest

+ const AsyncDropTimeoutOldest

+ type AsyncRecorder struct

+ func NewAsyncRecorder(sink Recorder, config AsyncRecorderConfig) (*AsyncRecorder, error)

+ func (r *AsyncRecorder) Close(ctx context.Context) error

+ func (r *AsyncRecorder) Record(entry *Entry) error

+ func (r *AsyncRecorder) Stats() AsyncRecorderStats

+ type AsyncRecorderConfig struct

+ Backpressure AsyncBackpressurePolicy

+ BatchSize int

+ BlockTimeout time.Duration

+ BlockTimeoutPolicy AsyncBackpressurePolicy

+ CloseSink bool

+ DropHandler AsyncDropHandler

+ FlushInterval time.Duration

+ InternalErrorMode InternalErrorMode

+ Logf func(format string, args ...any)

+ OnInternalError func(error)

+ QueueCapacity int

+ func DefaultAsyncRecorderConfig() AsyncRecorderConfig

+ type AsyncRecorderStats struct

+ Accepted uint64

+ BatchesProcessed uint64

+ BlockedRecords uint64

+ Capacity int

+ CurrentlyBlocked int

+ DropHandlerErrors uint64

+ DropHandlerPanics uint64

+ DroppedClosed uint64

+ DroppedNewest uint64

+ DroppedOldest uint64

+ DroppedTimeoutNewest uint64

+ DroppedTimeoutOldest uint64

+ InFlight int

+ MaxBatchSize int

+ MaxBlockTime time.Duration

+ OldestBlockAge time.Duration

+ Pending int

+ Processed uint64

+ SinkErrors uint64

+ SinkPanics uint64

+ TotalBlockTime time.Duration

type BodyWriter

+ Abort func() error

+ Commit func() error

+ type Config struct

+ BodyCapturePolicy BodyCapturePolicy

+ BodyHashAlgorithm string

+ BodyStore BodyStore

+ CaptureCertificates bool

+ CaptureCookies bool

+ CaptureHeaders bool

+ CaptureRawCertificates bool

+ CaptureRawTrace bool

+ CaptureRequestBody bool

+ CaptureResponseBody bool

+ CaptureTLS bool

+ ContentDecoders map[string]ContentDecoder

+ EmbedBodies bool

+ HashBodies bool

+ HeadSamplingPolicy HeadSamplingPolicy

+ InternalErrorMode InternalErrorMode

+ Logf func(format string, args ...any)

+ MaxRequestBodyBytes int64

+ MaxResponseBodyBytes int64

+ OnEntryCompleted OnEntryCompleted

+ OnInternalError func(error)

+ RedactErrorMessage func(string) string

+ Redaction RedactionConfig

+ RetentionPolicy RetentionPolicy

+ SensitiveValueProtection SensitiveValueProtection

+ func DefaultConfig() Config

type Entry

+ Recorder *RecorderEntryExtension

type FileBodyStore

+ func NewFileBodyStore(dir string, config FileBodyStoreConfig) (*FileBodyStore, error)

+ func (s *FileBodyStore) Open(ref string) (io.ReadCloser, error)

+ func (s *FileBodyStore) Reconcile(liveRefs []string, grace time.Duration, dryRun bool) (ReconcileResult, error)

+ func (s *FileBodyStore) Release(ref string) error

+ func (s *FileBodyStore) ReleaseEntryAssets(entry *Entry) error

+ func (s *FileBodyStore) Stats() FileBodyStoreStats

+ type FileBodyStoreConfig struct

+ MaxBytes int64

+ MaxFiles int

+ PartialTTL time.Duration

+ SyncOnCommit bool

+ func DefaultFileBodyStoreConfig() FileBodyStoreConfig

+ type FileBodyStoreStats struct

+ AbortFailures uint64

+ AbortedTotal uint64

+ CommitFailures uint64

+ CommittedBytes int64

+ CommittedFiles int

+ CommittedTotal uint64

+ MaxBytes int64

+ MaxFiles int

+ PartialBytes int64

+ PartialFiles int

+ QuotaRejected uint64

+ RecoveredPartials uint64

+ ReleaseFailures uint64

+ ReleasedTotal uint64

+ WriteFailures uint64

type HARFileRecorder

+ func (r *HARFileRecorder) RecordBatch(entries []*Entry) error

+ type HeadSamplingDecision uint8

+ const HeadSampleDrop

+ const HeadSampleFull

+ const HeadSampleMetadataOnly

+ type HeadSamplingMeta struct

+ ContentLength int64

+ Host string

+ MIMEType string

+ Method string

+ Path string

+ RedirectIndex int

+ SamplingKey string

+ Scheme string

+ TraceID string

+ type HeadSamplingPolicy func(context.Context, HeadSamplingMeta) HeadSamplingDecision

+ func NewRateHeadSampler(fraction float64, sampled, unsampled HeadSamplingDecision) (HeadSamplingPolicy, error)

type JSONStreamRecorder

+ func (r *JSONStreamRecorder) RecordBatch(entries []*Entry) error

type MemoryRecorder

+ func NewMemoryRecorderWithCapacity(capacity int) (*MemoryRecorder, error)

+ func (r *MemoryRecorder) RecordBatch(entries []*Entry) error

+ func (r *MemoryRecorder) Snapshot() ([]*Entry, MemoryRecorderStats)

+ func (r *MemoryRecorder) Stats() MemoryRecorderStats

+ type MemoryRecorderStats struct

+ Capacity int

+ Evicted uint64

+ Retained int

+ type ProtectionKeyResolver func(keyID string) (ProtectionKey, error)

+ type ReconcileResult struct

+ Released int

+ ReleasedBytes int64

+ Scanned int

+ type RecorderEntryExtension struct

+ Error *ErrorInfo

+ ExchangeID string

+ Expect100 *Expect100Info

+ Informational []InformationalResponse

+ Network *NetworkInfo

+ RawTrace []TraceEvent

+ Redaction *RedactionInfo

+ RedirectIndex *int

+ RequestBody *BodyInfo

+ RequestBodyEncoding string

+ RequestTrailers []NameValuePair

+ RequestTransferEncoding []string

+ ResponseBody *BodyInfo

+ ResponseBodyDecoded bool

+ ResponseTrailers []NameValuePair

+ ResponseTransferEncoding []string

+ SchemaVersion string

+ State string

+ TLS *TLSInfo

+ TraceID string

+ type RetentionDecision uint8

+ const DiscardEntry

+ const RetainEntry

+ type RetentionPolicy func(context.Context, *Entry) RetentionDecision

+ type SamplingStats struct

+ AssetReleaseFailures uint64

+ Discarded uint64

+ HeadDropped uint64

+ HeadFull uint64

+ HeadInvalidDecisions uint64

+ HeadMetadataOnly uint64

+ HeadPanics uint64

+ Retained uint64

+ RetentionInvalidDecisions uint64

+ RetentionPanics uint64

type Transport

+ func (t *Transport) SamplingStats() SamplingStats

v0.3.0

Jul 21, 2026

Changes in this version

+ func RequestWithRedaction(req *http.Request, config RedactionConfig) *http.Request

+ func WithRequestRedaction(ctx context.Context, config RedactionConfig) context.Context

type BodyCaptureDecision

+ RedactorOverride BodyRedactor

+ type BodyValue interface

+ Finish func() string

+ type BodyValueProtector interface

+ NewValue func() BodyValue

type Option

+ func WithRedaction(config RedactionConfig) Option

type Options

+ Redaction RedactionConfig

+ type RedactionConfig struct

+ Common RedactionRules

+ Request RedactionRules

+ Response RedactionRules

+ type RedactionRules struct

+ BodyRedactors map[string]BodyRedactor

+ Cookies []string

+ Headers []string

+ JSONFields []string

+ QueryParameters []string

+ XMLElements []string

v0.2.1

Jul 20, 2026

v0.2.0

Jul 20, 2026

Changes in this version

+ const BodyRedactionFailed

+ const BodyRedactionProcessed

+ const BodyRedactionRedacted

+ const BodyRedactionUnchanged

+ func DecryptProtectedValue(token string, key ProtectionKey) ([]byte, error)

+ func VerifyProtectedToken(token string, value []byte, key ProtectionKey) (bool, error)

+ type BodyCaptureDecision struct

+ BodyRedactor BodyRedactor

+ Capture bool

+ Embed bool

+ Hash bool

+ MaxBodyBytes int64

+ type BodyCaptureMeta struct

+ ContentEncoding string

+ ContentLength int64

+ ContentType string

+ Direction BodyDirection

+ Host string

+ Method string

+ Path string

+ RedirectIndex int

+ Scheme string

+ StatusCode int

+ TraceID string

+ type BodyCapturePolicy interface

+ DecideBodyCapture func(context.Context, BodyCaptureMeta, BodyCaptureDecision) (BodyCaptureDecision, error)

+ type BodyCapturePolicyFunc func(context.Context, BodyCaptureMeta, BodyCaptureDecision) (BodyCaptureDecision, error)

+ func (f BodyCapturePolicyFunc) DecideBodyCapture(ctx context.Context, meta BodyCaptureMeta, defaults BodyCaptureDecision) (BodyCaptureDecision, error)

+ type BodyDirection string

+ const RequestBody

+ const ResponseBody

+ type BodyRedactionInfo struct

+ Kind string

+ Outcome string

+ Protection *ProtectionCounts

+ Replacements *int64

+ type BodyRedactionReport struct

+ Protection ProtectionCounts

+ Replacements int64

+ type BodyRedactionReporter interface

+ BodyRedactionReport func() BodyRedactionReport

+ type BodyRedactor interface

+ Redact func(dst io.Writer, contentType string) (io.WriteCloser, error)

type Entry

+ Redaction *RedactionInfo

type Option

+ func WithBodyCapturePolicy(policy BodyCapturePolicy) Option

+ func WithBodyRedactor(mediaType string, redactor BodyRedactor) Option

+ func WithSensitiveValueProtection(config SensitiveValueProtection) Option

type Options

+ BodyCapturePolicy BodyCapturePolicy

+ BodyRedactors map[string]BodyRedactor

+ SensitiveValueProtection SensitiveValueProtection

+ type ProtectionCounts struct

+ Encrypted int64

+ Fallbacks map[string]int64

+ Redacted int64

+ Tokenized int64

+ type ProtectionKey struct

+ ID string

+ Key []byte

+ type ProtectionKeyProvider interface

+ ProtectionKey func(mode ProtectionMode) (ProtectionKey, error)

+ type ProtectionKeyProviderFunc func(ProtectionMode) (ProtectionKey, error)

+ func (f ProtectionKeyProviderFunc) ProtectionKey(mode ProtectionMode) (ProtectionKey, error)

+ type ProtectionMode string

+ const ProtectionEncrypt

+ const ProtectionRedact

+ const ProtectionTokenize

+ type RedactionInfo struct

+ Errors int64

+ RawTrace int64

+ Request *RedactionScopeInfo

+ Response *RedactionScopeInfo

+ type RedactionScopeInfo struct

+ Body *BodyRedactionInfo

+ Cookies int64

+ Headers int64

+ Protection *ProtectionCounts

+ QueryParameters int64

+ URL int64

+ type SensitiveValueProtection struct

+ KeyProvider ProtectionKeyProvider

+ MaxValueBytes int

+ Mode ProtectionMode

v0.1.1

Jul 20, 2026

v0.1.0

Jul 18, 2026

Changes in this version

+ const PhaseConnect

+ const PhaseContext

+ const PhaseDNS

+ const PhaseProxy

+ const PhaseReadResponseBody

+ const PhaseReadResponseHeaders

+ const PhaseRedirect

+ const PhaseRequestSetup

+ const PhaseTLS

+ const PhaseUnknown

+ const PhaseWaitResponse

+ const PhaseWriteRequest

+ const PhaseWriteRequestBody

+ const StateClosedEarly

+ const StateCompleted

+ const StateCreated

+ const StateFailed

+ const StateRequestBodyStreaming

+ const StateRequestHeadersWritten

+ const StateRequestStarted

+ const StateResponseBodyStreaming

+ const StateResponseHeadersReceived

+ func DefaultRedactedHeaders() []string

+ func DeflateDecoder(r io.Reader) (io.ReadCloser, error)

+ func GzipDecoder(r io.Reader) (io.ReadCloser, error)

+ func TraceContext(ctx context.Context) (context.Context, string)

+ func TraceIDFromContext(ctx context.Context) (string, bool)

+ func WithTraceID(ctx context.Context, id string) context.Context

+ type BodyInfo struct

+ CapturedBytes int64

+ CloseError string

+ ClosedEarly bool

+ Complete bool

+ Hash string

+ HashAlgorithm string

+ Present bool

+ ReadError string

+ Store string

+ TotalBytes int64

+ Truncated bool

+ type BodyMetadata struct

+ ContentType string

+ Direction string

+ ExchangeID string

+ SizeHint int64

+ type BodyStore interface

+ NewWriter func(ctx context.Context, metadata BodyMetadata) (BodyWriter, error)

+ type BodyWriter interface

+ Bytes func() ([]byte, error)

+ Close func() error

+ Ref func() string

+ type Cache struct

+ type CertInfo struct

+ DNSNames []string

+ IPAddresses []string

+ Issuer string

+ NotAfter string

+ NotBefore string

+ PublicKeyAlgorithm string

+ RawDER string

+ SHA256Fingerprint string

+ SerialNumber string

+ SignatureAlgorithm string

+ Subject string

+ type Content struct

+ Comment string

+ Compression int64

+ Decoded bool

+ Encoding string

+ MimeType string

+ Size int64

+ Text string

+ type ContentDecoder func(io.Reader) (io.ReadCloser, error)

+ type Cookie struct

+ Domain string

+ Expires string

+ HTTPOnly bool

+ Name string

+ Path string

+ Secure bool

+ Value string

+ type Creator struct

+ Name string

+ Version string

+ type Entry struct

+ Cache *Cache

+ Comment string

+ Connection string

+ Error *ErrorInfo

+ ExchangeID string

+ Expect100 *Expect100Info

+ Informational []InformationalResponse

+ Network *NetworkInfo

+ RawTrace []TraceEvent

+ RedirectIndex *int

+ Request *Request

+ RequestBody *BodyInfo

+ RequestTrailers []NameValuePair

+ RequestTransferEncoding []string

+ Response *Response

+ ResponseBody *BodyInfo

+ ResponseTrailers []NameValuePair

+ ResponseTransferEncoding []string

+ ServerIPAddress string

+ StartedDateTime string

+ State string

+ TLS *TLSInfo

+ Time float64

+ Timings *Timings

+ TraceID string

+ func (e *Entry) StartTime() time.Time

+ type ErrorInfo struct

+ Cause string

+ ContextCanceled bool

+ ContextDeadlineExceeded bool

+ Message string

+ Phase string

+ Temporary bool

+ Timeout bool

+ Type string

+ UnwrapChain []string

+ type Expect100Info struct

+ ContinueReceived bool

+ WaitMS float64

+ Waited bool

+ type FileBodyStore struct

+ Dir string

+ func (s FileBodyStore) NewWriter(_ context.Context, meta BodyMetadata) (BodyWriter, error)

+ type HAR struct

+ Log *Log

+ func NewHAR(entries []*Entry) *HAR

+ func (h *HAR) Write(w io.Writer) error

+ type HARFileRecorder struct

+ func NewHARFileRecorder(path string) *HARFileRecorder

+ func (r *HARFileRecorder) Close() error

+ func (r *HARFileRecorder) EntriesByTrace(traceID string) []*Entry

+ func (r *HARFileRecorder) Flush() error

+ func (r *HARFileRecorder) Record(e *Entry)

+ func (r *HARFileRecorder) RemoveTrace(traceID string) int

+ func (r *HARFileRecorder) TakeTrace(traceID string) []*Entry

+ type InformationalResponse struct

+ Headers []NameValuePair

+ Status int

+ type InternalErrorMode int

+ const InternalErrorIgnore

+ const InternalErrorLog

+ type JSONStreamRecorder struct

+ func NewJSONStreamRecorder(w io.Writer) *JSONStreamRecorder

+ func (r *JSONStreamRecorder) Err() error

+ func (r *JSONStreamRecorder) Record(e *Entry)

+ type Log struct

+ Comment string

+ Creator *Creator

+ Entries []*Entry

+ Version string

+ type MemoryBodyStore struct

+ func (MemoryBodyStore) NewWriter(_ context.Context, meta BodyMetadata) (BodyWriter, error)

+ type MemoryRecorder struct

+ func NewMemoryRecorder() *MemoryRecorder

+ func (r *MemoryRecorder) Entries() []*Entry

+ func (r *MemoryRecorder) EntriesByTrace(traceID string) []*Entry

+ func (r *MemoryRecorder) HAR() *HAR

+ func (r *MemoryRecorder) HARForTrace(traceID string) *HAR

+ func (r *MemoryRecorder) Len() int

+ func (r *MemoryRecorder) Record(e *Entry)

+ func (r *MemoryRecorder) RemoveTrace(traceID string) int

+ func (r *MemoryRecorder) Reset()

+ func (r *MemoryRecorder) TakeTrace(traceID string) []*Entry

+ func (r *MemoryRecorder) WriteHAR(w io.Writer) error

+ type NameValuePair struct

+ Comment string

+ Name string

+ Value string

+ type NetworkInfo struct

+ ConnectionReused bool

+ DNSAddresses []string

+ DNSCoalesced bool

+ HTTP2 bool

+ IPVersion string

+ IdleTimeMS float64

+ LocalAddress string

+ Network string

+ Proxy string

+ PutIdle *PutIdleInfo

+ RemoteAddress string

+ WasIdle bool

+ type OnEntryCompleted func(context.Context, *Entry)

+ type Option func(*Options)

+ func WithBodyStore(s BodyStore) Option

+ func WithCaptureCertificates(v, raw bool) Option

+ func WithCaptureCookies(v bool) Option

+ func WithCaptureHeaders(v bool) Option

+ func WithCaptureRawTrace(v bool) Option

+ func WithCaptureRequestBody(v bool) Option

+ func WithCaptureResponseBody(v bool) Option

+ func WithCaptureTLS(v bool) Option

+ func WithContentDecoder(encoding string, dec ContentDecoder) Option

+ func WithEmbedBodies(v bool) Option

+ func WithErrorRedactor(fn func(string) string) Option

+ func WithHashBodies(enabled bool, algorithm string) Option

+ func WithInternalErrorMode(m InternalErrorMode) Option

+ func WithLogf(fn func(format string, args ...any)) Option

+ func WithMaxRequestBodyBytes(n int64) Option

+ func WithMaxResponseBodyBytes(n int64) Option

+ func WithOnEntryCompleted(fn OnEntryCompleted) Option

+ func WithOnInternalError(fn func(error)) Option

+ func WithOptions(o Options) Option

+ func WithRedactCookies(names ...string) Option

+ func WithRedactHeaders(names ...string) Option

+ func WithRedactJSONFields(names ...string) Option

+ func WithRedactQueryParameters(names ...string) Option

+ func WithRedactXMLElements(names ...string) Option

+ type Options struct

+ BodyHashAlgorithm string

+ BodyStore BodyStore

+ CaptureCertificates bool

+ CaptureCookies bool

+ CaptureHeaders bool

+ CaptureRawCertificates bool

+ CaptureRawTrace bool

+ CaptureRequestBody bool

+ CaptureResponseBody bool

+ CaptureTLS bool

+ ContentDecoders map[string]ContentDecoder

+ EmbedBodies bool

+ HashBodies bool

+ InternalErrorMode InternalErrorMode

+ Logf func(format string, args ...any)

+ MaxRequestBodyBytes int64

+ MaxResponseBodyBytes int64

+ OnEntryCompleted OnEntryCompleted

+ OnInternalError func(error)

+ RedactCookies []string

+ RedactErrorMessage func(string) string

+ RedactHeaders []string

+ RedactJSONFields []string

+ RedactQueryParameters []string

+ RedactXMLElements []string

+ func DefaultOptions() Options

+ type PostData struct

+ Comment string

+ Encoding string

+ MimeType string

+ Params []PostParam

+ Text string

+ type PostParam struct

+ ContentType string

+ FileName string

+ Name string

+ Value string

+ type PutIdleInfo struct

+ Error string

+ Returned bool

+ type Recorder interface

+ Record func(entry *Entry)

+ type RecorderFunc func(*Entry)

+ func (f RecorderFunc) Record(e *Entry)

+ type Request struct

+ BodySize int64

+ Comment string

+ Cookies []Cookie

+ HTTPVersion string

+ Headers []NameValuePair

+ HeadersSize int64

+ Method string

+ PostData *PostData

+ QueryString []NameValuePair

+ URL string

+ type Response struct

+ BodySize int64

+ Comment string

+ Content *Content

+ Cookies []Cookie

+ HTTPVersion string

+ Headers []NameValuePair

+ HeadersSize int64

+ RedirectURL string

+ Status int

+ StatusText string

+ type TLSInfo struct

+ CipherSuite string

+ DidResume bool

+ HandshakeComplete bool

+ NegotiatedProtocol string

+ OCSPStapled bool

+ PeerCertificates []CertInfo

+ SCTCount int

+ ServerName string

+ VerifiedChains int

+ Version string

+ type Timings struct

+ Blocked float64

+ Comment string

+ Connect float64

+ DNS float64

+ Receive float64

+ SSL float64

+ Send float64

+ Wait float64

+ type TraceEvent struct

+ Detail string

+ Name string

+ Time string

+ type TraceStore interface

+ EntriesByTrace func(traceID string) []*Entry

+ RemoveTrace func(traceID string) int

+ TakeTrace func(traceID string) []*Entry

+ type Transport struct

+ Base http.RoundTripper

+ Options Options

+ Recorder Recorder

+ func NewTransport(base http.RoundTripper, rec Recorder, opts ...Option) *Transport

+ func (t *Transport) CloseIdleConnections()

+ func (t *Transport) RoundTrip(req *http.Request) (*http.Response, error)

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