Documentation
¶
Overview ¶
Package observability adapts Synapse's bounded telemetry seams to Prometheus.
Index ¶
- type Collectors
- func (c *Collectors) EnableNotifications()
- func (c *Collectors) Handler() http.Handler
- func (c *Collectors) ObserveAssessmentClosureReport(outcome, reason string)
- func (c *Collectors) ObserveAssessmentComparison(status, mode, reason string)
- func (c *Collectors) ObserveAssessmentComparisonBacklog(tenantID string, backlog ports.AssessmentComparisonBacklog, ...)
- func (c *Collectors) ObserveAssessmentComparisonGeneration(tenantID, mode, status string, ...)
- func (c *Collectors) ObserveAssessmentRelationshipCandidate(outcome, confidence string)
- func (c *Collectors) ObserveAssessmentRelationshipDecision(action, outcome string)
- func (c *Collectors) ObserveFindingLineage(outcome, method, reason string)
- func (c *Collectors) ObserveFindingLineageBackfillItem(outcome string)
- func (c *Collectors) ObserveFindingLineageBackfillRun(state string)
- func (c *Collectors) ObserveHTTPRequest(method, route, statusClass string, duration time.Duration)
- func (c *Collectors) ObserveIntegrationOperation(provider, operation, outcome string)
- func (c *Collectors) ObserveSCAOutcome(outcome string)
- func (c *Collectors) ObserveSCAScan(duration time.Duration, outcome string)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Collectors ¶
type Collectors struct {
// contains filtered or unexported fields
}
Collectors owns a private Prometheus registry. It contains no global collectors, so only Synapse's documented metrics are exposed by /metrics.
func New ¶
func New(queueReader ports.AggregateJobQueueStatsReader, pool ports.PoolStatsReader) *Collectors
New constructs the bounded Prometheus collectors used by the API metrics listener. The optional pool reader supplies aggregate pool metrics without connection or tenant labels.
func (*Collectors) EnableNotifications ¶
func (c *Collectors) EnableNotifications()
func (*Collectors) Handler ¶
func (c *Collectors) Handler() http.Handler
Handler returns the private-registry Prometheus metrics endpoint.
func (*Collectors) ObserveAssessmentClosureReport ¶
func (c *Collectors) ObserveAssessmentClosureReport(outcome, reason string)
func (*Collectors) ObserveAssessmentComparison ¶
func (c *Collectors) ObserveAssessmentComparison(status, mode, reason string)
func (*Collectors) ObserveAssessmentComparisonBacklog ¶
func (c *Collectors) ObserveAssessmentComparisonBacklog(tenantID string, backlog ports.AssessmentComparisonBacklog, observedAt time.Time)
func (*Collectors) ObserveAssessmentComparisonGeneration ¶
func (c *Collectors) ObserveAssessmentComparisonGeneration(tenantID, mode, status string, fingerprintVersion, riskModelVersion, itemCount int, duration time.Duration)
func (*Collectors) ObserveAssessmentRelationshipCandidate ¶
func (c *Collectors) ObserveAssessmentRelationshipCandidate(outcome, confidence string)
func (*Collectors) ObserveAssessmentRelationshipDecision ¶
func (c *Collectors) ObserveAssessmentRelationshipDecision(action, outcome string)
func (*Collectors) ObserveFindingLineage ¶
func (c *Collectors) ObserveFindingLineage(outcome, method, reason string)
func (*Collectors) ObserveFindingLineageBackfillItem ¶
func (c *Collectors) ObserveFindingLineageBackfillItem(outcome string)
func (*Collectors) ObserveFindingLineageBackfillRun ¶
func (c *Collectors) ObserveFindingLineageBackfillRun(state string)
func (*Collectors) ObserveHTTPRequest ¶
func (c *Collectors) ObserveHTTPRequest(method, route, statusClass string, duration time.Duration)
ObserveHTTPRequest records a bounded HTTP request outcome.
func (*Collectors) ObserveIntegrationOperation ¶
func (c *Collectors) ObserveIntegrationOperation(provider, operation, outcome string)
ObserveIntegrationOperation records a terminal integration operation using only bounded provider, operation, and outcome labels.
func (*Collectors) ObserveSCAOutcome ¶
func (c *Collectors) ObserveSCAOutcome(outcome string)
ObserveSCAOutcome records one terminal SCA outcome without an execution duration.
func (*Collectors) ObserveSCAScan ¶
func (c *Collectors) ObserveSCAScan(duration time.Duration, outcome string)
ObserveSCAScan records one completed SCA execution outcome and its duration.
Source Files