webpprof

package module

Go to main page

Versions in this module

v0

v0.6.1

Aug 24, 2026

v0.6.0

Aug 24, 2026

Changes in this version

type Middleware

+ WorkDuration *time.Duration

+ WorkSpans []MiddlewareWorkSpan

+ type MiddlewareWorkSpan struct

+ Duration time.Duration

+ Offset time.Duration

v0.5.0

Aug 24, 2026

Changes in this version

+ func LogCallable(callable Callable)

+ func LogCallableContext(ctx context.Context, callable Callable)

+ func LogTask(task Task)

+ func LogTaskContext(ctx context.Context, task Task)

+ func WithoutCorrelation(ctx context.Context) context.Context

+ type Callable struct

+ Callsite []SourceFrame

+ Error string

+ Name string

+ Panic string

+ Payload any

+ Result any

+ State string

+ type CallableAnalysis struct

+ CallableDurationNS int64

+ CallableID string

+ Findings []Finding

+ GeneratedAt time.Time

type FindingCode

+ const FindingExecutionBottleneck

+ const FindingQueryPlanIssue

+ const FindingSQLDominatesCallable

+ const FindingSQLDominatesSchedule

+ const FindingSQLDominatesTask

+ const FindingSlowCallable

+ const FindingSlowEvent

+ const FindingSlowSchedule

+ const FindingSlowTask

type Kind

+ const KindCallable

+ const KindTask

type Measurement

+ func MeasureTask(ctx context.Context, task Task, fn func(context.Context) error) Measurement

type Option

+ func WithSidebarKinds(kinds ...Kind) Option

type Profiler

+ func (p *Profiler) AnalyzeCallable(callableID string) (CallableAnalysis, bool)

+ func (p *Profiler) AnalyzeSchedule(scheduleID string) (ScheduleAnalysis, bool)

+ func (p *Profiler) AnalyzeTask(taskID string) (TaskAnalysis, bool)

+ func (p *Profiler) LogCallable(callable Callable)

+ func (p *Profiler) LogCallableContext(ctx context.Context, callable Callable)

+ func (p *Profiler) LogTask(task Task)

+ func (p *Profiler) LogTaskContext(ctx context.Context, task Task)

+ func (p *Profiler) MeasureTask(ctx context.Context, task Task, fn func(context.Context) error) Measurement

+ func (p *Profiler) StartTask(ctx context.Context, task Task) *TaskSpan

type QueryPlan

+ Issues []QueryPlanIssue

+ type QueryPlanIssue struct

+ Code QueryPlanIssueCode

+ Detail string

+ EstimatedRows int64

+ Relation string

+ func DetectQueryPlanIssues(driverName, planText string) []QueryPlanIssue

+ type QueryPlanIssueCode string

+ const QueryPlanIssueFullScan

+ const QueryPlanIssueLargeEstimate

+ const QueryPlanIssueTemporarySort

+ type ScheduleAnalysis struct

+ Findings []Finding

+ GeneratedAt time.Time

+ ScheduleDurationNS int64

+ ScheduleID string

type Stats

+ SidebarKinds []Kind

+ type Task struct

+ Callsite []SourceFrame

+ Error string

+ Fields map[string]any

+ Name string

+ Panic string

+ State string

+ type TaskAnalysis struct

+ Findings []Finding

+ GeneratedAt time.Time

+ TaskDurationNS int64

+ TaskID string

+ type TaskResult struct

+ Err error

+ Fields map[string]any

+ State string

+ type TaskSpan struct

+ func StartTask(ctx context.Context, task Task) *TaskSpan

+ func (s *TaskSpan) Context() context.Context

+ func (s *TaskSpan) Finish(err error) Measurement

+ func (s *TaskSpan) FinishResult(result TaskResult) Measurement

v0.4.2

Aug 23, 2026

v0.4.1

Aug 23, 2026

v0.4.0

Aug 23, 2026

Changes in this version

