accesslog

package

v0.8.1 Latest Latest Go to latest Published: Sep 4, 2026 License: GPL-3.0 Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/git-pkgs/proxy

Links

Open Source Insights

Documentation ¶

Overview ¶

Package accesslog writes proxy activity as JSON Lines.

Index ¶

Constants
func RequestID(ctx context.Context) string
func URLWithoutSecrets(value *url.URL) string
func WithRequestID(ctx context.Context, requestID string) context.Context
type Entry
type Logger
- func Open(path string) (*Logger, error)
- func (l *Logger) Close() error
- func (l *Logger) Write(entry Entry) error

Constants ¶

View Source

const (

	// EventRequest identifies the response sent by the proxy to a client.
	EventRequest = "request"
	// EventUpstream identifies one HTTP exchange with an upstream service.
	EventUpstream = "upstream"
)

Variables ¶

This section is empty.

Functions ¶

func RequestID ¶

func RequestID(ctx context.Context) string

RequestID returns the proxy request ID stored in ctx.

func URLWithoutSecrets ¶

func URLWithoutSecrets(value *url.URL) string

URLWithoutSecrets returns a URL without user information, query values, or fragments.

func WithRequestID ¶

func WithRequestID(ctx context.Context, requestID string) context.Context

WithRequestID stores a proxy request ID in ctx.

Types ¶

type Entry ¶

type Entry struct {
	Time       time.Time `json:"time"`
	Event      string    `json:"event"`
	RequestID  string    `json:"request_id,omitempty"`
	Method     string    `json:"method"`
	Path       string    `json:"path,omitempty"`
	URL        string    `json:"url,omitempty"`
	StatusCode int       `json:"status_code,omitempty"`
	DurationMS int64     `json:"duration_ms"`
	RemoteAddr string    `json:"remote_addr,omitempty"`
	Error      string    `json:"error,omitempty"`
}

Entry is one proxy activity record.

type Logger ¶

type Logger struct {
	// contains filtered or unexported fields
}

Logger appends complete JSON objects to a file, one per line.

func Open ¶

func Open(path string) (*Logger, error)

Open opens path for append, creating it with owner-only permissions when needed.

func (*Logger) Close ¶

func (l *Logger) Close() error

Close closes the log file after any active writer finishes.

func (*Logger) Write ¶

func (l *Logger) Write(entry Entry) error

Write appends an entry to the log.

Source Files ¶

View all Source files

accesslog.go

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