Artifact e5630e086a541ec89e3a7f53a8582fb1bc454c5c201a650ebcd8e3e9c874402f:
- File
docs/site/content/docs/reference/sdk/observer/otel/api.md
— part of check-in
[d1016bd2ef]
at
2026-04-26 08:12:25
on branch trunk
— site(landing): SVG architecture diagram + SDK refresh (#7)
* site(landing): SVG architecture diagram + SDK regen
- Replace ยง04 ASCII diagram with an SVG mirroring the dagnats style: three columns (callers / core / plugins), ember flow arrows with CALLS / DELEGATE / EVENTS / PERSIST labels, bottom box for .fossil (SQLite). Picks up the layout's existing .diagram CSS with no new styles. - Refresh gomarkdoc-generated SDK pages โ they had drifted from current Go doc comments since the original generation.
* docs(site): drop redundant body H1s from frontmatter pages
Each of the four moved docs (architecture, extension-points, migration-from-fossil, testing) and the two hand-written driver _index pages had a body '# Title' that duplicated their frontmatter 'title:'. Hextra renders both, producing the visible doubled headline. Removing the body H1 leaves Hextra's frontmatter-driven page heading as the single source.
SDK api.md pages from gomarkdoc are unaffected โ they have no frontmatter, so Hextra promotes their body H1 to the page title without duplication.
* site(landing): bump version refs to v0.4.2 (user: [email protected], size: 8555) [annotate] [blame] [check-ins using]
otel
import "github.com/danmestas/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