openstack

type Config struct {
	// LogLevel is the slog threshold, one of DEBUG, INFO, WARN, or ERROR.
	LogLevel string `env:"TALLY_LOG_LEVEL" envDefault:"INFO"`
	// MetricsEnabled exposes the instrumentation: false makes GET /metrics answer
	// 404. The variable has no OSC infix because roadmap section 8 lists it among
	// the common variables every service reads.
	MetricsEnabled bool `env:"TALLY_METRICS_ENABLED" envDefault:"true"`
	// HTTPPort is the port the probe and metrics endpoints listen on. The
	// collector serves no API of its own.
	HTTPPort int `env:"TALLY_OSC_HTTP_PORT" envDefault:"8080"`
	// AMQPURL is the broker the notifications are consumed from. It carries the
	// broker password, so it supports the *_FILE convention.
	AMQPURL string `env:"TALLY_OSC_AMQP_URL"`
	// Exchanges are the service exchanges the collector binds its queue to. The
	// default covers nova, neutron, cinder and glance: cinder sets no
	// control_exchange of its own and publishes on oslo's default, openstack. A
	// deployment that renamed an exchange through control_exchange lists its own.
	//
	// An exchange the broker does not carry is skipped with a warning and bound
	// once it appears, which is what a fresh cloud needs: glance declares its
	// exchange with its first notification. Octavia publishes on the exchange
	// octavia, and the default leaves it out, because a deployment that runs none
	// would report it missing for as long as the collector runs. A deployment with
	// octavia lists nova,neutron,openstack,glance,octavia.
	Exchanges []string `env:"TALLY_OSC_EXCHANGES" envSeparator:"," envDefault:"nova,neutron,openstack,glance"`
	// Topics are the notification topics bound on each exchange, matching the
	// notification_topics of the services being collected.
	Topics []string `env:"TALLY_OSC_TOPICS" envSeparator:"," envDefault:"notifications.info"`
	// RequireExchanges makes a missing exchange fail the AMQP session instead of
	// being skipped: the collector then consumes nothing until the broker carries
	// every exchange it lists. It is for a deployment that would rather stop than
	// collect from a part of the cloud, and for the simulator stack, whose wait
	// for the collector reads a consumer on the queue as a queue that is bound.
	RequireExchanges bool `env:"TALLY_OSC_REQUIRE_EXCHANGES" envDefault:"false"`
	// QueueType is the type the queue tally-notifications is declared with,
	// quorum or classic. quorum is the default: it declares a replicated queue
	// with the delivery limit disabled, and needs RabbitMQ 4.0 or newer. classic
	// sends no queue type and leaves the choice to the broker: a classic queue on
	// one node, unless the virtual host's default_queue_type is quorum, which
	// creates a quorum queue with the broker's own delivery limit. classic is the
	// setting for a broker older than RabbitMQ 4.0 and for a queue that stays on
	// one node. An existing queue keeps its type, so declaring it with the other
	// one means deleting the queue first.
	QueueType string `env:"TALLY_OSC_QUEUE_TYPE" envDefault:"quorum"`
	// Cloud is the cloud name every emitted event is attributed to. It has no
	// default because a guessed cloud silently books usage to the wrong one.
	Cloud string `env:"TALLY_OSC_CLOUD"`
	// ReportingURL is the base URL of the Reporting API the sender posts to. It
	// must be an absolute https URL, because the ingest token travels on it;
	// ReportingInsecure is what allows a plaintext one.
	ReportingURL string `env:"TALLY_OSC_REPORTING_URL"`
	// ReportingInsecure allows an http Reporting API. It exists for a collector
	// and an API on the same trusted network, and for development; anywhere else
	// it puts the ingest token on the wire in cleartext.
	ReportingInsecure bool `env:"TALLY_OSC_REPORTING_INSECURE" envDefault:"false"`
	// Token authenticates the sender against the Reporting API. Supports the
	// *_FILE convention.
	Token string `env:"TALLY_OSC_TOKEN"`
	// BufferPath is the SQLite file backing the outbox. It belongs on a volume
	// that outlives the container: everything consumed but not yet delivered
	// lives there and nowhere else.
	BufferPath string `env:"TALLY_OSC_BUFFER_PATH"`
	// BatchMax is how many buffered events one POST carries, bounded by what the
	// ingest API accepts.
	BatchMax int `env:"TALLY_OSC_BATCH_MAX" envDefault:"500"`
	// FlushIntervalSeconds is how long the sender waits before posting a batch
	// that has not filled up.
	FlushIntervalSeconds int `env:"TALLY_OSC_FLUSH_INTERVAL_S" envDefault:"5"`
	// BufferMaxEvents is the outbox depth at which the collector stops consuming.
	// The events then wait on the bus instead of being dropped, which is what
	// keeps an unreachable Reporting API from costing usage data.
	BufferMaxEvents int64 `env:"TALLY_OSC_BUFFER_MAX_EVENTS" envDefault:"1000000"`
	// Prefetch is the AMQP QoS bound: how many unacknowledged messages the broker
	// hands out. Acks follow the outbox insert, so this bounds how much work a
	// crash replays.
	Prefetch int `env:"TALLY_OSC_PREFETCH" envDefault:"100"`
	// UnhealthyThresholdSeconds is how long readiness may keep failing before
	// liveness fails too and the orchestrator restarts the pod.
	UnhealthyThresholdSeconds int `env:"TALLY_OSC_UNHEALTHY_THRESHOLD_S" envDefault:"600"`
	// SummaryIntervalSeconds is how often the collector logs its summary line: the
	// notifications consumed, skipped and unparseable and the events delivered
	// since the previous line, with the state of the session and of the outbox.
	// The line is logged whether or not anything happened, so a collector at rest
	// still reports itself. It cannot be turned off; TALLY_LOG_LEVEL=WARN hides it.
	SummaryIntervalSeconds int `env:"TALLY_OSC_SUMMARY_INTERVAL_S" envDefault:"60"`
}

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

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

type Notification struct {
	// MessageID is the id the emitting service assigned the notification. It is
	// unique per notification, which makes it the key a redelivery is recognized
	// by.
	MessageID string
	// EventType names what happened, such as "compute.instance.create.end". The
	// namespace is the emitting service's own, not Tally's.
	EventType string
	// Timestamp is when the service recorded the event, always in UTC.
	Timestamp time.Time
	// Payload is the service's description of the resource, decoded as it
	// arrived. Its numbers are json.Number and not float64, so a quantity keeps
	// every digit it was sent with and can still be turned into an exact decimal.
	Payload map[string]any
	// ContextProjectID is the project the request ran in, taken from the request
	// context the service attaches to its notifications.
	ContextProjectID string
	// ContextTenantID is the same project under its older name. Services differ
	// in which of the two they set, so both are read and the caller takes
	// whichever is populated.
	ContextTenantID string
}

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

type Row struct {
	// ID orders the buffer and addresses the row in DeleteBatch.
	ID int64
	// EventJSON is the canonical event, byte for byte as Insert received it.
	EventJSON []byte
}

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

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

type Totals struct {
	Consumed, Skipped, Unparseable, Delivered, DeliveryErrors int64
}