+ type EntryStorage interface

+ Clear func(context.Context, uint64) error

+ Close func() error

+ Delete func(context.Context, string) error

+ Load func(context.Context) ([]Entry, uint64, error)

+ Name func() string

+ Put func(context.Context, Entry, uint64) error

type Option

+ func WithStorage(storage EntryStorage) Option

+ func WithUnsafeUnauthenticatedAccess() Option

v0.3.2

Aug 23, 2026

v0.3.1

Aug 23, 2026

v0.3.0

Aug 23, 2026

Changes in this version

+ type EventResult struct

+ Err error

+ Fields map[string]any

+ Status string

+ Summary string

+ type EventSpan struct

+ func StartEvent(ctx context.Context, event Event) *EventSpan

+ func (s *EventSpan) Context() context.Context

+ func (s *EventSpan) Finish(err error) Measurement

+ func (s *EventSpan) FinishResult(result EventResult) Measurement

+ type Measurement struct

+ Duration time.Duration

+ Err error

+ StartedAt time.Time

+ func Measure(ctx context.Context, event Event, fn func(context.Context) error) Measurement

+ func MeasureValueWith[T any](profiler *Profiler, ctx context.Context, event Event, ...) (value T, measurement Measurement)

+ func MeasureValue[T any](ctx context.Context, event Event, fn func(context.Context) (T, error)) (T, Measurement)

+ func (m Measurement) Failed() bool

type Option

+ func WithSQLiteStorage(storagePath string) Option

type Profiler

+ func (p *Profiler) Measure(ctx context.Context, event Event, fn func(context.Context) error) Measurement

+ func (p *Profiler) StartEvent(ctx context.Context, event Event) *EventSpan

v0.2.1

Aug 23, 2026

v0.2.0

Aug 23, 2026

Changes in this version

+ const CaptureSessionCookie

+ const CaptureSessionHeader

+ func LogMiddleware(middleware Middleware)

+ func LogMiddlewareContext(ctx context.Context, middleware Middleware)

+ func ParentEntryIDFromContext(ctx context.Context) string

+ func TagsFromContext(ctx context.Context) map[string]string

+ func WithParentEntry(ctx context.Context, entryID string) context.Context

+ func WithTags(ctx context.Context, tags map[string]string) context.Context

type Cache

+ Callsite []SourceFrame

+ type DashboardChart struct

+ Description string

+ Format DashboardFormat

+ ID string

+ Series []DashboardSeries

+ Span int

+ Title string

+ Unit string

+ type DashboardCounter struct

+ Format DashboardFormat

+ ID string

+ Label string

+ Unit string

+ Value DashboardValueFunc

+ type DashboardCounterGrid struct

+ Counters []DashboardCounter

+ Description string

+ ID string

+ Span int

+ Title string

+ type DashboardCounterSnapshot struct

+ Error string

+ Format DashboardFormat

+ ID string

+ Label string

+ Unit string

+ Value float64

+ type DashboardFormat string

+ const DashboardFormatBytes

+ const DashboardFormatDuration

+ const DashboardFormatNumber

+ const DashboardFormatPercent

+ type DashboardMetric struct

+ Color string

+ Description string

+ Format DashboardFormat

+ ID string

+ Mode DashboardMetricMode

+ Sparkline bool

+ Title string

+ Unit string

+ Value DashboardValueFunc

+ type DashboardMetricMode string

+ const DashboardMetricRate

+ const DashboardMetricValue

+ type DashboardMetricSnapshot struct

+ Color string

+ Error string

+ Format DashboardFormat

+ Mode DashboardMetricMode

+ Sparkline bool

+ Unit string

+ Value float64

+ type DashboardOption func(*dashboardConfig)

+ func WithCPU() DashboardOption

+ func WithCacheHitRate() DashboardOption

+ func WithCounterGrid(grid DashboardCounterGrid) DashboardOption

+ func WithCustomChart(chart DashboardChart) DashboardOption

+ func WithCustomMetric(metric DashboardMetric) DashboardOption

+ func WithEventMix() DashboardOption

+ func WithGoMemory() DashboardOption

+ func WithGoroutines() DashboardOption

+ func WithQueries() DashboardOption

+ func WithQueueHealth() DashboardOption

+ func WithRequests() DashboardOption

+ func WithSlowestOperations() DashboardOption

+ type DashboardSeries struct

+ Color string

+ ID string

+ Label string

+ Value DashboardValueFunc

+ type DashboardSeriesSnapshot struct

+ Color string

+ Error string

+ ID string

+ Label string

+ Value float64

+ type DashboardSnapshot struct

+ RecordedAt time.Time

+ Widgets []DashboardWidgetSnapshot

+ type DashboardValueFunc func(context.Context) (float64, error)

+ type DashboardWidgetSnapshot struct

+ Builtin string

+ Counters []DashboardCounterSnapshot

+ Description string

+ Format DashboardFormat

+ ID string

+ Kind string

+ Metric *DashboardMetricSnapshot

+ Series []DashboardSeriesSnapshot

+ Span int

+ Title string

+ Unit string

type Email

+ Callsite []SourceFrame

type Exception

+ func PanicException(recovered any) Exception

+ type Finding struct

+ Code FindingCode

+ Detail string

+ EntryID string

+ RelatedEntryIDs []string

+ Severity FindingSeverity

+ Suggestion string

+ Title string

+ type FindingCode string

+ const FindingCacheMissQueryBurst

+ const FindingFailedOperation

+ const FindingHighCacheMissRate

+ const FindingPossibleNPlusOne

+ const FindingSQLDominatesRequest

+ const FindingSequentialHTTPCalls

+ const FindingSlowHTTPCall

+ const FindingSlowMiddleware

+ const FindingSlowQuery

+ const FindingSlowRequest

+ type FindingSeverity string

+ const FindingSeverityDanger

+ const FindingSeverityInfo

+ const FindingSeverityWarning

type HTTPCall

+ Callsite []SourceFrame

type Job

+ Callsite []SourceFrame

type Kind

+ const KindMiddleware

+ type Middleware struct

+ Error string

+ Name string

+ State string

type Option

+ func Dashboard(options ...DashboardOption) Option

+ func WithBrowserSession(session string) Option

+ func WithCallsiteKinds(kinds ...Kind) Option

+ func WithDashboardTimeout(timeout time.Duration) Option

+ func WithDisabledKinds(kinds ...Kind) Option

+ func WithHTTPStatusAtLeast(status int) Option

+ func WithHTTPStatusCodes(codes ...int) Option

+ func WithMinRequestDuration(duration time.Duration) Option

+ func WithNextRequests(count int) Option

+ func WithQueryCallsite(enabled bool) Option

+ func WithRequestRetentionFilter(filter RequestRetentionFilter) Option

+ func WithRequestSampleRate(rate float64) Option

+ func WithRequestTags(tags map[string]string) Option

+ func WithSourceLink(sourceLink SourceLinkFunc) Option

+ func WithStoragePath(storagePath string) Option

type Profiler

+ func (p *Profiler) AnalyzeRequest(requestID string) (RequestAnalysis, bool)

+ func (p *Profiler) CaptureCallsite(kind Kind) []SourceFrame

+ func (p *Profiler) CaptureQueryCallsite() []SourceFrame

+ func (p *Profiler) DashboardSnapshot(ctx context.Context) DashboardSnapshot

+ func (p *Profiler) LogMiddleware(middleware Middleware)

+ func (p *Profiler) LogMiddlewareContext(ctx context.Context, middleware Middleware)

type Query

+ Callsite []SourceFrame

+ Plan *QueryPlan

+ type QueryPlan struct

+ Command string

+ Duration time.Duration

+ Error string

+ Format string

+ Text string

type Request

+ Middlewares []Middleware

+ Scheme string

