mirror of
https://github.com/hanzoai/o11y.git
synced 2026-10-15 12:58:33 +00:00
PandeyandGitHub
5a65dc310f
* feat(audit): add Auditor interface and rename auditortypes to audittypes Add the Auditor interface in pkg/auditor/ as the contract between the HTTP handler layer and audit implementations (noop for community, OTLP for enterprise). Includes Config with buffer, batch, and flush settings following the provider pattern. Rename pkg/types/auditortypes/ to pkg/types/audittypes/ for consistency. closes SigNoz/platform-pod#1930 * refactor(audit): move endpoint config to OTLPHTTPConfig provider struct Move Endpoint out of top-level Config into a provider-specific OTLPHTTPConfig struct with full OTLP HTTP options (url_path, insecure, compression, timeout, headers, retry). Keep BufferSize, BatchSize, FlushInterval at top level as common settings across providers. closes SigNoz/platform-pod#1930 * feat(audit): add auditorbatcher for buffered event batching Add pkg/auditor/auditorbatcher/ with channel-based batching for audit events. Flushes when either batch size is reached or flush interval elapses (whichever comes first). Events are dropped when the buffer is full (fail-open). Follows the alertmanagerbatcher pattern. * refactor(audit): replace public channel with Receive method on batcher Make batchC private and expose Receive() <-chan []AuditEvent as the read-side API. Clearer contract: Add() to write, Receive() to read. * refactor(audit): rename batcher config fields to BufferSize and BatchSize Capacity → BufferSize, Size → BatchSize for clarity. * fix(audit): single-line slog call and fix log key to buffer_size * feat(audit): add OTel metrics to auditorbatcher Add telemetry via OTel MeterProvider with 4 instruments: - signoz.audit.events.emitted (counter) - signoz.audit.store.write_errors (counter, via RecordWriteError) - signoz.audit.events.dropped (counter) - signoz.audit.events.buffer_size (observable gauge) Batcher.New() now accepts metric.Meter and returns error. * refactor(audit): inject factory.ScopedProviderSettings into batcher Replace separate logger and meter params with ScopedProviderSettings, giving the batcher access to logger, meter, and tracer from one source. * feat(audit): add OTel tracing to batcher Add path Span auditorbatcher.Add with event_name attribute set at creation and audit.dropped set dynamically on buffer-full drop. * feat(audit): add export span to batcher Receive path Introduce Batch struct carrying context, events, and a trace span. Each flush starts an auditorbatcher.Export span with batch_size attribute. The consumer ends the span after export completes. * refactor(audit): replace Batch/Receive with ExportFunc callback Batcher now takes an ExportFunc at construction and manages spans internally. Removes Batch struct, Receive(), and RecordWriteError() from the public API. Span.End() is always called via defer, write errors and span status are recorded automatically on export failure. Uses errors.Attr for error logging, prefixes log keys with audit. * refactor(audit): rename auditorbatcher to auditorserver Rename package, file (batcher.go → server.go), type (Batcher → Server), and receiver (b → server) to reflect the full service role: buffering, batching, metrics, tracing, and export lifecycle management. * refactor(audit): rename telemetry to serverMetrics and document struct fields Rename type telemetry → serverMetrics and constructor newTelemetry → newServerMetrics. Add comments to all Server struct fields. * feat(audit): implement ServiceWithHealthy, fix race, add unit tests - Implement factory.ServiceWithHealthy on Server via healthyC channel - Fix data race: Start closes healthyC after goroutinesWg.Add(1), Stop waits on healthyC before closing stopC - Add 8 unit tests covering construction, start/stop lifecycle, batch-size flush, interval flush, buffer-full drop, drain on stop, export failure handling, and concurrent safety * fix(audit): fix lint issues in auditorserver and tests Use snake_case for slog keys, errors.New instead of fmt.Errorf, and check all Start/Stop return values in tests. * fix(audit): address PR review comments Use auditor:: prefix in validation error messages. Move fire-and-forget comment to the Audit method, remove interface-level comment.
18 lines
480 B
Go
18 lines
480 B
Go
package auditorserver
|
|
|
|
import "time"
|
|
|
|
type Config struct {
|
|
// BufferSize is the maximum number of events that can be buffered.
|
|
// When full, new events are dropped (fail-open).
|
|
BufferSize int
|
|
|
|
// BatchSize is the maximum number of events per export batch.
|
|
BatchSize int
|
|
|
|
// FlushInterval is the maximum time between flushes.
|
|
// A flush is triggered when either BatchSize events accumulate or
|
|
// FlushInterval elapses, whichever comes first.
|
|
FlushInterval time.Duration
|
|
}
|