s3oplog

package
v0.18.0 Latest Latest
Warning

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

Go to latest
Published: Oct 13, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package s3oplog is the per-request S3 round-trip log seam (issue #182): when OPENSTORAGE_S3_OP_LOG names a file, every S3 HTTP attempt made through the openstorage SDK clients — the s3wal conditional client (ref and meta authority) and the blob client — appends one whitespace- separated line:

<unixnano> <pid> <role> <operation> <status> <dur_us> <path>

role is derived from the process argv (serve vs hook subprocesses), so a log shared by one push's processes attributes each round trip to its origin. The seam exists to census and regression-guard the per-push S3 round-trip count; it is diagnostics, not telemetry — unset (the default) it installs nothing and costs nothing.

The middleware sits in the Deserialize step (the captureStoreDate precedent in internal/ref/s3wal): it wraps only the wire exchange, runs once per HTTP attempt (inside the retry loop), and sees the raw response status uniformly for every operation.

Index

Constants

View Source
const Env = "OPENSTORAGE_S3_OP_LOG"

Env names the op-log file. Empty (the default) disables the seam.

Variables

This section is empty.

Functions

func APIOption

func APIOption() (func(*middleware.Stack) error, bool)

APIOption returns the smithy API option installing the op-log middleware and whether the seam is enabled. Callers append it to s3.Options .APIOptions exactly like the expected-bucket-owner option.

Types

This section is empty.

Jump to

Keyboard shortcuts

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