+ type RequestAnalysis struct

+ Findings []Finding

+ GeneratedAt time.Time

+ RequestDurationNS int64

+ RequestID string

type RequestCapture

+ func (c *RequestCapture) AddTags(tags map[string]string)

+ func (c *RequestCapture) LogMiddleware(middleware Middleware)

+ func (c *RequestCapture) SetRoute(route string)

+ type RequestRetentionFilter func(Request) bool

type Schedule

+ Callsite []SourceFrame

+ Payload any

+ type SourceFrame struct

+ File string

+ Function string

+ Line int

+ URL string

+ func CaptureCallsite(kind Kind) []SourceFrame

+ func CaptureQueryCallsite() []SourceFrame

+ type SourceLinkFunc func(SourceFrame) string

type Stats

+ BodyLimit int64

+ DisabledKinds []Kind

+ EvictedEvents uint64

+ MaxBytes int64

+ MaxEvents int

+ RetentionNS int64

+ SampleRate float64

+ Storage string

+ StorageError string

v0.1.0

Aug 22, 2026

Changes in this version

+ func Enabled() bool

+ func IsSensitiveKey(key string) bool

+ func LogCache(cache Cache)

+ func LogCacheContext(ctx context.Context, cache Cache)

+ func LogEmail(email Email)

+ func LogEmailContext(ctx context.Context, email Email)

+ func LogEvent(event Event)

+ func LogEventContext(ctx context.Context, event Event)

+ func LogException(exception Exception)

+ func LogExceptionContext(ctx context.Context, exception Exception)

+ func LogHTTPCall(call HTTPCall)

+ func LogHTTPCallContext(ctx context.Context, call HTTPCall)

+ func LogJob(job Job)

+ func LogJobContext(ctx context.Context, job Job)

+ func LogLog(log Log)

+ func LogLogContext(ctx context.Context, log Log)

+ func LogQuery(query Query)

+ func LogQueryContext(ctx context.Context, query Query)

+ func LogRequest(request Request)

+ func LogSchedule(schedule Schedule)

+ func LogScheduleContext(ctx context.Context, schedule Schedule)

+ func NewID() string

+ func ProfileWith[T any](profiler *Profiler, value T, integration Integration[T]) T

+ func Profile[T any](value T, integration Integration[T]) T

+ func RecordingEnabled(ctx context.Context) bool

+ func Redact(value any)

+ func ShouldCaptureRequest(request *http.Request) bool

+ func Shutdown(ctx context.Context) error

+ func URL() string

+ func WithRequest(ctx context.Context, capture *RequestCapture) context.Context

+ func WithoutRecording(ctx context.Context) context.Context

+ type Address struct

+ Email string

+ Name string

+ type Argument struct

+ Name string

+ Size int64

+ Truncated bool

+ Type string

+ Value string

+ type Cache struct

+ Error string

+ Hit bool

+ Key string

+ Operation string

+ Size int64

+ Store string

+ TTL time.Duration

+ Truncated bool

+ Value string

+ type Email struct

+ BCC []Address

+ CC []Address

+ Error string

+ From Address

+ HTML string

+ Status string

+ Subject string

+ Text string

+ To []Address

+ Transport string

+ type Entry struct

+ Cursor uint64

+ Data json.RawMessage

+ DurationNS int64

+ ID string

+ Instance string

+ Kind Kind

+ OriginRequestID string

+ ParentID string

+ Process string

+ RecordedAt time.Time

+ RequestID string

+ StartedAt time.Time

+ Tags map[string]string

+ type Event struct

+ Error string

+ Fields map[string]any

+ Kind string

+ Name string

+ Status string

+ Summary string

+ type Exception struct

+ Message string

+ Stack string

+ Type string

+ type HTTPCall struct

+ Error string

+ Method string

+ Request HTTPMessage

+ Response HTTPMessage

+ ResponseSize int64

+ Status int

+ URL string

+ type HTTPMessage struct

