Artifact a2fa961a6c27e494cd34e06a1739f812d474206fcb120da3885d7ec88f430d9b:
- File
docs/site/content/docs/reference/sdk/observer/otel/api.md
— part of check-in
[c12b02189f]
at
2026-10-26 00:46:10
on branch main
— docs: regenerate the SDK reference and check it in CI
The gomarkdoc SDK pages had drifted about a thousand lines from the code: make docs-gen-sdk was never part of docs-gen, so nothing regenerated them and the docs check did not compare them. ReadBlob, SetContentCache, ListFilesIn and OriginNamer were missing from the libfossil page.
scripts/gen-sdk-docs.sh now renders them, running gomarkdoc v1.1.0 through go run so CI needs no install, then adds the frontmatter. It honours OUT_DIR, gen-docs.sh calls it, and check-docs-generated.sh compares the result, so a stale SDK page fails CI like any other generated input. make docs-gen-sdk calls the same script. llms.txt and llms-full.txt are regenerated from the refreshed pages. (user: [email protected], size: 6720) [annotate] [blame] [check-ins using] [more...]
title: observer/otel
<!-- Code generated by gomarkdoc. DO NOT EDIT -->otel
import "github.com/danmestas/go-libfossil/observer/otel"
Package otel provides OpenTelemetry implementations of the libfossil SyncObserver and CheckoutObserver interfaces. Import this package only when you want OTel instrumentation — it pulls in the OTel SDK dependency.
Index
- type CheckoutObserver
- func NewCheckoutObserver() *CheckoutObserver
- func (o *CheckoutObserver) CommitCompleted(info libfossil.CommitEnd)
- func (o *CheckoutObserver) CommitStarted(info libfossil.CommitStart)
- func (o *CheckoutObserver) Error(err error)
- func (o *CheckoutObserver) ExtractCompleted(info libfossil.ExtractEnd)
- func (o *CheckoutObserver) ExtractFileCompleted(name string, change libfossil.UpdateChange)
- func (o *CheckoutObserver) ExtractStarted(info libfossil.ExtractStart)
- func (o *CheckoutObserver) ScanCompleted(info libfossil.ScanEnd)
- func (o *CheckoutObserver) ScanStarted(dir string)
- func (o *CheckoutObserver) String() string
- type SyncObserver
- func NewSyncObserver() *SyncObserver
- func (o *SyncObserver) Completed(info libfossil.SessionEnd)
- func (o *SyncObserver) Error(err error)
- func (o *SyncObserver) HandleCompleted(info libfossil.HandleEnd)
- func (o *SyncObserver) HandleStarted(info libfossil.HandleStart)
- func (o *SyncObserver) RoundCompleted(round int, stats libfossil.RoundStats)
- func (o *SyncObserver) RoundStarted(round int)
- func (o *SyncObserver) Started(info libfossil.SessionStart)
- func (o *SyncObserver) String() string
- func (o *SyncObserver) TableSyncCompleted(info libfossil.TableSyncEnd)
- func (o *SyncObserver) TableSyncStarted(info libfossil.TableSyncStart)
type CheckoutObserver
CheckoutObserver implements libfossil.CheckoutObserver using OpenTelemetry spans and metrics.
type CheckoutObserver struct {
// contains filtered or unexported fields
}
func NewCheckoutObserver
func NewCheckoutObserver() *CheckoutObserver
NewCheckoutObserver returns a CheckoutObserver that records spans and metrics using the OTel global tracer and meter providers.
func (*CheckoutObserver) CommitCompleted
func (o *CheckoutObserver) CommitCompleted(info libfossil.CommitEnd)
func (*CheckoutObserver) CommitStarted
func (o *CheckoutObserver) CommitStarted(info libfossil.CommitStart)
func (*CheckoutObserver) Error
func (o *CheckoutObserver) Error(err error)
func (*CheckoutObserver) ExtractCompleted
func (o *CheckoutObserver) ExtractCompleted(info libfossil.ExtractEnd)
func (*CheckoutObserver) ExtractFileCompleted
func (o *CheckoutObserver) ExtractFileCompleted(name string, change libfossil.UpdateChange)
func (*CheckoutObserver) ExtractStarted
func (o *CheckoutObserver) ExtractStarted(info libfossil.ExtractStart)
func (*CheckoutObserver) ScanCompleted
func (o *CheckoutObserver) ScanCompleted(info libfossil.ScanEnd)
func (*CheckoutObserver) ScanStarted
func (o *CheckoutObserver) ScanStarted(dir string)
func (*CheckoutObserver) String
func (o *CheckoutObserver) String() string
type SyncObserver
SyncObserver implements libfossil.SyncObserver using OpenTelemetry spans and metrics.
type SyncObserver struct {
// contains filtered or unexported fields
}
func NewSyncObserver
func NewSyncObserver() *SyncObserver
NewSyncObserver returns a SyncObserver that records spans and metrics using the OTel global tracer and meter providers.
func (*SyncObserver) Completed
func (o *SyncObserver) Completed(info libfossil.SessionEnd)
func (*SyncObserver) Error
func (o *SyncObserver) Error(err error)
func (*SyncObserver) HandleCompleted
func (o *SyncObserver) HandleCompleted(info libfossil.HandleEnd)
func (*SyncObserver) HandleStarted
func (o *SyncObserver) HandleStarted(info libfossil.HandleStart)
func (*SyncObserver) RoundCompleted
func (o *SyncObserver) RoundCompleted(round int, stats libfossil.RoundStats)
func (*SyncObserver) RoundStarted
func (o *SyncObserver) RoundStarted(round int)
func (*SyncObserver) Started
func (o *SyncObserver) Started(info libfossil.SessionStart)
func (*SyncObserver) String
func (o *SyncObserver) String() string
String returns a human-readable description.
func (*SyncObserver) TableSyncCompleted
func (o *SyncObserver) TableSyncCompleted(info libfossil.TableSyncEnd)
func (*SyncObserver) TableSyncStarted
func (o *SyncObserver) TableSyncStarted(info libfossil.TableSyncStart)
Generated by gomarkdoc