metrics

package
v0.0.21 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 12, 2026 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package metrics 暴露 BYOK 相关 prometheus 指标。

这些 metric 在包 init 阶段注册到 prometheus.DefaultRegisterer, 业务代码直接 .Inc()/.Set() 即可,无需关心注册路径。Task 8 临时 stub (interface{ Inc() }) 已被替换为真实 prometheus.Counter;调用点 (e.g. byokcrypto.SanitizeDecryptErr) 因 prometheus.Counter 也实现 Inc(), 不需修改 import。

命名遵循 prometheus 约定:

  • _total 后缀仅用于 Counter 单调累加值
  • GaugeVec 用于按 label 维度 set 的瞬时快照(如 owner→count)

见 spec §4.4 + §6.2。

Index

Constants

This section is empty.

Variables

View Source
var (
	// BYOKPrivateChannelCount 按 owner 维度 set 当前 PrivateChannel 行数。
	// 由 PrivateChannel mutation 路径增量维护(Create 后 +1,Delete 后 -1
	// 重新 CountByOwner 再 Set),用于观测 BYOKMaxChannels 配额接近情况。
	BYOKPrivateChannelCount = prometheus.NewGaugeVec(
		prometheus.GaugeOpts{
			Name: "byok_private_channel_count",
			Help: "Number of BYOK private channels per owner (set by mutation path).",
		},
		[]string{"owner_id"},
	)

	// BYOKRequestTotal 在每条 BYOK relay usage 结算完成时按 (owner_type, model) +1。
	// owner_type 必为 "private"(admin 走非 BYOK 路径不入此 metric)。
	BYOKRequestTotal = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "byok_request_total",
			Help: "Total BYOK relay requests settled, labelled by owner_type and model.",
		},
		[]string{"owner_type", "model"},
	)

	// BYOKDecryptFailureTotal 由 byokcrypto.SanitizeDecryptErr 每次 sanitize 时 +1。
	// 替换 Task 8 临时 stub(interface{ Inc() } / noopCounter{})。
	// 调用点 sanitize.go 用 .Inc() 调,prometheus.Counter 也实现该方法,签名兼容。
	BYOKDecryptFailureTotal = prometheus.NewCounter(
		prometheus.CounterOpts{
			Name: "byok_decrypt_failure_total",
			Help: "Number of BYOK ciphertext decrypt failures detected via SanitizeDecryptErr.",
		},
	)
)

Functions

func NewAuthenticatedHandler added in v0.0.15

func NewAuthenticatedHandler(gatherer prometheus.Gatherer, token string) http.Handler

NewAuthenticatedHandler exposes gatherer metrics to requests carrying token.

Types

type AgentRelayMetrics added in v0.0.13

type AgentRelayMetrics struct {
	// contains filtered or unexported fields
}

func NewAgentRelayMetrics added in v0.0.13

func NewAgentRelayMetrics(registerer prometheus.Registerer, gatherer prometheus.Gatherer) *AgentRelayMetrics

func (*AgentRelayMetrics) AddDirectSessions added in v0.0.14

func (m *AgentRelayMetrics) AddDirectSessions(state DirectSessionState, delta float64)

func (*AgentRelayMetrics) AddDirectStreams added in v0.0.14

func (m *AgentRelayMetrics) AddDirectStreams(delta float64)

func (*AgentRelayMetrics) AddTunnelBytes added in v0.0.13

func (m *AgentRelayMetrics) AddTunnelBytes(direction Direction, value float64)

func (*AgentRelayMetrics) Handler added in v0.0.13

func (m *AgentRelayMetrics) Handler() http.Handler

func (*AgentRelayMetrics) IncConnectivityProbe added in v0.0.13

func (m *AgentRelayMetrics) IncConnectivityProbe(path PathKind, result ProbeResult)

func (*AgentRelayMetrics) IncDirectProbe added in v0.0.13

func (m *AgentRelayMetrics) IncDirectProbe(result ProbeResult)

func (*AgentRelayMetrics) IncDirectSessionDial added in v0.0.14

func (m *AgentRelayMetrics) IncDirectSessionDial(result DirectDialResult, reason DirectReasonCode)

func (*AgentRelayMetrics) IncDirectSessionReuse added in v0.0.14

func (m *AgentRelayMetrics) IncDirectSessionReuse()

func (*AgentRelayMetrics) IncPathDisabled added in v0.0.14

func (m *AgentRelayMetrics) IncPathDisabled(path PathKind, reason DirectReasonCode)

func (*AgentRelayMetrics) IncRouteTelemetryDropped added in v0.0.13

func (m *AgentRelayMetrics) IncRouteTelemetryDropped()

func (*AgentRelayMetrics) IncTunnelReset added in v0.0.13

func (m *AgentRelayMetrics) IncTunnelReset(stage Stage, committed bool)

func (*AgentRelayMetrics) ObserveDirectResultFrame added in v0.0.14

func (m *AgentRelayMetrics) ObserveDirectResultFrame(result ResultKind, reason DirectReasonCode, payloadBytes ...int)

func (*AgentRelayMetrics) ObserveDirectSessionDuration added in v0.0.14

func (m *AgentRelayMetrics) ObserveDirectSessionDuration(duration time.Duration)

func (*AgentRelayMetrics) ObserveFallback added in v0.0.13

func (m *AgentRelayMetrics) ObserveFallback(fallback RouteFallback)

func (*AgentRelayMetrics) ObserveRouteAttempt added in v0.0.13

func (m *AgentRelayMetrics) ObserveRouteAttempt(attempt RouteAttempt)

