Documentation
¶
Overview ¶
Package observability provides a metrics extension for Weave that records lifecycle event counts via go-utils MetricFactory.
Index ¶
- type MetricsExtension
- func (m *MetricsExtension) Name() string
- func (m *MetricsExtension) OnCollectionCreated(_ context.Context, _ *collection.Collection) error
- func (m *MetricsExtension) OnCollectionDeleted(_ context.Context, _ id.CollectionID) error
- func (m *MetricsExtension) OnDocumentDeleted(_ context.Context, _ id.DocumentID) error
- func (m *MetricsExtension) OnIngestCompleted(_ context.Context, _ id.CollectionID, docCount, chunkCount int, ...) error
- func (m *MetricsExtension) OnIngestFailed(_ context.Context, _ id.CollectionID, _ error) error
- func (m *MetricsExtension) OnIngestStarted(_ context.Context, _ id.CollectionID, _ []*document.Document) error
- func (m *MetricsExtension) OnReindexCompleted(_ context.Context, _ id.CollectionID, _ time.Duration) error
- func (m *MetricsExtension) OnReindexStarted(_ context.Context, _ id.CollectionID) error
- func (m *MetricsExtension) OnRetrievalCompleted(_ context.Context, _ id.CollectionID, _ int, _ time.Duration) error
- func (m *MetricsExtension) OnRetrievalFailed(_ context.Context, _ id.CollectionID, _ error) error
- func (m *MetricsExtension) OnRetrievalStarted(_ context.Context, _ id.CollectionID, _ string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type MetricsExtension ¶
type MetricsExtension struct {
CollectionCreated gu.Counter
CollectionDeleted gu.Counter
IngestStarted gu.Counter
IngestCompleted gu.Counter
IngestFailed gu.Counter
DocumentsIngested gu.Counter
ChunksCreated gu.Counter
RetrievalStarted gu.Counter
RetrievalCompleted gu.Counter
RetrievalFailed gu.Counter
DocumentDeleted gu.Counter
ReindexStarted gu.Counter
ReindexCompleted gu.Counter
}
MetricsExtension records system-wide lifecycle metrics via go-utils MetricFactory. Register it as a Weave extension to automatically track ingestion rates, retrieval counts, failure rates, and reindex operations.
func NewMetricsExtension ¶
func NewMetricsExtension() *MetricsExtension
NewMetricsExtension creates a MetricsExtension using a default metrics collector.
func NewMetricsExtensionWithFactory ¶
func NewMetricsExtensionWithFactory(factory gu.MetricFactory) *MetricsExtension
NewMetricsExtensionWithFactory creates a MetricsExtension with the provided MetricFactory. Use fapp.Metrics() in forge extensions, or gu.NewMetricsCollector for testing.
func (*MetricsExtension) Name ¶
func (m *MetricsExtension) Name() string
Name implements ext.Extension.
func (*MetricsExtension) OnCollectionCreated ¶
func (m *MetricsExtension) OnCollectionCreated(_ context.Context, _ *collection.Collection) error
OnCollectionCreated implements ext.CollectionCreated.
func (*MetricsExtension) OnCollectionDeleted ¶
func (m *MetricsExtension) OnCollectionDeleted(_ context.Context, _ id.CollectionID) error
OnCollectionDeleted implements ext.CollectionDeleted.
func (*MetricsExtension) OnDocumentDeleted ¶
func (m *MetricsExtension) OnDocumentDeleted(_ context.Context, _ id.DocumentID) error
OnDocumentDeleted implements ext.DocumentDeleted.
func (*MetricsExtension) OnIngestCompleted ¶
func (m *MetricsExtension) OnIngestCompleted(_ context.Context, _ id.CollectionID, docCount, chunkCount int, _ time.Duration) error
OnIngestCompleted implements ext.IngestCompleted.
func (*MetricsExtension) OnIngestFailed ¶
func (m *MetricsExtension) OnIngestFailed(_ context.Context, _ id.CollectionID, _ error) error
OnIngestFailed implements ext.IngestFailed.
func (*MetricsExtension) OnIngestStarted ¶
func (m *MetricsExtension) OnIngestStarted(_ context.Context, _ id.CollectionID, _ []*document.Document) error
OnIngestStarted implements ext.IngestStarted.
func (*MetricsExtension) OnReindexCompleted ¶
func (m *MetricsExtension) OnReindexCompleted(_ context.Context, _ id.CollectionID, _ time.Duration) error
OnReindexCompleted implements ext.ReindexCompleted.
func (*MetricsExtension) OnReindexStarted ¶
func (m *MetricsExtension) OnReindexStarted(_ context.Context, _ id.CollectionID) error
OnReindexStarted implements ext.ReindexStarted.
func (*MetricsExtension) OnRetrievalCompleted ¶
func (m *MetricsExtension) OnRetrievalCompleted(_ context.Context, _ id.CollectionID, _ int, _ time.Duration) error
OnRetrievalCompleted implements ext.RetrievalCompleted.
func (*MetricsExtension) OnRetrievalFailed ¶
func (m *MetricsExtension) OnRetrievalFailed(_ context.Context, _ id.CollectionID, _ error) error
OnRetrievalFailed implements ext.RetrievalFailed.
func (*MetricsExtension) OnRetrievalStarted ¶
func (m *MetricsExtension) OnRetrievalStarted(_ context.Context, _ id.CollectionID, _ string) error
OnRetrievalStarted implements ext.RetrievalStarted.
Source Files