+ Body string

+ ContentType string

+ Headers map[string][]string

+ Size int64

+ Truncated bool

+ type Integration interface

+ Name func() string

+ Profile func(Scope, T) T

+ type Job struct

+ Arguments []Argument

+ Attempt int

+ AvailableAt time.Time

+ Connection string

+ Error string

+ MaxAttempts int

+ Name string

+ Queue string

+ State string

+ Wait time.Duration

+ type Kind string

+ const KindCache

+ const KindEmail

+ const KindEvent

+ const KindException

+ const KindHTTPCall

+ const KindJob

+ const KindLog

+ const KindQuery

+ const KindRequest

+ const KindSchedule

+ type Log struct

+ Fields map[string]any

+ Level string

+ Message string

+ Stack string

+ type Meta struct

+ Duration time.Duration

+ ID string

+ Instance string

+ OriginRequestID string

+ ParentID string

+ Process string

+ RequestID string

+ StartedAt time.Time

+ Tags map[string]string

+ type Option func(*config)

+ func WithAllowedOrigins(origins ...string) Option

+ func WithBasePath(path string) Option

+ func WithBodyLimit(maxBytes int64) Option

+ func WithExcludedRequests(patterns ...string) Option

+ func WithMaxBytes(maxBytes int64) Option

+ func WithMaxEvents(maxEvents int) Option

+ func WithQueueStatsTimeout(timeout time.Duration) Option

+ func WithRequestFilter(filter RequestFilter) Option

+ func WithRetention(retention time.Duration) Option

+ func WithSecureCookie(isSecure bool) Option

+ func WithStreamBuffer(size int) Option

+ func WithToken(token string) Option

+ type Profiler struct

+ func Default() *Profiler

+ func New(router Router, options ...Option) *Profiler

+ func NewIf(enabled bool, router Router, options ...Option) *Profiler

+ func Start(addr string, options ...Option) (*Profiler, error)

+ func (p *Profiler) BasePath() string

+ func (p *Profiler) BeginRequest(request Request) *RequestCapture

+ func (p *Profiler) BodyLimit() int64

+ func (p *Profiler) Close() error

+ func (p *Profiler) Enabled() bool

+ func (p *Profiler) LogCache(cache Cache)

+ func (p *Profiler) LogCacheContext(ctx context.Context, cache Cache)

+ func (p *Profiler) LogEmail(email Email)

+ func (p *Profiler) LogEmailContext(ctx context.Context, email Email)

+ func (p *Profiler) LogEvent(event Event)

+ func (p *Profiler) LogEventContext(ctx context.Context, event Event)

+ func (p *Profiler) LogException(exception Exception)

+ func (p *Profiler) LogExceptionContext(ctx context.Context, exception Exception)

+ func (p *Profiler) LogHTTPCall(call HTTPCall)

+ func (p *Profiler) LogHTTPCallContext(ctx context.Context, call HTTPCall)

+ func (p *Profiler) LogJob(job Job)

+ func (p *Profiler) LogJobContext(ctx context.Context, job Job)

+ func (p *Profiler) LogLog(log Log)

+ func (p *Profiler) LogLogContext(ctx context.Context, log Log)

+ func (p *Profiler) LogQuery(query Query)

+ func (p *Profiler) LogQueryContext(ctx context.Context, query Query)

+ func (p *Profiler) LogRequest(request Request)

+ func (p *Profiler) LogSchedule(schedule Schedule)

+ func (p *Profiler) LogScheduleContext(ctx context.Context, schedule Schedule)

+ func (p *Profiler) QueueStats(ctx context.Context) QueueStatsResponse

+ func (p *Profiler) RegisterQueueStats(source QueueStatsSource, names ...string) QueueStatsSource

+ func (p *Profiler) RuntimeStats() RuntimeStats

+ func (p *Profiler) ShouldCaptureRequest(request *http.Request) bool

+ func (p *Profiler) Shutdown(ctx context.Context) error