func (*AgentRelayMetrics) SetTunnelSession added in v0.0.13

func (m *AgentRelayMetrics) SetTunnelSession(availability SessionAvailability, convergence SessionConvergence, value float64)

func (*AgentRelayMetrics) SetTunnelStreams added in v0.0.13

func (m *AgentRelayMetrics) SetTunnelStreams(value float64)

type AttemptResult added in v0.0.13

type AttemptResult string
const (
	ResultSuccess  AttemptResult = "success"
	ResultFailure  AttemptResult = "failure"
	ResultFallback AttemptResult = "fallback"
)

type DirectDialResult added in v0.0.14

type DirectDialResult string
const (
	DirectDialSucceeded DirectDialResult = "success"
	DirectDialFailed    DirectDialResult = "failure"
)

type DirectReasonCode added in v0.0.14

type DirectReasonCode string
const (
	DirectReasonNone                   DirectReasonCode = "none"
	DirectReasonProtocol               DirectReasonCode = "protocol"
	DirectReasonPolicy                 DirectReasonCode = "policy"
	DirectReasonCapacity               DirectReasonCode = "capacity"
	DirectReasonAuth                   DirectReasonCode = "auth"
	DirectReasonUnavailable            DirectReasonCode = "unavailable"
	DirectReasonCanceled               DirectReasonCode = "canceled"
	DirectReasonTimeout                DirectReasonCode = "timeout"
	DirectReasonClosed                 DirectReasonCode = "closed"
	DirectReasonSourceOutboundDisabled DirectReasonCode = "source_direct_outbound_disabled"
	DirectReasonTargetInboundDisabled  DirectReasonCode = "target_direct_inbound_disabled"
	DirectReasonOther                  DirectReasonCode = "other"
)

type DirectSessionState added in v0.0.14

type DirectSessionState string
const (
	DirectSessionConnecting DirectSessionState = "connecting"
	DirectSessionActive     DirectSessionState = "active"
	DirectSessionDraining   DirectSessionState = "draining"
)

type Direction added in v0.0.13

type Direction string
const (
	DirectionInbound  Direction = "inbound"
	DirectionOutbound Direction = "outbound"
)

type LogDeliveryMetrics added in v0.0.14

type LogDeliveryMetrics struct {
	// contains filtered or unexported fields
}

func NewLogDeliveryMetrics added in v0.0.14

func NewLogDeliveryMetrics(registerer prometheus.Registerer) *LogDeliveryMetrics

func (*LogDeliveryMetrics) BacklogCleared added in v0.0.14

func (m *LogDeliveryMetrics) BacklogCleared(total, cleared uint64)

func (*LogDeliveryMetrics) Observe added in v0.0.14

func (m *LogDeliveryMetrics) Observe(stats deliveryqueue.Stats, schemaReady bool)

func (*LogDeliveryMetrics) SnapshotFailure added in v0.0.14

func (m *LogDeliveryMetrics) SnapshotFailure()

func (*LogDeliveryMetrics) WriteFailure added in v0.0.14

func (m *LogDeliveryMetrics) WriteFailure()

type PathKind added in v0.0.13

type PathKind string
const (
	PathDirect PathKind = "direct"
	PathRelay  PathKind = "relay"
	PathLocal  PathKind = "local"
	PathOther  PathKind = "other"
)

type ProbeResult added in v0.0.13

type ProbeResult string
const (
	ProbeVerified    ProbeResult = "verified"
	ProbeReachable   ProbeResult = "reachable"
	ProbeInvalid     ProbeResult = "invalid"
	ProbeUnreachable ProbeResult = "unreachable"
	ProbeUnavailable ProbeResult = "unavailable"
	ProbeUnknown     ProbeResult = "unknown"
	ProbeCancelled   ProbeResult = "cancelled"
)

type ReasonClass added in v0.0.13

type ReasonClass string
const (
	ReasonAvailability ReasonClass = "availability"
	ReasonCapacity     ReasonClass = "capacity"
	ReasonAuth         ReasonClass = "auth"
	ReasonProtocol     ReasonClass = "protocol"
	ReasonPolicy       ReasonClass = "policy"
)

type ResultKind added in v0.0.14

type ResultKind string

ResultKind contains only bounded result-frame outcomes. Valid attempt result kinds retain their wire spelling; protocol failures use the two fixed values.

const (
	ResultInvalid  ResultKind = "invalid"
	ResultTooLarge ResultKind = "too_large"
	ResultOther    ResultKind = "other"
)

type RouteAttempt added in v0.0.13

type RouteAttempt struct {
	PathKind PathKind
	Result   AttemptResult
	Stage    Stage
}

type RouteFallback added in v0.0.13

type RouteFallback struct {
	From        PathKind
	To          PathKind
	ReasonClass ReasonClass
}

type SessionAvailability added in v0.0.13

type SessionAvailability string
const (
	SessionAvailable   SessionAvailability = "available"
	SessionUnavailable SessionAvailability = "unavailable"
	SessionDraining    SessionAvailability = "draining"
)

type SessionConvergence added in v0.0.13

type SessionConvergence string
const (
	ConvergenceConverged  SessionConvergence = "converged"
	ConvergenceConverging SessionConvergence = "converging"
)

type Stage added in v0.0.13

type Stage string
const (
	StageSelect   Stage = "select"
	StageDial     Stage = "dial"
	StageAuth     Stage = "auth"
	StageProtocol Stage = "protocol"
	StageResponse Stage = "response"
	StageCommit   Stage = "commit"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL