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 ```go 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](<#CheckoutObserver>) - [func NewCheckoutObserver\(\) \*CheckoutObserver](<#NewCheckoutObserver>) - [func \(o \*CheckoutObserver\) CommitCompleted\(info libfossil.CommitEnd\)](<#CheckoutObserver.CommitCompleted>) - [func \(o \*CheckoutObserver\) CommitStarted\(info libfossil.CommitStart\)](<#CheckoutObserver.CommitStarted>) - [func \(o \*CheckoutObserver\) Error\(err error\)](<#CheckoutObserver.Error>) - [func \(o \*CheckoutObserver\) ExtractCompleted\(info libfossil.ExtractEnd\)](<#CheckoutObserver.ExtractCompleted>) - [func \(o \*CheckoutObserver\) ExtractFileCompleted\(name string, change libfossil.UpdateChange\)](<#CheckoutObserver.ExtractFileCompleted>) - [func \(o \*CheckoutObserver\) ExtractStarted\(info libfossil.ExtractStart\)](<#CheckoutObserver.ExtractStarted>) - [func \(o \*CheckoutObserver\) ScanCompleted\(info libfossil.ScanEnd\)](<#CheckoutObserver.ScanCompleted>) - [func \(o \*CheckoutObserver\) ScanStarted\(dir string\)](<#CheckoutObserver.ScanStarted>) - [func \(o \*CheckoutObserver\) String\(\) string](<#CheckoutObserver.String>) - [type SyncObserver](<#SyncObserver>) - [func NewSyncObserver\(\) \*SyncObserver](<#NewSyncObserver>) - [func \(o \*SyncObserver\) Completed\(info libfossil.SessionEnd\)](<#SyncObserver.Completed>) - [func \(o \*SyncObserver\) Error\(err error\)](<#SyncObserver.Error>) - [func \(o \*SyncObserver\) HandleCompleted\(info libfossil.HandleEnd\)](<#SyncObserver.HandleCompleted>) - [func \(o \*SyncObserver\) HandleStarted\(info libfossil.HandleStart\)](<#SyncObserver.HandleStarted>) - [func \(o \*SyncObserver\) RoundCompleted\(round int, stats libfossil.RoundStats\)](<#SyncObserver.RoundCompleted>) - [func \(o \*SyncObserver\) RoundStarted\(round int\)](<#SyncObserver.RoundStarted>) - [func \(o \*SyncObserver\) Started\(info libfossil.SessionStart\)](<#SyncObserver.Started>) - [func \(o \*SyncObserver\) String\(\) string](<#SyncObserver.String>) - [func \(o \*SyncObserver\) TableSyncCompleted\(info libfossil.TableSyncEnd\)](<#SyncObserver.TableSyncCompleted>) - [func \(o \*SyncObserver\) TableSyncStarted\(info libfossil.TableSyncStart\)](<#SyncObserver.TableSyncStarted>) <a name="CheckoutObserver"></a> ## type CheckoutObserver CheckoutObserver implements libfossil.CheckoutObserver using OpenTelemetry spans and metrics. ```go type CheckoutObserver struct { // contains filtered or unexported fields } ``` <a name="NewCheckoutObserver"></a> ### func NewCheckoutObserver ```go func NewCheckoutObserver() *CheckoutObserver ``` NewCheckoutObserver returns a CheckoutObserver that records spans and metrics using the OTel global tracer and meter providers. <a name="CheckoutObserver.CommitCompleted"></a> ### func \(\*CheckoutObserver\) CommitCompleted ```go func (o *CheckoutObserver) CommitCompleted(info libfossil.CommitEnd) ``` <a name="CheckoutObserver.CommitStarted"></a> ### func \(\*CheckoutObserver\) CommitStarted ```go func (o *CheckoutObserver) CommitStarted(info libfossil.CommitStart) ``` <a name="CheckoutObserver.Error"></a> ### func \(\*CheckoutObserver\) Error ```go func (o *CheckoutObserver) Error(err error) ``` <a name="CheckoutObserver.ExtractCompleted"></a> ### func \(\*CheckoutObserver\) ExtractCompleted ```go func (o *CheckoutObserver) ExtractCompleted(info libfossil.ExtractEnd) ``` <a name="CheckoutObserver.ExtractFileCompleted"></a> ### func \(\*CheckoutObserver\) ExtractFileCompleted ```go func (o *CheckoutObserver) ExtractFileCompleted(name string, change libfossil.UpdateChange) ``` <a name="CheckoutObserver.ExtractStarted"></a> ### func \(\*CheckoutObserver\) ExtractStarted ```go func (o *CheckoutObserver) ExtractStarted(info libfossil.ExtractStart) ``` <a name="CheckoutObserver.ScanCompleted"></a> ### func \(\*CheckoutObserver\) ScanCompleted ```go func (o *CheckoutObserver) ScanCompleted(info libfossil.ScanEnd) ``` <a name="CheckoutObserver.ScanStarted"></a> ### func \(\*CheckoutObserver\) ScanStarted ```go func (o *CheckoutObserver) ScanStarted(dir string) ``` <a name="CheckoutObserver.String"></a> ### func \(\*CheckoutObserver\) String ```go func (o *CheckoutObserver) String() string ``` <a name="SyncObserver"></a> ## type SyncObserver SyncObserver implements libfossil.SyncObserver using OpenTelemetry spans and metrics. ```go type SyncObserver struct { // contains filtered or unexported fields } ``` <a name="NewSyncObserver"></a> ### func NewSyncObserver ```go func NewSyncObserver() *SyncObserver ``` NewSyncObserver returns a SyncObserver that records spans and metrics using the OTel global tracer and meter providers. <a name="SyncObserver.Completed"></a> ### func \(\*SyncObserver\) Completed ```go func (o *SyncObserver) Completed(info libfossil.SessionEnd) ``` <a name="SyncObserver.Error"></a> ### func \(\*SyncObserver\) Error ```go func (o *SyncObserver) Error(err error) ``` <a name="SyncObserver.HandleCompleted"></a> ### func \(\*SyncObserver\) HandleCompleted ```go func (o *SyncObserver) HandleCompleted(info libfossil.HandleEnd) ``` <a name="SyncObserver.HandleStarted"></a> ### func \(\*SyncObserver\) HandleStarted ```go func (o *SyncObserver) HandleStarted(info libfossil.HandleStart) ``` <a name="SyncObserver.RoundCompleted"></a> ### func \(\*SyncObserver\) RoundCompleted ```go func (o *SyncObserver) RoundCompleted(round int, stats libfossil.RoundStats) ``` <a name="SyncObserver.RoundStarted"></a> ### func \(\*SyncObserver\) RoundStarted ```go func (o *SyncObserver) RoundStarted(round int) ``` <a name="SyncObserver.Started"></a> ### func \(\*SyncObserver\) Started ```go func (o *SyncObserver) Started(info libfossil.SessionStart) ``` <a name="SyncObserver.String"></a> ### func \(\*SyncObserver\) String ```go func (o *SyncObserver) String() string ``` String returns a human\-readable description. <a name="SyncObserver.TableSyncCompleted"></a> ### func \(\*SyncObserver\) TableSyncCompleted ```go func (o *SyncObserver) TableSyncCompleted(info libfossil.TableSyncEnd) ``` <a name="SyncObserver.TableSyncStarted"></a> ### func \(\*SyncObserver\) TableSyncStarted ```go func (o *SyncObserver) TableSyncStarted(info libfossil.TableSyncStart) ``` Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)