+ func (p *Profiler) URL() string

+ type Query struct

+ Connection string

+ Database string

+ Driver string

+ Error string

+ Operation string

+ RowsAffected *int64

+ SQL string

+ type QuerySpan struct

+ func StartQuery(ctx context.Context, query Query) *QuerySpan

+ func (s *QuerySpan) Finish(err error)

+ func (s *QuerySpan) FinishRows(rowsAffected int64, err error)

+ type QueueState struct

+ Failed uint64

+ Name string

+ Pending int64

+ Processed uint64

+ Succeeded uint64

+ WorkersActive int64

+ WorkersTotal int64

+ type QueueStats struct

+ Error string

+ Failed uint64

+ Pending int64

+ Processed uint64

+ Queues []QueueState

+ RecordedAt time.Time

+ Source string

+ StartedAt time.Time

+ Succeeded uint64

+ WorkersActive int64

+ WorkersTotal int64

+ type QueueStatsResponse struct

+ RecordedAt time.Time

+ Sources []QueueStats

+ type QueueStatsSource interface

+ QueueStats func(context.Context) (QueueStats, error)

+ func RegisterQueueStats(source QueueStatsSource, names ...string) QueueStatsSource

+ type QueueStatsSourceFunc func(context.Context) (QueueStats, error)

+ func (f QueueStatsSourceFunc) QueueStats(ctx context.Context) (QueueStats, error)

+ type Request struct

+ Cache []Cache

+ Emails []Email

+ Error string

+ Events []Event

+ Exceptions []Exception

+ HTTPCalls []HTTPCall

+ Host string

+ Jobs []Job

+ Logs []Log

+ Method string

+ Path string

+ Protocol string

+ Queries []Query

+ Query string

+ RemoteIP string

+ Request HTTPMessage

+ RequestSize int64

+ Response HTTPMessage

+ ResponseSize int64

+ Route string

+ Schedules []Schedule

+ Status int

+ type RequestCapture struct

+ func BeginRequest(request Request) *RequestCapture

+ func RequestFromContext(ctx context.Context) *RequestCapture

+ func (c *RequestCapture) Finish(result RequestResult)

+ func (c *RequestCapture) ID() string

+ func (c *RequestCapture) LogCache(cache Cache)

+ func (c *RequestCapture) LogEmail(email Email)

+ func (c *RequestCapture) LogEvent(event Event)

+ func (c *RequestCapture) LogException(exception Exception)

+ func (c *RequestCapture) LogHTTPCall(call HTTPCall)

+ func (c *RequestCapture) LogJob(job Job)

+ func (c *RequestCapture) LogLog(log Log)

+ func (c *RequestCapture) LogQuery(query Query)

+ func (c *RequestCapture) LogSchedule(schedule Schedule)

+ type RequestFilter func(*http.Request) bool

+ func ExcludingRequests(patterns ...string) RequestFilter

+ type RequestResult struct

+ Error string

+ Response HTTPMessage

+ ResponseSize int64

+ Status int

+ type Router interface

+ Handle func(string, http.Handler)

+ type RuntimeStats struct

+ CPUIdleSeconds float64

+ CPUSeconds float64

+ GCCycles uint64

+ GOMAXPROCS int

+ Goroutines uint64

+ HeapLiveBytes uint64

+ HeapObjectsBytes uint64

+ MemoryBytes uint64

+ RecordedAt time.Time

+ UptimeNS int64

+ type Schedule struct

+ Error string

+ Name string

+ Panic string

+ PlannedAt time.Time

+ State string

+ type Scope struct

+ func (s Scope) Load(key any) (any, bool)

+ func (s Scope) LoadOrStore(key, value any) (any, bool)

+ func (s Scope) Profiler() *Profiler

+ func (s Scope) Store(key, value any)

+ type Stats struct

+ Bytes int64

+ Cursor uint64

+ DroppedEvents uint64

+ Events int

+ Subscribers int

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