adminapi

package
v0.49.0 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2026 License: Apache-2.0 Imports: 27 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithServerURL 

func WithServerURL(ctx context.Context, u *url.URL) context.Context

WithServerURL sets context key to override server URL.

Types

type ActionName 

type ActionName string

Supported runtime control actions. Ref: #/components/schemas/ActionName 

const (
	ActionNameGc              ActionName = "gc"
	ActionNameFreeOsMemory    ActionName = "free-os-memory"
	ActionNameStorageMaintain ActionName = "storage-maintain"
)

func (ActionName) AllValues 

func (ActionName) AllValues() []ActionName

AllValues returns all ActionName values.

func (*ActionName) Decode 

func (s *ActionName) Decode(d *jx.Decoder) error

Decode decodes ActionName from json.

func (ActionName) Encode 

func (s ActionName) Encode(e *jx.Encoder)

Encode encodes ActionName as json.

func (ActionName) MarshalJSON 

func (s ActionName) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (ActionName) MarshalText 

func (s ActionName) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*ActionName) UnmarshalJSON 

func (s *ActionName) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ActionName) UnmarshalText 

func (s *ActionName) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (ActionName) Validate 

func (s ActionName) Validate() error

type ActionResult 

type ActionResult struct {
	Action ActionName `json:"action"`
	Ok     bool       `json:"ok"`
	// Human-readable outcome.
	Message string `json:"message"`
	// Heap bytes released, for memory-reclaiming actions.
	FreedBytes OptInt64 `json:"freed_bytes"`
}

Ref: #/components/schemas/ActionResult

func (*ActionResult) Decode 

func (s *ActionResult) Decode(d *jx.Decoder) error

Decode decodes ActionResult from json.

func (*ActionResult) Encode 

func (s *ActionResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ActionResult) GetAction 

func (s *ActionResult) GetAction() ActionName

GetAction returns the value of Action.

func (*ActionResult) GetFreedBytes 

func (s *ActionResult) GetFreedBytes() OptInt64

GetFreedBytes returns the value of FreedBytes.

func (*ActionResult) GetMessage 

func (s *ActionResult) GetMessage() string

GetMessage returns the value of Message.

func (*ActionResult) GetOk 

func (s *ActionResult) GetOk() bool

GetOk returns the value of Ok.

func (*ActionResult) MarshalJSON 

func (s *ActionResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ActionResult) SetAction 

func (s *ActionResult) SetAction(val ActionName)

SetAction sets the value of Action.

func (*ActionResult) SetFreedBytes 

func (s *ActionResult) SetFreedBytes(val OptInt64)

SetFreedBytes sets the value of FreedBytes.

func (*ActionResult) SetMessage 

func (s *ActionResult) SetMessage(val string)

SetMessage sets the value of Message.

func (*ActionResult) SetOk 

func (s *ActionResult) SetOk(val bool)

SetOk sets the value of Ok.

func (*ActionResult) UnmarshalJSON 

func (s *ActionResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ActionResult) Validate 

func (s *ActionResult) Validate() error

type AdmissionStats 

type AdmissionStats struct {
	Accepted int64 `json:"accepted"`
	// Rejected as out-of-order.
	RejectedOoo int64 `json:"rejected_ooo"`
	// Rejected by rate limit.
	RejectedRate int64 `json:"rejected_rate"`
	// Rejected by cardinality limit.
	RejectedCardinality int64 `json:"rejected_cardinality"`
	// Rejected due to in-flight admission pressure.
	RejectedInFlight int64 `json:"rejected_in_flight"`
	SampledDropped   int64 `json:"sampled_dropped"`
	Overflowed       int64 `json:"overflowed"`
}

Ingestion admission counters for a tenant. Ref: #/components/schemas/AdmissionStats

func (*AdmissionStats) Decode 

func (s *AdmissionStats) Decode(d *jx.Decoder) error

Decode decodes AdmissionStats from json.

func (*AdmissionStats) Encode 

func (s *AdmissionStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*AdmissionStats) GetAccepted 

func (s *AdmissionStats) GetAccepted() int64

GetAccepted returns the value of Accepted.

func (*AdmissionStats) GetOverflowed 

func (s *AdmissionStats) GetOverflowed() int64

GetOverflowed returns the value of Overflowed.

func (*AdmissionStats) GetRejectedCardinality 

func (s *AdmissionStats) GetRejectedCardinality() int64

GetRejectedCardinality returns the value of RejectedCardinality.

func (*AdmissionStats) GetRejectedInFlight 

func (s *AdmissionStats) GetRejectedInFlight() int64

GetRejectedInFlight returns the value of RejectedInFlight.

func (*AdmissionStats) GetRejectedOoo 

func (s *AdmissionStats) GetRejectedOoo() int64

GetRejectedOoo returns the value of RejectedOoo.

func (*AdmissionStats) GetRejectedRate 

func (s *AdmissionStats) GetRejectedRate() int64

GetRejectedRate returns the value of RejectedRate.

func (*AdmissionStats) GetSampledDropped 

func (s *AdmissionStats) GetSampledDropped() int64

GetSampledDropped returns the value of SampledDropped.

func (*AdmissionStats) MarshalJSON 

func (s *AdmissionStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AdmissionStats) SetAccepted 

func (s *AdmissionStats) SetAccepted(val int64)

SetAccepted sets the value of Accepted.

func (*AdmissionStats) SetOverflowed 

func (s *AdmissionStats) SetOverflowed(val int64)

SetOverflowed sets the value of Overflowed.

func (*AdmissionStats) SetRejectedCardinality 

func (s *AdmissionStats) SetRejectedCardinality(val int64)

SetRejectedCardinality sets the value of RejectedCardinality.

func (*AdmissionStats) SetRejectedInFlight 

func (s *AdmissionStats) SetRejectedInFlight(val int64)

SetRejectedInFlight sets the value of RejectedInFlight.

func (*AdmissionStats) SetRejectedOoo 

func (s *AdmissionStats) SetRejectedOoo(val int64)

SetRejectedOoo sets the value of RejectedOoo.

func (*AdmissionStats) SetRejectedRate 

func (s *AdmissionStats) SetRejectedRate(val int64)

SetRejectedRate sets the value of RejectedRate.

func (*AdmissionStats) SetSampledDropped 

func (s *AdmissionStats) SetSampledDropped(val int64)

SetSampledDropped sets the value of SampledDropped.

func (*AdmissionStats) UnmarshalJSON 

func (s *AdmissionStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type CacheStats 

type CacheStats struct {
	DecodeCache DecodeCacheStats `json:"decode_cache"`
}

Ref: #/components/schemas/CacheStats

func (*CacheStats) Decode 

func (s *CacheStats) Decode(d *jx.Decoder) error

Decode decodes CacheStats from json.

func (*CacheStats) Encode 

func (s *CacheStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CacheStats) GetDecodeCache 

func (s *CacheStats) GetDecodeCache() DecodeCacheStats

GetDecodeCache returns the value of DecodeCache.

func (*CacheStats) MarshalJSON 

func (s *CacheStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CacheStats) SetDecodeCache 

func (s *CacheStats) SetDecodeCache(val DecodeCacheStats)

SetDecodeCache sets the value of DecodeCache.

func (*CacheStats) UnmarshalJSON 

func (s *CacheStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ClickHouseStats 

type ClickHouseStats struct {
	Tables []TableStats `json:"tables"`
}

Deprecated ClickHouse storage statistics. Ref: #/components/schemas/ClickHouseStats

func (*ClickHouseStats) Decode 

func (s *ClickHouseStats) Decode(d *jx.Decoder) error

Decode decodes ClickHouseStats from json.

func (*ClickHouseStats) Encode 

func (s *ClickHouseStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ClickHouseStats) GetTables 

func (s *ClickHouseStats) GetTables() []TableStats

GetTables returns the value of Tables.

func (*ClickHouseStats) MarshalJSON 

func (s *ClickHouseStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ClickHouseStats) SetTables 

func (s *ClickHouseStats) SetTables(val []TableStats)

SetTables sets the value of Tables.

func (*ClickHouseStats) UnmarshalJSON 

func (s *ClickHouseStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ClickHouseStats) Validate 

func (s *ClickHouseStats) Validate() error

type Client 

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

Client implements OAS client.

func NewClient 

func NewClient(serverURL string, opts ...ClientOption) (*Client, error)

NewClient initializes new Client defined by OAS.

func (*Client) GetEfficiency 

func (c *Client) GetEfficiency(ctx context.Context) (*EfficiencyStats, error)

GetEfficiency invokes getEfficiency operation.

Per-tenant, per-signal capacity and efficiency breakdown of the embedded storage engine: series, parts, points, stored bytes, bytes per point and compression ratios. Unlike the other storage endpoints this one performs backend I/O (per-part object sizes) — poll it at dashboard cadence, not per request. Empty when the embedded engine is not active.

GET /api/v1/storage/efficiency

func (*Client) GetHealth 

func (c *Client) GetHealth(ctx context.Context) (*HealthReport, error)

GetHealth invokes getHealth operation.

Health of each wired service (query APIs, collector, storage).

GET /api/v1/health

func (*Client) GetInfo 

func (c *Client) GetInfo(ctx context.Context) (*InstanceInfo, error)

GetInfo invokes getInfo operation.

Build information, uptime and per-signal backend configuration.

GET /api/v1/info

func (*Client) GetRuntime 

func (c *Client) GetRuntime(ctx context.Context) (*RuntimeStats, error)

GetRuntime invokes getRuntime operation.

Live heap, GC and goroutine counters of the running process.

GET /api/v1/runtime

func (*Client) GetStorage 

func (c *Client) GetStorage(ctx context.Context) (*StorageStats, error)

GetStorage invokes getStorage operation.

Per-table statistics (rows, on-disk and uncompressed bytes, parts, min/max timestamp) collected from ClickHouse system tables. Empty when no signal is served from ClickHouse.

GET /api/v1/storage

func (*Client) RunAction 

func (c *Client) RunAction(ctx context.Context, params RunActionParams) (*ActionResult, error)

RunAction invokes runAction operation.

Execute a maintenance action against the running process.

POST /api/v1/actions/{action}

type ClientOption 

type ClientOption interface {
	// contains filtered or unexported methods
}

ClientOption is client config option.

func WithClient 

func WithClient(client ht.Client) ClientOption

WithClient specifies http client to use.

type ClusterMember 

type ClusterMember struct {
	ID   string    `json:"id"`
	Zone OptString `json:"zone"`
	Addr OptString `json:"addr"`
}

Ref: #/components/schemas/ClusterMember

func (*ClusterMember) Decode 

func (s *ClusterMember) Decode(d *jx.Decoder) error

Decode decodes ClusterMember from json.

func (*ClusterMember) Encode 

func (s *ClusterMember) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ClusterMember) GetAddr 

func (s *ClusterMember) GetAddr() OptString

GetAddr returns the value of Addr.

func (*ClusterMember) GetID 

func (s *ClusterMember) GetID() string

GetID returns the value of ID.

func (*ClusterMember) GetZone 

func (s *ClusterMember) GetZone() OptString

GetZone returns the value of Zone.

func (*ClusterMember) MarshalJSON 

func (s *ClusterMember) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ClusterMember) SetAddr 

func (s *ClusterMember) SetAddr(val OptString)

SetAddr sets the value of Addr.

func (*ClusterMember) SetID 

func (s *ClusterMember) SetID(val string)

SetID sets the value of ID.

func (*ClusterMember) SetZone 

func (s *ClusterMember) SetZone(val OptString)

SetZone sets the value of Zone.

func (*ClusterMember) UnmarshalJSON 

func (s *ClusterMember) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ClusterStats 

type ClusterStats struct {
	// This node's ring id.
	Self    string          `json:"self"`
	Members []ClusterMember `json:"members"`
	// Shard keys owned by this node.
	Owned    []string         `json:"owned"`
	PartSync OptPartSyncStats `json:"part_sync"`
	Ec       OptECStats       `json:"ec"`
}

Cluster membership, present only in cluster mode. Ref: #/components/schemas/ClusterStats

func (*ClusterStats) Decode 

func (s *ClusterStats) Decode(d *jx.Decoder) error

Decode decodes ClusterStats from json.

func (*ClusterStats) Encode 

func (s *ClusterStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ClusterStats) GetEc 

func (s *ClusterStats) GetEc() OptECStats

GetEc returns the value of Ec.

func (*ClusterStats) GetMembers 

func (s *ClusterStats) GetMembers() []ClusterMember

GetMembers returns the value of Members.

func (*ClusterStats) GetOwned 

func (s *ClusterStats) GetOwned() []string

GetOwned returns the value of Owned.

func (*ClusterStats) GetPartSync 

func (s *ClusterStats) GetPartSync() OptPartSyncStats

GetPartSync returns the value of PartSync.

func (*ClusterStats) GetSelf 

func (s *ClusterStats) GetSelf() string

GetSelf returns the value of Self.

func (*ClusterStats) MarshalJSON 

func (s *ClusterStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ClusterStats) SetEc 

func (s *ClusterStats) SetEc(val OptECStats)

SetEc sets the value of Ec.

func (*ClusterStats) SetMembers 

func (s *ClusterStats) SetMembers(val []ClusterMember)

SetMembers sets the value of Members.

func (*ClusterStats) SetOwned 

func (s *ClusterStats) SetOwned(val []string)

SetOwned sets the value of Owned.

func (*ClusterStats) SetPartSync 

func (s *ClusterStats) SetPartSync(val OptPartSyncStats)

SetPartSync sets the value of PartSync.

func (*ClusterStats) SetSelf 

func (s *ClusterStats) SetSelf(val string)

SetSelf sets the value of Self.

func (*ClusterStats) UnmarshalJSON 

func (s *ClusterStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ClusterStats) Validate 

func (s *ClusterStats) Validate() error

type ComponentHealth 

type ComponentHealth struct {
	// Component/service name.
	Name   string       `json:"name"`
	Status HealthStatus `json:"status"`
	// Listen address, when the component is an HTTP server.
	Addr OptString `json:"addr"`
	// Last error, when unhealthy.
	Error OptString `json:"error"`
}

Ref: #/components/schemas/ComponentHealth

func (*ComponentHealth) Decode 

func (s *ComponentHealth) Decode(d *jx.Decoder) error

Decode decodes ComponentHealth from json.

func (*ComponentHealth) Encode 

func (s *ComponentHealth) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ComponentHealth) GetAddr 

func (s *ComponentHealth) GetAddr() OptString

GetAddr returns the value of Addr.

func (*ComponentHealth) GetError 

func (s *ComponentHealth) GetError() OptString

GetError returns the value of Error.

func (*ComponentHealth) GetName 

func (s *ComponentHealth) GetName() string

GetName returns the value of Name.

func (*ComponentHealth) GetStatus 

func (s *ComponentHealth) GetStatus() HealthStatus

GetStatus returns the value of Status.

func (*ComponentHealth) MarshalJSON 

func (s *ComponentHealth) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ComponentHealth) SetAddr 

func (s *ComponentHealth) SetAddr(val OptString)

SetAddr sets the value of Addr.

func (*ComponentHealth) SetError 

func (s *ComponentHealth) SetError(val OptString)

SetError sets the value of Error.

func (*ComponentHealth) SetName 

func (s *ComponentHealth) SetName(val string)

SetName sets the value of Name.

func (*ComponentHealth) SetStatus 

func (s *ComponentHealth) SetStatus(val HealthStatus)

SetStatus sets the value of Status.

func (*ComponentHealth) UnmarshalJSON 

func (s *ComponentHealth) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ComponentHealth) Validate 

func (s *ComponentHealth) Validate() error

type DecodeCacheStats 

type DecodeCacheStats struct {
	Hits   int64 `json:"hits"`
	Misses int64 `json:"misses"`
	Bytes  int64 `json:"bytes"`
	// Cached blocks.
	Items int64 `json:"items"`
}

Decoded-column cache, summed across metric engines. Ref: #/components/schemas/DecodeCacheStats

func (*DecodeCacheStats) Decode 

func (s *DecodeCacheStats) Decode(d *jx.Decoder) error

Decode decodes DecodeCacheStats from json.

func (*DecodeCacheStats) Encode 

func (s *DecodeCacheStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*DecodeCacheStats) GetBytes 

func (s *DecodeCacheStats) GetBytes() int64

GetBytes returns the value of Bytes.

func (*DecodeCacheStats) GetHits 

func (s *DecodeCacheStats) GetHits() int64

GetHits returns the value of Hits.

func (*DecodeCacheStats) GetItems 

func (s *DecodeCacheStats) GetItems() int64

GetItems returns the value of Items.

func (*DecodeCacheStats) GetMisses 

func (s *DecodeCacheStats) GetMisses() int64

GetMisses returns the value of Misses.

func (*DecodeCacheStats) MarshalJSON 

func (s *DecodeCacheStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DecodeCacheStats) SetBytes 

func (s *DecodeCacheStats) SetBytes(val int64)

SetBytes sets the value of Bytes.

func (*DecodeCacheStats) SetHits 

func (s *DecodeCacheStats) SetHits(val int64)

SetHits sets the value of Hits.

func (*DecodeCacheStats) SetItems 

func (s *DecodeCacheStats) SetItems(val int64)

SetItems sets the value of Items.

func (*DecodeCacheStats) SetMisses 

func (s *DecodeCacheStats) SetMisses(val int64)

SetMisses sets the value of Misses.

func (*DecodeCacheStats) UnmarshalJSON 

func (s *DecodeCacheStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ECStats 

type ECStats struct {
	// Cold parts erasure-coded by this node as their compaction owner.
	Converted int64 `json:"converted"`
	// Failed conversion attempts (retried on a later maintenance tick).
	ConvertErrors int64 `json:"convert_errors"`
	// Shard slots rebuilt from surviving shards.
	RepairedSlots int64 `json:"repaired_slots"`
	// Failed repair attempts.
	RepairErrors int64 `json:"repair_errors"`
	// Parts whose staged foreign shards were pruned after distribution.
	PrunedStagedParts int64 `json:"pruned_staged_parts"`
	// Read-path object reconstructions (no local full copy).
	Reconstructs int64 `json:"reconstructs"`
	// Reconstructions that failed and surfaced to the query.
	ReconstructErrors int64 `json:"reconstruct_errors"`
}

Cumulative erasure-coding activity of this node, present only when the cluster runs with a private (per-node) backend. All zeros when no tenant has an EC policy. A high reconstruct rate on cold reads is expected; growing errors are not. Ref: #/components/schemas/ECStats

func (*ECStats) Decode 

func (s *ECStats) Decode(d *jx.Decoder) error

Decode decodes ECStats from json.

func (*ECStats) Encode 

func (s *ECStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ECStats) GetConvertErrors 

func (s *ECStats) GetConvertErrors() int64

GetConvertErrors returns the value of ConvertErrors.

func (*ECStats) GetConverted 

func (s *ECStats) GetConverted() int64

GetConverted returns the value of Converted.

func (*ECStats) GetPrunedStagedParts 

func (s *ECStats) GetPrunedStagedParts() int64

GetPrunedStagedParts returns the value of PrunedStagedParts.

func (*ECStats) GetReconstructErrors 

func (s *ECStats) GetReconstructErrors() int64

GetReconstructErrors returns the value of ReconstructErrors.

func (*ECStats) GetReconstructs 

func (s *ECStats) GetReconstructs() int64

GetReconstructs returns the value of Reconstructs.

func (*ECStats) GetRepairErrors 

func (s *ECStats) GetRepairErrors() int64

GetRepairErrors returns the value of RepairErrors.

func (*ECStats) GetRepairedSlots 

func (s *ECStats) GetRepairedSlots() int64

GetRepairedSlots returns the value of RepairedSlots.

func (*ECStats) MarshalJSON 

func (s *ECStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ECStats) SetConvertErrors 

func (s *ECStats) SetConvertErrors(val int64)

SetConvertErrors sets the value of ConvertErrors.

func (*ECStats) SetConverted 

func (s *ECStats) SetConverted(val int64)

SetConverted sets the value of Converted.

func (*ECStats) SetPrunedStagedParts 

func (s *ECStats) SetPrunedStagedParts(val int64)

SetPrunedStagedParts sets the value of PrunedStagedParts.

func (*ECStats) SetReconstructErrors 

func (s *ECStats) SetReconstructErrors(val int64)

SetReconstructErrors sets the value of ReconstructErrors.

func (*ECStats) SetReconstructs 

func (s *ECStats) SetReconstructs(val int64)

SetReconstructs sets the value of Reconstructs.

func (*ECStats) SetRepairErrors 

func (s *ECStats) SetRepairErrors(val int64)

SetRepairErrors sets the value of RepairErrors.

func (*ECStats) SetRepairedSlots 

func (s *ECStats) SetRepairedSlots(val int64)

SetRepairedSlots sets the value of RepairedSlots.

func (*ECStats) UnmarshalJSON 

func (s *ECStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type EfficiencyStats 

type EfficiencyStats struct {
	// Whether the embedded oteldb/storage engine is active.
	StorageEnabled bool               `json:"storage_enabled"`
	Tenants        []TenantEfficiency `json:"tenants"`
}

Embedded storage capacity/efficiency breakdown. Ref: #/components/schemas/EfficiencyStats

func (*EfficiencyStats) Decode 

func (s *EfficiencyStats) Decode(d *jx.Decoder) error

Decode decodes EfficiencyStats from json.

func (*EfficiencyStats) Encode 

func (s *EfficiencyStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*EfficiencyStats) GetStorageEnabled 

func (s *EfficiencyStats) GetStorageEnabled() bool

GetStorageEnabled returns the value of StorageEnabled.

func (*EfficiencyStats) GetTenants 

func (s *EfficiencyStats) GetTenants() []TenantEfficiency

GetTenants returns the value of Tenants.

func (*EfficiencyStats) MarshalJSON 

func (s *EfficiencyStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*EfficiencyStats) SetStorageEnabled 

func (s *EfficiencyStats) SetStorageEnabled(val bool)

SetStorageEnabled sets the value of StorageEnabled.

func (*EfficiencyStats) SetTenants 

func (s *EfficiencyStats) SetTenants(val []TenantEfficiency)

SetTenants sets the value of Tenants.

func (*EfficiencyStats) UnmarshalJSON 

func (s *EfficiencyStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*EfficiencyStats) Validate 

func (s *EfficiencyStats) Validate() error

type EngineSignalStats 

type EngineSignalStats struct {
	Signal Signal `json:"signal"`
	// Distinct series/streams (head and flushed).
	Series int64 `json:"series"`
	// Unflushed samples/records in the head.
	HeadItems int64 `json:"head_items"`
	// Head buffered bytes.
	HeadBytes int64 `json:"head_bytes"`
	// Flushed immutable parts.
	Parts        int64       `json:"parts"`
	MinTime      OptDateTime `json:"min_time"`
	MaxTime      OptDateTime `json:"max_time"`
	MergeRunning bool        `json:"merge_running"`
	MergeBacklog int64       `json:"merge_backlog"`
	// Whether a write-ahead log is active for this signal.
	Wal         bool  `json:"wal"`
	WalSegments int64 `json:"wal_segments"`
	// Open WAL segment size.
	WalBytes int64 `json:"wal_bytes"`
}

Per-signal engine statistics for a tenant. Ref: #/components/schemas/EngineSignalStats

func (*EngineSignalStats) Decode 

func (s *EngineSignalStats) Decode(d *jx.Decoder) error

Decode decodes EngineSignalStats from json.

func (*EngineSignalStats) Encode 

func (s *EngineSignalStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*EngineSignalStats) GetHeadBytes 

func (s *EngineSignalStats) GetHeadBytes() int64

GetHeadBytes returns the value of HeadBytes.

func (*EngineSignalStats) GetHeadItems 

func (s *EngineSignalStats) GetHeadItems() int64

GetHeadItems returns the value of HeadItems.

func (*EngineSignalStats) GetMaxTime 

func (s *EngineSignalStats) GetMaxTime() OptDateTime

GetMaxTime returns the value of MaxTime.

func (*EngineSignalStats) GetMergeBacklog 

func (s *EngineSignalStats) GetMergeBacklog() int64

GetMergeBacklog returns the value of MergeBacklog.

func (*EngineSignalStats) GetMergeRunning 

func (s *EngineSignalStats) GetMergeRunning() bool

GetMergeRunning returns the value of MergeRunning.

func (*EngineSignalStats) GetMinTime 

func (s *EngineSignalStats) GetMinTime() OptDateTime

GetMinTime returns the value of MinTime.

func (*EngineSignalStats) GetParts 

func (s *EngineSignalStats) GetParts() int64

GetParts returns the value of Parts.

func (*EngineSignalStats) GetSeries 

func (s *EngineSignalStats) GetSeries() int64

GetSeries returns the value of Series.

func (*EngineSignalStats) GetSignal 

func (s *EngineSignalStats) GetSignal() Signal

GetSignal returns the value of Signal.

func (*EngineSignalStats) GetWal 

func (s *EngineSignalStats) GetWal() bool

GetWal returns the value of Wal.

func (*EngineSignalStats) GetWalBytes 

func (s *EngineSignalStats) GetWalBytes() int64

GetWalBytes returns the value of WalBytes.

func (*EngineSignalStats) GetWalSegments 

func (s *EngineSignalStats) GetWalSegments() int64

GetWalSegments returns the value of WalSegments.

func (*EngineSignalStats) MarshalJSON 

func (s *EngineSignalStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*EngineSignalStats) SetHeadBytes 

func (s *EngineSignalStats) SetHeadBytes(val int64)

SetHeadBytes sets the value of HeadBytes.

func (*EngineSignalStats) SetHeadItems 

func (s *EngineSignalStats) SetHeadItems(val int64)

SetHeadItems sets the value of HeadItems.

func (*EngineSignalStats) SetMaxTime 

func (s *EngineSignalStats) SetMaxTime(val OptDateTime)

SetMaxTime sets the value of MaxTime.

func (*EngineSignalStats) SetMergeBacklog 

func (s *EngineSignalStats) SetMergeBacklog(val int64)

SetMergeBacklog sets the value of MergeBacklog.

func (*EngineSignalStats) SetMergeRunning 

func (s *EngineSignalStats) SetMergeRunning(val bool)

SetMergeRunning sets the value of MergeRunning.

func (*EngineSignalStats) SetMinTime 

func (s *EngineSignalStats) SetMinTime(val OptDateTime)

SetMinTime sets the value of MinTime.

func (*EngineSignalStats) SetParts 

func (s *EngineSignalStats) SetParts(val int64)

SetParts sets the value of Parts.

func (*EngineSignalStats) SetSeries 

func (s *EngineSignalStats) SetSeries(val int64)

SetSeries sets the value of Series.

func (*EngineSignalStats) SetSignal 

func (s *EngineSignalStats) SetSignal(val Signal)

SetSignal sets the value of Signal.

func (*EngineSignalStats) SetWal 

func (s *EngineSignalStats) SetWal(val bool)

SetWal sets the value of Wal.

func (*EngineSignalStats) SetWalBytes 

func (s *EngineSignalStats) SetWalBytes(val int64)

SetWalBytes sets the value of WalBytes.

func (*EngineSignalStats) SetWalSegments 

func (s *EngineSignalStats) SetWalSegments(val int64)

SetWalSegments sets the value of WalSegments.

func (*EngineSignalStats) UnmarshalJSON 

func (s *EngineSignalStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*EngineSignalStats) Validate 

func (s *EngineSignalStats) Validate() error

type EngineStats 

type EngineStats struct {
	Tenants     []TenantStats    `json:"tenants"`
	Caches      CacheStats       `json:"caches"`
	Maintenance MaintenanceStats `json:"maintenance"`
	Cluster     OptClusterStats  `json:"cluster"`
}

Embedded oteldb/storage engine statistics. Ref: #/components/schemas/EngineStats

func (*EngineStats) Decode 

func (s *EngineStats) Decode(d *jx.Decoder) error

Decode decodes EngineStats from json.

func (*EngineStats) Encode 

func (s *EngineStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*EngineStats) GetCaches 

func (s *EngineStats) GetCaches() CacheStats

GetCaches returns the value of Caches.

func (*EngineStats) GetCluster 

func (s *EngineStats) GetCluster() OptClusterStats

GetCluster returns the value of Cluster.

func (*EngineStats) GetMaintenance 

func (s *EngineStats) GetMaintenance() MaintenanceStats

GetMaintenance returns the value of Maintenance.

func (*EngineStats) GetTenants 

func (s *EngineStats) GetTenants() []TenantStats

GetTenants returns the value of Tenants.

func (*EngineStats) MarshalJSON 

func (s *EngineStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*EngineStats) SetCaches 

func (s *EngineStats) SetCaches(val CacheStats)

SetCaches sets the value of Caches.

func (*EngineStats) SetCluster 

func (s *EngineStats) SetCluster(val OptClusterStats)

SetCluster sets the value of Cluster.

func (*EngineStats) SetMaintenance 

func (s *EngineStats) SetMaintenance(val MaintenanceStats)

SetMaintenance sets the value of Maintenance.

func (*EngineStats) SetTenants 

func (s *EngineStats) SetTenants(val []TenantStats)

SetTenants sets the value of Tenants.

func (*EngineStats) UnmarshalJSON 

func (s *EngineStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*EngineStats) Validate 

func (s *EngineStats) Validate() error

type Error 

type Error struct {
	// Human-readable error message.
	ErrorMessage string     `json:"error_message"`
	TraceID      OptTraceID `json:"trace_id"`
	SpanID       OptSpanID  `json:"span_id"`
}

Error occurred while processing request. Ref: #/components/schemas/Error

func (*Error) Decode 

func (s *Error) Decode(d *jx.Decoder) error

Decode decodes Error from json.

func (*Error) Encode 

func (s *Error) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*Error) GetErrorMessage 

func (s *Error) GetErrorMessage() string

GetErrorMessage returns the value of ErrorMessage.

func (*Error) GetSpanID 

func (s *Error) GetSpanID() OptSpanID

GetSpanID returns the value of SpanID.

func (*Error) GetTraceID 

func (s *Error) GetTraceID() OptTraceID

GetTraceID returns the value of TraceID.

func (*Error) MarshalJSON 

func (s *Error) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*Error) SetErrorMessage 

func (s *Error) SetErrorMessage(val string)

SetErrorMessage sets the value of ErrorMessage.

func (*Error) SetSpanID 

func (s *Error) SetSpanID(val OptSpanID)

SetSpanID sets the value of SpanID.

func (*Error) SetTraceID 

func (s *Error) SetTraceID(val OptTraceID)

SetTraceID sets the value of TraceID.

func (*Error) UnmarshalJSON 

func (s *Error) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*Error) Validate 

func (s *Error) Validate() error

type ErrorHandler 

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type ErrorStatusCode 

type ErrorStatusCode struct {
	StatusCode int
	Response   Error
}

ErrorStatusCode wraps Error with StatusCode.

func (*ErrorStatusCode) Error 

func (s *ErrorStatusCode) Error() string

func (*ErrorStatusCode) GetResponse 

func (s *ErrorStatusCode) GetResponse() Error

GetResponse returns the value of Response.

func (*ErrorStatusCode) GetStatusCode 

func (s *ErrorStatusCode) GetStatusCode() int

GetStatusCode returns the value of StatusCode.

func (*ErrorStatusCode) SetResponse 

func (s *ErrorStatusCode) SetResponse(val Error)

SetResponse sets the value of Response.

func (*ErrorStatusCode) SetStatusCode 

func (s *ErrorStatusCode) SetStatusCode(val int)

SetStatusCode sets the value of StatusCode.

func (*ErrorStatusCode) Validate 

func (s *ErrorStatusCode) Validate() error

type Handler 

type Handler interface {
	// GetEfficiency implements getEfficiency operation.
	//
	// Per-tenant, per-signal capacity and efficiency breakdown of the embedded storage engine: series,
	// parts, points, stored bytes, bytes per point and compression ratios. Unlike the other storage
	// endpoints this one performs backend I/O (per-part object sizes) — poll it at dashboard cadence,
	// not per request. Empty when the embedded engine is not active.
	//
	// GET /api/v1/storage/efficiency
	GetEfficiency(ctx context.Context) (*EfficiencyStats, error)
	// GetHealth implements getHealth operation.
	//
	// Health of each wired service (query APIs, collector, storage).
	//
	// GET /api/v1/health
	GetHealth(ctx context.Context) (*HealthReport, error)
	// GetInfo implements getInfo operation.
	//
	// Build information, uptime and per-signal backend configuration.
	//
	// GET /api/v1/info
	GetInfo(ctx context.Context) (*InstanceInfo, error)
	// GetRuntime implements getRuntime operation.
	//
	// Live heap, GC and goroutine counters of the running process.
	//
	// GET /api/v1/runtime
	GetRuntime(ctx context.Context) (*RuntimeStats, error)
	// GetStorage implements getStorage operation.
	//
	// Per-table statistics (rows, on-disk and uncompressed bytes, parts, min/max timestamp) collected from
	// ClickHouse system tables. Empty when no signal is served from ClickHouse.
	//
	// GET /api/v1/storage
	GetStorage(ctx context.Context) (*StorageStats, error)
	// RunAction implements runAction operation.
	//
	// Execute a maintenance action against the running process.
	//
	// POST /api/v1/actions/{action}
	RunAction(ctx context.Context, params RunActionParams) (*ActionResult, error)
	// NewError creates *ErrorStatusCode from error returned by handler.
	//
	// Used for common default response.
	NewError(ctx context.Context, err error) *ErrorStatusCode
}

Handler handles operations described by OpenAPI v3 specification.

type HealthReport 

type HealthReport struct {
	Status     HealthStatus      `json:"status"`
	Components []ComponentHealth `json:"components"`
}

Ref: #/components/schemas/HealthReport

func (*HealthReport) Decode 

func (s *HealthReport) Decode(d *jx.Decoder) error

Decode decodes HealthReport from json.

func (*HealthReport) Encode 

func (s *HealthReport) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*HealthReport) GetComponents 

func (s *HealthReport) GetComponents() []ComponentHealth

GetComponents returns the value of Components.

func (*HealthReport) GetStatus 

func (s *HealthReport) GetStatus() HealthStatus

GetStatus returns the value of Status.

func (*HealthReport) MarshalJSON 

func (s *HealthReport) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*HealthReport) SetComponents 

func (s *HealthReport) SetComponents(val []ComponentHealth)

SetComponents sets the value of Components.

func (*HealthReport) SetStatus 

func (s *HealthReport) SetStatus(val HealthStatus)

SetStatus sets the value of Status.

func (*HealthReport) UnmarshalJSON 

func (s *HealthReport) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*HealthReport) Validate 

func (s *HealthReport) Validate() error

type HealthStatus 

type HealthStatus string

Ref: #/components/schemas/HealthStatus 

const (
	HealthStatusHealthy   HealthStatus = "healthy"
	HealthStatusDegraded  HealthStatus = "degraded"
	HealthStatusUnhealthy HealthStatus = "unhealthy"
)

func (HealthStatus) AllValues 

func (HealthStatus) AllValues() []HealthStatus

AllValues returns all HealthStatus values.

func (*HealthStatus) Decode 

func (s *HealthStatus) Decode(d *jx.Decoder) error

Decode decodes HealthStatus from json.

func (HealthStatus) Encode 

func (s HealthStatus) Encode(e *jx.Encoder)

Encode encodes HealthStatus as json.

func (HealthStatus) MarshalJSON 

func (s HealthStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (HealthStatus) MarshalText 

func (s HealthStatus) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*HealthStatus) UnmarshalJSON 

func (s *HealthStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*HealthStatus) UnmarshalText 

func (s *HealthStatus) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (HealthStatus) Validate 

func (s HealthStatus) Validate() error

type InstanceInfo 

type InstanceInfo struct {
	// Build version.
	Version string `json:"version"`
	// VCS commit hash.
	Commit string `json:"commit"`
	// Go toolchain version the binary was built with.
	GoVersion string `json:"go_version"`
	Os        string `json:"os"`
	Arch      string `json:"arch"`
	// Process start time.
	StartTime time.Time `json:"start_time"`
	// Seconds since process start.
	UptimeSeconds float64 `json:"uptime_seconds"`
	// Whether the embedded oteldb/storage engine is active.
	StorageEnabled bool `json:"storage_enabled"`
	// Embedded storage engine backend (memory, file or s3), when enabled.
	StorageBackend OptString `json:"storage_backend"`
	// Whether the (deprecated) ClickHouse storage is active.
	ClickhouseEnabled bool `json:"clickhouse_enabled"`
	// Per-signal configuration.
	Signals []SignalInfo `json:"signals"`
}

Instance build info, uptime and per-signal configuration. Ref: #/components/schemas/InstanceInfo

func (*InstanceInfo) Decode 

func (s *InstanceInfo) Decode(d *jx.Decoder) error

Decode decodes InstanceInfo from json.

func (*InstanceInfo) Encode 

func (s *InstanceInfo) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*InstanceInfo) GetArch 

func (s *InstanceInfo) GetArch() string

GetArch returns the value of Arch.

func (*InstanceInfo) GetClickhouseEnabled 

func (s *InstanceInfo) GetClickhouseEnabled() bool

GetClickhouseEnabled returns the value of ClickhouseEnabled.

func (*InstanceInfo) GetCommit 

func (s *InstanceInfo) GetCommit() string

GetCommit returns the value of Commit.

func (*InstanceInfo) GetGoVersion 

func (s *InstanceInfo) GetGoVersion() string

GetGoVersion returns the value of GoVersion.

func (*InstanceInfo) GetOs 

func (s *InstanceInfo) GetOs() string

GetOs returns the value of Os.

func (*InstanceInfo) GetSignals 

func (s *InstanceInfo) GetSignals() []SignalInfo

GetSignals returns the value of Signals.

func (*InstanceInfo) GetStartTime 

func (s *InstanceInfo) GetStartTime() time.Time

GetStartTime returns the value of StartTime.

func (*InstanceInfo) GetStorageBackend 

func (s *InstanceInfo) GetStorageBackend() OptString

GetStorageBackend returns the value of StorageBackend.

func (*InstanceInfo) GetStorageEnabled 

func (s *InstanceInfo) GetStorageEnabled() bool

GetStorageEnabled returns the value of StorageEnabled.

func (*InstanceInfo) GetUptimeSeconds 

func (s *InstanceInfo) GetUptimeSeconds() float64

GetUptimeSeconds returns the value of UptimeSeconds.

func (*InstanceInfo) GetVersion 

func (s *InstanceInfo) GetVersion() string

GetVersion returns the value of Version.

func (*InstanceInfo) MarshalJSON 

func (s *InstanceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*InstanceInfo) SetArch 

func (s *InstanceInfo) SetArch(val string)

SetArch sets the value of Arch.

func (*InstanceInfo) SetClickhouseEnabled 

func (s *InstanceInfo) SetClickhouseEnabled(val bool)

SetClickhouseEnabled sets the value of ClickhouseEnabled.

func (*InstanceInfo) SetCommit 

func (s *InstanceInfo) SetCommit(val string)

SetCommit sets the value of Commit.

func (*InstanceInfo) SetGoVersion 

func (s *InstanceInfo) SetGoVersion(val string)

SetGoVersion sets the value of GoVersion.

func (*InstanceInfo) SetOs 

func (s *InstanceInfo) SetOs(val string)

SetOs sets the value of Os.

func (*InstanceInfo) SetSignals 

func (s *InstanceInfo) SetSignals(val []SignalInfo)

SetSignals sets the value of Signals.

func (*InstanceInfo) SetStartTime 

func (s *InstanceInfo) SetStartTime(val time.Time)

SetStartTime sets the value of StartTime.

func (*InstanceInfo) SetStorageBackend 

func (s *InstanceInfo) SetStorageBackend(val OptString)

SetStorageBackend sets the value of StorageBackend.

func (*InstanceInfo) SetStorageEnabled 

func (s *InstanceInfo) SetStorageEnabled(val bool)

SetStorageEnabled sets the value of StorageEnabled.

func (*InstanceInfo) SetUptimeSeconds 

func (s *InstanceInfo) SetUptimeSeconds(val float64)

SetUptimeSeconds sets the value of UptimeSeconds.

func (*InstanceInfo) SetVersion 

func (s *InstanceInfo) SetVersion(val string)

SetVersion sets the value of Version.

func (*InstanceInfo) UnmarshalJSON 

func (s *InstanceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*InstanceInfo) Validate 

func (s *InstanceInfo) Validate() error

type Invoker 

type Invoker interface {
	// GetEfficiency invokes getEfficiency operation.
	//
	// Per-tenant, per-signal capacity and efficiency breakdown of the embedded storage engine: series,
	// parts, points, stored bytes, bytes per point and compression ratios. Unlike the other storage
	// endpoints this one performs backend I/O (per-part object sizes) — poll it at dashboard cadence,
	// not per request. Empty when the embedded engine is not active.
	//
	// GET /api/v1/storage/efficiency
	GetEfficiency(ctx context.Context) (*EfficiencyStats, error)
	// GetHealth invokes getHealth operation.
	//
	// Health of each wired service (query APIs, collector, storage).
	//
	// GET /api/v1/health
	GetHealth(ctx context.Context) (*HealthReport, error)
	// GetInfo invokes getInfo operation.
	//
	// Build information, uptime and per-signal backend configuration.
	//
	// GET /api/v1/info
	GetInfo(ctx context.Context) (*InstanceInfo, error)
	// GetRuntime invokes getRuntime operation.
	//
	// Live heap, GC and goroutine counters of the running process.
	//
	// GET /api/v1/runtime
	GetRuntime(ctx context.Context) (*RuntimeStats, error)
	// GetStorage invokes getStorage operation.
	//
	// Per-table statistics (rows, on-disk and uncompressed bytes, parts, min/max timestamp) collected from
	// ClickHouse system tables. Empty when no signal is served from ClickHouse.
	//
	// GET /api/v1/storage
	GetStorage(ctx context.Context) (*StorageStats, error)
	// RunAction invokes runAction operation.
	//
	// Execute a maintenance action against the running process.
	//
	// POST /api/v1/actions/{action}
	RunAction(ctx context.Context, params RunActionParams) (*ActionResult, error)
}

Invoker invokes operations described by OpenAPI v3 specification.

type Labeler 

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

Labeler is used to allow adding custom attributes to the server request metrics.

func LabelerFromContext 

func LabelerFromContext(ctx context.Context) (*Labeler, bool)

LabelerFromContext retrieves the Labeler from the provided context, if present.

If no Labeler was found in the provided context a new, empty Labeler is returned and the second return value is false. In this case it is safe to use the Labeler but any attributes added to it will not be used.

func (*Labeler) Add 

func (l *Labeler) Add(attrs ...attribute.KeyValue)

Add attributes to the Labeler.

func (*Labeler) AttributeSet 

func (l *Labeler) AttributeSet() attribute.Set

AttributeSet returns the attributes added to the Labeler as an attribute.Set.

type MaintenanceStats 

type MaintenanceStats struct {
	// Completed maintenance cycles since process start (the loop-liveness probe).
	Cycles int64 `json:"cycles"`
	// Start of the most recent cycle, once one has run.
	LastCycleStart OptDateTime `json:"last_cycle_start"`
	// Duration of the most recent completed cycle.
	LastCycleDurationSeconds float64 `json:"last_cycle_duration_seconds"`
	// Engine tasks (flush/merge or replica refresh) dispatched in the most recent cycle.
	LastCycleTasks int64 `json:"last_cycle_tasks"`
}

Background maintenance loop liveness and recency. A growing cycle duration means compaction is falling behind the ingest rate. Ref: #/components/schemas/MaintenanceStats

func (*MaintenanceStats) Decode 

func (s *MaintenanceStats) Decode(d *jx.Decoder) error

Decode decodes MaintenanceStats from json.

func (*MaintenanceStats) Encode 

func (s *MaintenanceStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*MaintenanceStats) GetCycles 

func (s *MaintenanceStats) GetCycles() int64

GetCycles returns the value of Cycles.

func (*MaintenanceStats) GetLastCycleDurationSeconds 

func (s *MaintenanceStats) GetLastCycleDurationSeconds() float64

GetLastCycleDurationSeconds returns the value of LastCycleDurationSeconds.

func (*MaintenanceStats) GetLastCycleStart 

func (s *MaintenanceStats) GetLastCycleStart() OptDateTime

GetLastCycleStart returns the value of LastCycleStart.

func (*MaintenanceStats) GetLastCycleTasks 

func (s *MaintenanceStats) GetLastCycleTasks() int64

GetLastCycleTasks returns the value of LastCycleTasks.

func (*MaintenanceStats) MarshalJSON 

func (s *MaintenanceStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*MaintenanceStats) SetCycles 

func (s *MaintenanceStats) SetCycles(val int64)

SetCycles sets the value of Cycles.

func (*MaintenanceStats) SetLastCycleDurationSeconds 

func (s *MaintenanceStats) SetLastCycleDurationSeconds(val float64)

SetLastCycleDurationSeconds sets the value of LastCycleDurationSeconds.

func (*MaintenanceStats) SetLastCycleStart 

func (s *MaintenanceStats) SetLastCycleStart(val OptDateTime)

SetLastCycleStart sets the value of LastCycleStart.

func (*MaintenanceStats) SetLastCycleTasks 

func (s *MaintenanceStats) SetLastCycleTasks(val int64)

SetLastCycleTasks sets the value of LastCycleTasks.

func (*MaintenanceStats) UnmarshalJSON 

func (s *MaintenanceStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*MaintenanceStats) Validate 

func (s *MaintenanceStats) Validate() error

type Middleware 

type Middleware = middleware.Middleware

Middleware is middleware type.

type OperationName 

type OperationName = string

OperationName is the ogen operation name 

const (
	GetEfficiencyOperation OperationName = "GetEfficiency"
	GetHealthOperation     OperationName = "GetHealth"
	GetInfoOperation       OperationName = "GetInfo"
	GetRuntimeOperation    OperationName = "GetRuntime"
	GetStorageOperation    OperationName = "GetStorage"
	RunActionOperation     OperationName = "RunAction"
)

type OptClickHouseStats 

type OptClickHouseStats struct {
	Value ClickHouseStats
	Set   bool
}

OptClickHouseStats is optional ClickHouseStats.

func NewOptClickHouseStats 

func NewOptClickHouseStats(v ClickHouseStats) OptClickHouseStats

NewOptClickHouseStats returns new OptClickHouseStats with value set to v.

func (*OptClickHouseStats) Decode 

func (o *OptClickHouseStats) Decode(d *jx.Decoder) error

Decode decodes ClickHouseStats from json.

func (OptClickHouseStats) Encode 

func (o OptClickHouseStats) Encode(e *jx.Encoder)

Encode encodes ClickHouseStats as json.

func (OptClickHouseStats) Get 

func (o OptClickHouseStats) Get() (v ClickHouseStats, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptClickHouseStats) IsSet 

func (o OptClickHouseStats) IsSet() bool

IsSet returns true if OptClickHouseStats was set.

func (OptClickHouseStats) MarshalJSON 

func (s OptClickHouseStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptClickHouseStats) Or 

func (o OptClickHouseStats) Or(d ClickHouseStats) ClickHouseStats

Or returns value if set, or given parameter if does not.

func (*OptClickHouseStats) Reset 

func (o *OptClickHouseStats) Reset()

Reset unsets value.

func (*OptClickHouseStats) SetTo 

func (o *OptClickHouseStats) SetTo(v ClickHouseStats)

SetTo sets value to v.

func (*OptClickHouseStats) UnmarshalJSON 

func (s *OptClickHouseStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptClusterStats 

type OptClusterStats struct {
	Value ClusterStats
	Set   bool
}

OptClusterStats is optional ClusterStats.

func NewOptClusterStats 

func NewOptClusterStats(v ClusterStats) OptClusterStats

NewOptClusterStats returns new OptClusterStats with value set to v.

func (*OptClusterStats) Decode 

func (o *OptClusterStats) Decode(d *jx.Decoder) error

Decode decodes ClusterStats from json.

func (OptClusterStats) Encode 

func (o OptClusterStats) Encode(e *jx.Encoder)

Encode encodes ClusterStats as json.

func (OptClusterStats) Get 

func (o OptClusterStats) Get() (v ClusterStats, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptClusterStats) IsSet 

func (o OptClusterStats) IsSet() bool

IsSet returns true if OptClusterStats was set.

func (OptClusterStats) MarshalJSON 

func (s OptClusterStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptClusterStats) Or 

func (o OptClusterStats) Or(d ClusterStats) ClusterStats

Or returns value if set, or given parameter if does not.

func (*OptClusterStats) Reset 

func (o *OptClusterStats) Reset()

Reset unsets value.

func (*OptClusterStats) SetTo 

func (o *OptClusterStats) SetTo(v ClusterStats)

SetTo sets value to v.

func (*OptClusterStats) UnmarshalJSON 

func (s *OptClusterStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptDateTime 

type OptDateTime struct {
	Value time.Time
	Set   bool
}

OptDateTime is optional time.Time.

func NewOptDateTime 

func NewOptDateTime(v time.Time) OptDateTime

NewOptDateTime returns new OptDateTime with value set to v.

func (*OptDateTime) Decode 

func (o *OptDateTime) Decode(d *jx.Decoder, format func(*jx.Decoder) (time.Time, error)) error

Decode decodes time.Time from json.

func (OptDateTime) Encode 

func (o OptDateTime) Encode(e *jx.Encoder, format func(*jx.Encoder, time.Time))

Encode encodes time.Time as json.

func (OptDateTime) Get 

func (o OptDateTime) Get() (v time.Time, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptDateTime) IsSet 

func (o OptDateTime) IsSet() bool

IsSet returns true if OptDateTime was set.

func (OptDateTime) MarshalJSON 

func (s OptDateTime) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptDateTime) Or 

func (o OptDateTime) Or(d time.Time) time.Time

Or returns value if set, or given parameter if does not.

func (*OptDateTime) Reset 

func (o *OptDateTime) Reset()

Reset unsets value.

func (*OptDateTime) SetTo 

func (o *OptDateTime) SetTo(v time.Time)

SetTo sets value to v.

func (*OptDateTime) UnmarshalJSON 

func (s *OptDateTime) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptECStats 

type OptECStats struct {
	Value ECStats
	Set   bool
}

OptECStats is optional ECStats.

func NewOptECStats 

func NewOptECStats(v ECStats) OptECStats

NewOptECStats returns new OptECStats with value set to v.

func (*OptECStats) Decode 

func (o *OptECStats) Decode(d *jx.Decoder) error

Decode decodes ECStats from json.

func (OptECStats) Encode 

func (o OptECStats) Encode(e *jx.Encoder)

Encode encodes ECStats as json.

func (OptECStats) Get 

func (o OptECStats) Get() (v ECStats, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptECStats) IsSet 

func (o OptECStats) IsSet() bool

IsSet returns true if OptECStats was set.

func (OptECStats) MarshalJSON 

func (s OptECStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptECStats) Or 

func (o OptECStats) Or(d ECStats) ECStats

Or returns value if set, or given parameter if does not.

func (*OptECStats) Reset 

func (o *OptECStats) Reset()

Reset unsets value.

func (*OptECStats) SetTo 

func (o *OptECStats) SetTo(v ECStats)

SetTo sets value to v.

func (*OptECStats) UnmarshalJSON 

func (s *OptECStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptEngineStats 

type OptEngineStats struct {
	Value EngineStats
	Set   bool
}

OptEngineStats is optional EngineStats.

func NewOptEngineStats 

func NewOptEngineStats(v EngineStats) OptEngineStats

NewOptEngineStats returns new OptEngineStats with value set to v.

func (*OptEngineStats) Decode 

func (o *OptEngineStats) Decode(d *jx.Decoder) error

Decode decodes EngineStats from json.

func (OptEngineStats) Encode 

func (o OptEngineStats) Encode(e *jx.Encoder)

Encode encodes EngineStats as json.

func (OptEngineStats) Get 

func (o OptEngineStats) Get() (v EngineStats, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptEngineStats) IsSet 

func (o OptEngineStats) IsSet() bool

IsSet returns true if OptEngineStats was set.

func (OptEngineStats) MarshalJSON 

func (s OptEngineStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptEngineStats) Or 

func (o OptEngineStats) Or(d EngineStats) EngineStats

Or returns value if set, or given parameter if does not.

func (*OptEngineStats) Reset 

func (o *OptEngineStats) Reset()

Reset unsets value.

func (*OptEngineStats) SetTo 

func (o *OptEngineStats) SetTo(v EngineStats)

SetTo sets value to v.

func (*OptEngineStats) UnmarshalJSON 

func (s *OptEngineStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptFloat64 

type OptFloat64 struct {
	Value float64
	Set   bool
}

OptFloat64 is optional float64.

func NewOptFloat64 

func NewOptFloat64(v float64) OptFloat64

NewOptFloat64 returns new OptFloat64 with value set to v.

func (*OptFloat64) Decode 

func (o *OptFloat64) Decode(d *jx.Decoder) error

Decode decodes float64 from json.

func (OptFloat64) Encode 

func (o OptFloat64) Encode(e *jx.Encoder)

Encode encodes float64 as json.

func (OptFloat64) Get 

func (o OptFloat64) Get() (v float64, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptFloat64) IsSet 

func (o OptFloat64) IsSet() bool

IsSet returns true if OptFloat64 was set.

func (OptFloat64) MarshalJSON 

func (s OptFloat64) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptFloat64) Or 

func (o OptFloat64) Or(d float64) float64

Or returns value if set, or given parameter if does not.

func (*OptFloat64) Reset 

func (o *OptFloat64) Reset()

Reset unsets value.

func (*OptFloat64) SetTo 

func (o *OptFloat64) SetTo(v float64)

SetTo sets value to v.

func (*OptFloat64) UnmarshalJSON 

func (s *OptFloat64) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptInt64 

type OptInt64 struct {
	Value int64
	Set   bool
}

OptInt64 is optional int64.

func NewOptInt64 

func NewOptInt64(v int64) OptInt64

NewOptInt64 returns new OptInt64 with value set to v.

func (*OptInt64) Decode 

func (o *OptInt64) Decode(d *jx.Decoder) error

Decode decodes int64 from json.

func (OptInt64) Encode 

func (o OptInt64) Encode(e *jx.Encoder)

Encode encodes int64 as json.

func (OptInt64) Get 

func (o OptInt64) Get() (v int64, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptInt64) IsSet 

func (o OptInt64) IsSet() bool

IsSet returns true if OptInt64 was set.

func (OptInt64) MarshalJSON 

func (s OptInt64) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptInt64) Or 

func (o OptInt64) Or(d int64) int64

Or returns value if set, or given parameter if does not.

func (*OptInt64) Reset 

func (o *OptInt64) Reset()

Reset unsets value.

func (*OptInt64) SetTo 

func (o *OptInt64) SetTo(v int64)

SetTo sets value to v.

func (*OptInt64) UnmarshalJSON 

func (s *OptInt64) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptPartSyncStats 

type OptPartSyncStats struct {
	Value PartSyncStats
	Set   bool
}

OptPartSyncStats is optional PartSyncStats.

func NewOptPartSyncStats 

func NewOptPartSyncStats(v PartSyncStats) OptPartSyncStats

NewOptPartSyncStats returns new OptPartSyncStats with value set to v.

func (*OptPartSyncStats) Decode 

func (o *OptPartSyncStats) Decode(d *jx.Decoder) error

Decode decodes PartSyncStats from json.

func (OptPartSyncStats) Encode 

func (o OptPartSyncStats) Encode(e *jx.Encoder)

Encode encodes PartSyncStats as json.

func (OptPartSyncStats) Get 

func (o OptPartSyncStats) Get() (v PartSyncStats, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptPartSyncStats) IsSet 

func (o OptPartSyncStats) IsSet() bool

IsSet returns true if OptPartSyncStats was set.

func (OptPartSyncStats) MarshalJSON 

func (s OptPartSyncStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptPartSyncStats) Or 

func (o OptPartSyncStats) Or(d PartSyncStats) PartSyncStats

Or returns value if set, or given parameter if does not.

func (*OptPartSyncStats) Reset 

func (o *OptPartSyncStats) Reset()

Reset unsets value.

func (*OptPartSyncStats) SetTo 

func (o *OptPartSyncStats) SetTo(v PartSyncStats)

SetTo sets value to v.

func (*OptPartSyncStats) UnmarshalJSON 

func (s *OptPartSyncStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSpanID 

type OptSpanID struct {
	Value SpanID
	Set   bool
}

OptSpanID is optional SpanID.

func NewOptSpanID 

func NewOptSpanID(v SpanID) OptSpanID

NewOptSpanID returns new OptSpanID with value set to v.

func (*OptSpanID) Decode 

func (o *OptSpanID) Decode(d *jx.Decoder) error

Decode decodes SpanID from json.

func (OptSpanID) Encode 

func (o OptSpanID) Encode(e *jx.Encoder)

Encode encodes SpanID as json.

func (OptSpanID) Get 

func (o OptSpanID) Get() (v SpanID, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSpanID) IsSet 

func (o OptSpanID) IsSet() bool

IsSet returns true if OptSpanID was set.

func (OptSpanID) MarshalJSON 

func (s OptSpanID) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSpanID) Or 

func (o OptSpanID) Or(d SpanID) SpanID

Or returns value if set, or given parameter if does not.

func (*OptSpanID) Reset 

func (o *OptSpanID) Reset()

Reset unsets value.

func (*OptSpanID) SetTo 

func (o *OptSpanID) SetTo(v SpanID)

SetTo sets value to v.

func (*OptSpanID) UnmarshalJSON 

func (s *OptSpanID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptString 

type OptString struct {
	Value string
	Set   bool
}

OptString is optional string.

func NewOptString 

func NewOptString(v string) OptString

NewOptString returns new OptString with value set to v.

func (*OptString) Decode 

func (o *OptString) Decode(d *jx.Decoder) error

Decode decodes string from json.

func (OptString) Encode 

func (o OptString) Encode(e *jx.Encoder)

Encode encodes string as json.

func (OptString) Get 

func (o OptString) Get() (v string, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptString) IsSet 

func (o OptString) IsSet() bool

IsSet returns true if OptString was set.

func (OptString) MarshalJSON 

func (s OptString) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptString) Or 

func (o OptString) Or(d string) string

Or returns value if set, or given parameter if does not.

func (*OptString) Reset 

func (o *OptString) Reset()

Reset unsets value.

func (*OptString) SetTo 

func (o *OptString) SetTo(v string)

SetTo sets value to v.

func (*OptString) UnmarshalJSON 

func (s *OptString) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptTraceID 

type OptTraceID struct {
	Value TraceID
	Set   bool
}

OptTraceID is optional TraceID.

func NewOptTraceID 

func NewOptTraceID(v TraceID) OptTraceID

NewOptTraceID returns new OptTraceID with value set to v.

func (*OptTraceID) Decode 

func (o *OptTraceID) Decode(d *jx.Decoder) error

Decode decodes TraceID from json.

func (OptTraceID) Encode 

func (o OptTraceID) Encode(e *jx.Encoder)

Encode encodes TraceID as json.

func (OptTraceID) Get 

func (o OptTraceID) Get() (v TraceID, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptTraceID) IsSet 

func (o OptTraceID) IsSet() bool

IsSet returns true if OptTraceID was set.

func (OptTraceID) MarshalJSON 

func (s OptTraceID) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptTraceID) Or 

func (o OptTraceID) Or(d TraceID) TraceID

Or returns value if set, or given parameter if does not.

func (*OptTraceID) Reset 

func (o *OptTraceID) Reset()

Reset unsets value.

func (*OptTraceID) SetTo 

func (o *OptTraceID) SetTo(v TraceID)

SetTo sets value to v.

func (*OptTraceID) UnmarshalJSON 

func (s *OptTraceID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type Option 

type Option interface {
	ServerOption
	ClientOption
}

Option is config option.

func WithAttributes 

func WithAttributes(attributes ...attribute.KeyValue) Option

WithAttributes specifies default otel attributes.

func WithMeterProvider 

func WithMeterProvider(provider metric.MeterProvider) Option

WithMeterProvider specifies a meter provider to use for creating a meter.

If none is specified, the otel.GetMeterProvider() is used.

func WithTracerProvider 

func WithTracerProvider(provider trace.TracerProvider) Option

WithTracerProvider specifies a tracer provider to use for creating a tracer.

If none is specified, the global provider is used.

type PartSyncStats 

type PartSyncStats struct {
	// Sync attempts including no-ops (the sync-loop liveness probe).
	Passes int64 `json:"passes"`
	// Passes that installed a newer peer copy.
	Mirrored int64 `json:"mirrored"`
	// Objects fetched from peers.
	Copied int64 `json:"copied"`
	// Total size of objects fetched from peers.
	CopiedBytes int64 `json:"copied_bytes"`
	// Stale local objects deleted after the quarantine delay.
	Pruned int64 `json:"pruned"`
	// Passes that failed part-way (retried next maintenance tick).
	Errors int64 `json:"errors"`
	// When the last mirroring pass completed (the replication-staleness probe).
	LastSync OptDateTime `json:"last_sync"`
}

Cumulative shared-nothing part-mirroring activity of this node, present only when the cluster runs with a private (per-node) backend. Ref: #/components/schemas/PartSyncStats

func (*PartSyncStats) Decode 

func (s *PartSyncStats) Decode(d *jx.Decoder) error

Decode decodes PartSyncStats from json.

func (*PartSyncStats) Encode 

func (s *PartSyncStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*PartSyncStats) GetCopied 

func (s *PartSyncStats) GetCopied() int64

GetCopied returns the value of Copied.

func (*PartSyncStats) GetCopiedBytes 

func (s *PartSyncStats) GetCopiedBytes() int64

GetCopiedBytes returns the value of CopiedBytes.

func (*PartSyncStats) GetErrors 

func (s *PartSyncStats) GetErrors() int64

GetErrors returns the value of Errors.

func (*PartSyncStats) GetLastSync 

func (s *PartSyncStats) GetLastSync() OptDateTime

GetLastSync returns the value of LastSync.

func (*PartSyncStats) GetMirrored 

func (s *PartSyncStats) GetMirrored() int64

GetMirrored returns the value of Mirrored.

func (*PartSyncStats) GetPasses 

func (s *PartSyncStats) GetPasses() int64

GetPasses returns the value of Passes.

func (*PartSyncStats) GetPruned 

func (s *PartSyncStats) GetPruned() int64

GetPruned returns the value of Pruned.

func (*PartSyncStats) MarshalJSON 

func (s *PartSyncStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*PartSyncStats) SetCopied 

func (s *PartSyncStats) SetCopied(val int64)

SetCopied sets the value of Copied.

func (*PartSyncStats) SetCopiedBytes 

func (s *PartSyncStats) SetCopiedBytes(val int64)

SetCopiedBytes sets the value of CopiedBytes.

func (*PartSyncStats) SetErrors 

func (s *PartSyncStats) SetErrors(val int64)

SetErrors sets the value of Errors.

func (*PartSyncStats) SetLastSync 

func (s *PartSyncStats) SetLastSync(val OptDateTime)

SetLastSync sets the value of LastSync.

func (*PartSyncStats) SetMirrored 

func (s *PartSyncStats) SetMirrored(val int64)

SetMirrored sets the value of Mirrored.

func (*PartSyncStats) SetPasses 

func (s *PartSyncStats) SetPasses(val int64)

SetPasses sets the value of Passes.

func (*PartSyncStats) SetPruned 

func (s *PartSyncStats) SetPruned(val int64)

SetPruned sets the value of Pruned.

func (*PartSyncStats) UnmarshalJSON 

func (s *PartSyncStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type Route 

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

Route is route object.

func (Route) Args 

func (r Route) Args() []string

Args returns parsed arguments.

func (Route) Name 

func (r Route) Name() string

Name returns ogen operation name.

It is guaranteed to be unique and not empty.

func (Route) OperationGroup 

func (r Route) OperationGroup() string

OperationGroup returns the x-ogen-operation-group value.

func (Route) OperationID 

func (r Route) OperationID() string

OperationID returns OpenAPI operationId.

func (Route) PathPattern 

func (r Route) PathPattern() string

PathPattern returns OpenAPI path.

func (Route) Summary 

func (r Route) Summary() string

Summary returns OpenAPI summary.

type RunActionParams 

type RunActionParams struct {
	// Action to run.
	Action ActionName
}

RunActionParams is parameters of runAction operation.

type RuntimeStats 

type RuntimeStats struct {
	Goroutines int64 `json:"goroutines"`
	NumCPU     int   `json:"num_cpu"`
	Gomaxprocs int   `json:"gomaxprocs"`
	// Bytes of allocated heap objects (live heap).
	HeapAllocBytes  int64 `json:"heap_alloc_bytes"`
	HeapInuseBytes  int64 `json:"heap_inuse_bytes"`
	HeapSysBytes    int64 `json:"heap_sys_bytes"`
	StackInuseBytes int64 `json:"stack_inuse_bytes"`
	// Number of completed GC cycles.
	GcCount int64 `json:"gc_count"`
	// Target heap size of the next GC cycle.
	NextGcBytes int64 `json:"next_gc_bytes"`
	// Soft memory limit (GOMEMLIMIT), when set.
	MemLimitBytes OptInt64 `json:"mem_limit_bytes"`
}

Ref: #/components/schemas/RuntimeStats

func (*RuntimeStats) Decode 

func (s *RuntimeStats) Decode(d *jx.Decoder) error

Decode decodes RuntimeStats from json.

func (*RuntimeStats) Encode 

func (s *RuntimeStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*RuntimeStats) GetGcCount 

func (s *RuntimeStats) GetGcCount() int64

GetGcCount returns the value of GcCount.

func (*RuntimeStats) GetGomaxprocs 

func (s *RuntimeStats) GetGomaxprocs() int

GetGomaxprocs returns the value of Gomaxprocs.

func (*RuntimeStats) GetGoroutines 

func (s *RuntimeStats) GetGoroutines() int64

GetGoroutines returns the value of Goroutines.

func (*RuntimeStats) GetHeapAllocBytes 

func (s *RuntimeStats) GetHeapAllocBytes() int64

GetHeapAllocBytes returns the value of HeapAllocBytes.

func (*RuntimeStats) GetHeapInuseBytes 

func (s *RuntimeStats) GetHeapInuseBytes() int64

GetHeapInuseBytes returns the value of HeapInuseBytes.

func (*RuntimeStats) GetHeapSysBytes 

func (s *RuntimeStats) GetHeapSysBytes() int64

GetHeapSysBytes returns the value of HeapSysBytes.

func (*RuntimeStats) GetMemLimitBytes 

func (s *RuntimeStats) GetMemLimitBytes() OptInt64

GetMemLimitBytes returns the value of MemLimitBytes.

func (*RuntimeStats) GetNextGcBytes 

func (s *RuntimeStats) GetNextGcBytes() int64

GetNextGcBytes returns the value of NextGcBytes.

func (*RuntimeStats) GetNumCPU 

func (s *RuntimeStats) GetNumCPU() int

GetNumCPU returns the value of NumCPU.

func (*RuntimeStats) GetStackInuseBytes 

func (s *RuntimeStats) GetStackInuseBytes() int64

GetStackInuseBytes returns the value of StackInuseBytes.

func (*RuntimeStats) MarshalJSON 

func (s *RuntimeStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*RuntimeStats) SetGcCount 

func (s *RuntimeStats) SetGcCount(val int64)

SetGcCount sets the value of GcCount.

func (*RuntimeStats) SetGomaxprocs 

func (s *RuntimeStats) SetGomaxprocs(val int)

SetGomaxprocs sets the value of Gomaxprocs.

func (*RuntimeStats) SetGoroutines 

func (s *RuntimeStats) SetGoroutines(val int64)

SetGoroutines sets the value of Goroutines.

func (*RuntimeStats) SetHeapAllocBytes 

func (s *RuntimeStats) SetHeapAllocBytes(val int64)

SetHeapAllocBytes sets the value of HeapAllocBytes.

func (*RuntimeStats) SetHeapInuseBytes 

func (s *RuntimeStats) SetHeapInuseBytes(val int64)

SetHeapInuseBytes sets the value of HeapInuseBytes.

func (*RuntimeStats) SetHeapSysBytes 

func (s *RuntimeStats) SetHeapSysBytes(val int64)

SetHeapSysBytes sets the value of HeapSysBytes.

func (*RuntimeStats) SetMemLimitBytes 

func (s *RuntimeStats) SetMemLimitBytes(val OptInt64)

SetMemLimitBytes sets the value of MemLimitBytes.

func (*RuntimeStats) SetNextGcBytes 

func (s *RuntimeStats) SetNextGcBytes(val int64)

SetNextGcBytes sets the value of NextGcBytes.

func (*RuntimeStats) SetNumCPU 

func (s *RuntimeStats) SetNumCPU(val int)

SetNumCPU sets the value of NumCPU.

func (*RuntimeStats) SetStackInuseBytes 

func (s *RuntimeStats) SetStackInuseBytes(val int64)

SetStackInuseBytes sets the value of StackInuseBytes.

func (*RuntimeStats) UnmarshalJSON 

func (s *RuntimeStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type Server 

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

Server implements http server based on OpenAPI v3 specification and calls Handler to handle requests.

func NewServer 

func NewServer(h Handler, opts ...ServerOption) (*Server, error)

NewServer creates new Server.

func (*Server) FindPath 

func (s *Server) FindPath(method string, u *url.URL) (r Route, _ bool)

FindPath finds Route for given method and URL.

func (*Server) FindRoute 

func (s *Server) FindRoute(method, path string) (Route, bool)

FindRoute finds Route for given method and path.

Note: this method does not unescape path or handle reserved characters in path properly. Use FindPath instead.

func (*Server) ServeHTTP 

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP serves http request as defined by OpenAPI v3 specification, calling handler that matches the path or returning not found error.

type ServerOption 

type ServerOption interface {
	// contains filtered or unexported methods
}

ServerOption is server config option.

func WithErrorHandler 

func WithErrorHandler(h ErrorHandler) ServerOption

WithErrorHandler specifies error handler to use.

func WithMaxMultipartMemory 

func WithMaxMultipartMemory(max int64) ServerOption

WithMaxMultipartMemory specifies limit of memory for storing file parts. File parts which can't be stored in memory will be stored on disk in temporary files.

func WithMethodNotAllowed 

func WithMethodNotAllowed(methodNotAllowed func(w http.ResponseWriter, r *http.Request, allowed string)) ServerOption

WithMethodNotAllowed specifies Method Not Allowed handler to use.

func WithMiddleware 

func WithMiddleware(m ...Middleware) ServerOption

WithMiddleware specifies middlewares to use.

func WithNotFound 

func WithNotFound(notFound http.HandlerFunc) ServerOption

WithNotFound specifies Not Found handler to use.

func WithPathPrefix 

func WithPathPrefix(prefix string) ServerOption

WithPathPrefix specifies server path prefix.

type Signal 

type Signal string

Telemetry signal. Ref: #/components/schemas/Signal 

const (
	SignalMetrics  Signal = "metrics"
	SignalTraces   Signal = "traces"
	SignalLogs     Signal = "logs"
	SignalProfiles Signal = "profiles"
)

func (Signal) AllValues 

func (Signal) AllValues() []Signal

AllValues returns all Signal values.

func (*Signal) Decode 

func (s *Signal) Decode(d *jx.Decoder) error

Decode decodes Signal from json.

func (Signal) Encode 

func (s Signal) Encode(e *jx.Encoder)

Encode encodes Signal as json.

func (Signal) MarshalJSON 

func (s Signal) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (Signal) MarshalText 

func (s Signal) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*Signal) UnmarshalJSON 

func (s *Signal) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*Signal) UnmarshalText 

func (s *Signal) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (Signal) Validate 

func (s Signal) Validate() error

type SignalEfficiency 

type SignalEfficiency struct {
	Signal Signal `json:"signal"`
	// Distinct series/streams (head and flushed).
	Series int64 `json:"series"`
	// Flushed part count.
	Parts int64 `json:"parts"`
	// Total samples (metrics) or records (logs/traces/profiles).
	Points int64 `json:"points"`
	// Sum of the parts' backend object sizes on this node.
	StoredBytes int64 `json:"stored_bytes"`
	// Stored bytes per point — the per-sample storage cost.
	BytesPerPoint float64 `json:"bytes_per_point"`
	// Uncompressed logical size of the stored points; present only for metrics (points x 16), the record
	// signals' per-record logical size is not recorded.
	LogicalBytes OptInt64 `json:"logical_bytes"`
	// Logical/stored ratio (e.g. 8.0 = stored at 1/8th of logical); present only when logical size is
	// known.
	CompressionRatio OptFloat64 `json:"compression_ratio"`
}

One (tenant, signal)'s flushed-data shape: how many points it stores, in how many bytes, and how well they compress. Stored bytes are this node's on-disk footprint — under erasure coding with slot filtering that is the local shard, not the cluster-wide total. Ref: #/components/schemas/SignalEfficiency

func (*SignalEfficiency) Decode 

func (s *SignalEfficiency) Decode(d *jx.Decoder) error

Decode decodes SignalEfficiency from json.

func (*SignalEfficiency) Encode 

func (s *SignalEfficiency) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SignalEfficiency) GetBytesPerPoint 

func (s *SignalEfficiency) GetBytesPerPoint() float64

GetBytesPerPoint returns the value of BytesPerPoint.

func (*SignalEfficiency) GetCompressionRatio 

func (s *SignalEfficiency) GetCompressionRatio() OptFloat64

GetCompressionRatio returns the value of CompressionRatio.

func (*SignalEfficiency) GetLogicalBytes 

func (s *SignalEfficiency) GetLogicalBytes() OptInt64

GetLogicalBytes returns the value of LogicalBytes.

func (*SignalEfficiency) GetParts 

func (s *SignalEfficiency) GetParts() int64

GetParts returns the value of Parts.

func (*SignalEfficiency) GetPoints 

func (s *SignalEfficiency) GetPoints() int64

GetPoints returns the value of Points.

func (*SignalEfficiency) GetSeries 

func (s *SignalEfficiency) GetSeries() int64

GetSeries returns the value of Series.

func (*SignalEfficiency) GetSignal 

func (s *SignalEfficiency) GetSignal() Signal

GetSignal returns the value of Signal.

func (*SignalEfficiency) GetStoredBytes 

func (s *SignalEfficiency) GetStoredBytes() int64

GetStoredBytes returns the value of StoredBytes.

func (*SignalEfficiency) MarshalJSON 

func (s *SignalEfficiency) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SignalEfficiency) SetBytesPerPoint 

func (s *SignalEfficiency) SetBytesPerPoint(val float64)

SetBytesPerPoint sets the value of BytesPerPoint.

func (*SignalEfficiency) SetCompressionRatio 

func (s *SignalEfficiency) SetCompressionRatio(val OptFloat64)

SetCompressionRatio sets the value of CompressionRatio.

func (*SignalEfficiency) SetLogicalBytes 

func (s *SignalEfficiency) SetLogicalBytes(val OptInt64)

SetLogicalBytes sets the value of LogicalBytes.

func (*SignalEfficiency) SetParts 

func (s *SignalEfficiency) SetParts(val int64)

SetParts sets the value of Parts.

func (*SignalEfficiency) SetPoints 

func (s *SignalEfficiency) SetPoints(val int64)

SetPoints sets the value of Points.

func (*SignalEfficiency) SetSeries 

func (s *SignalEfficiency) SetSeries(val int64)

SetSeries sets the value of Series.

func (*SignalEfficiency) SetSignal 

func (s *SignalEfficiency) SetSignal(val Signal)

SetSignal sets the value of Signal.

func (*SignalEfficiency) SetStoredBytes 

func (s *SignalEfficiency) SetStoredBytes(val int64)

SetStoredBytes sets the value of StoredBytes.

func (*SignalEfficiency) UnmarshalJSON 

func (s *SignalEfficiency) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SignalEfficiency) Validate 

func (s *SignalEfficiency) Validate() error

type SignalInfo 

type SignalInfo struct {
	Signal Signal `json:"signal"`
	// Storage backend serving this signal (clickhouse, storage or none).
	Backend string `json:"backend"`
	// Whether a query API is wired for this signal.
	Queryable bool `json:"queryable"`
	// Listen address of the signal's query API, when queryable.
	Bind OptString `json:"bind"`
}

Ref: #/components/schemas/SignalInfo

func (*SignalInfo) Decode 

func (s *SignalInfo) Decode(d *jx.Decoder) error

Decode decodes SignalInfo from json.

func (*SignalInfo) Encode 

func (s *SignalInfo) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SignalInfo) GetBackend 

func (s *SignalInfo) GetBackend() string

GetBackend returns the value of Backend.

func (*SignalInfo) GetBind 

func (s *SignalInfo) GetBind() OptString

GetBind returns the value of Bind.

func (*SignalInfo) GetQueryable 

func (s *SignalInfo) GetQueryable() bool

GetQueryable returns the value of Queryable.

func (*SignalInfo) GetSignal 

func (s *SignalInfo) GetSignal() Signal

GetSignal returns the value of Signal.

func (*SignalInfo) MarshalJSON 

func (s *SignalInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SignalInfo) SetBackend 

func (s *SignalInfo) SetBackend(val string)

SetBackend sets the value of Backend.

func (*SignalInfo) SetBind 

func (s *SignalInfo) SetBind(val OptString)

SetBind sets the value of Bind.

func (*SignalInfo) SetQueryable 

func (s *SignalInfo) SetQueryable(val bool)

SetQueryable sets the value of Queryable.

func (*SignalInfo) SetSignal 

func (s *SignalInfo) SetSignal(val Signal)

SetSignal sets the value of Signal.

func (*SignalInfo) UnmarshalJSON 

func (s *SignalInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SignalInfo) Validate 

func (s *SignalInfo) Validate() error

type SpanID 

type SpanID string

func (*SpanID) Decode 

func (s *SpanID) Decode(d *jx.Decoder) error

Decode decodes SpanID from json.

func (SpanID) Encode 

func (s SpanID) Encode(e *jx.Encoder)

Encode encodes SpanID as json.

func (SpanID) MarshalJSON 

func (s SpanID) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SpanID) UnmarshalJSON 

func (s *SpanID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (SpanID) Validate 

func (s SpanID) Validate() error

type StorageStats 

type StorageStats struct {
	// Whether the embedded oteldb/storage engine is active.
	StorageEnabled bool `json:"storage_enabled"`
	// Whether the (deprecated) ClickHouse storage is active.
	ClickhouseEnabled bool               `json:"clickhouse_enabled"`
	Engine            OptEngineStats     `json:"engine"`
	Clickhouse        OptClickHouseStats `json:"clickhouse"`
}

Storage statistics for the embedded engine (primary) and ClickHouse (deprecated). Ref: #/components/schemas/StorageStats

func (*StorageStats) Decode 

func (s *StorageStats) Decode(d *jx.Decoder) error

Decode decodes StorageStats from json.

func (*StorageStats) Encode 

func (s *StorageStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*StorageStats) GetClickhouse 

func (s *StorageStats) GetClickhouse() OptClickHouseStats

GetClickhouse returns the value of Clickhouse.

func (*StorageStats) GetClickhouseEnabled 

func (s *StorageStats) GetClickhouseEnabled() bool

GetClickhouseEnabled returns the value of ClickhouseEnabled.

func (*StorageStats) GetEngine 

func (s *StorageStats) GetEngine() OptEngineStats

GetEngine returns the value of Engine.

func (*StorageStats) GetStorageEnabled 

func (s *StorageStats) GetStorageEnabled() bool

GetStorageEnabled returns the value of StorageEnabled.

func (*StorageStats) MarshalJSON 

func (s *StorageStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*StorageStats) SetClickhouse 

func (s *StorageStats) SetClickhouse(val OptClickHouseStats)

SetClickhouse sets the value of Clickhouse.

func (*StorageStats) SetClickhouseEnabled 

func (s *StorageStats) SetClickhouseEnabled(val bool)

SetClickhouseEnabled sets the value of ClickhouseEnabled.

func (*StorageStats) SetEngine 

func (s *StorageStats) SetEngine(val OptEngineStats)

SetEngine sets the value of Engine.

func (*StorageStats) SetStorageEnabled 

func (s *StorageStats) SetStorageEnabled(val bool)

SetStorageEnabled sets the value of StorageEnabled.

func (*StorageStats) UnmarshalJSON 

func (s *StorageStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*StorageStats) Validate 

func (s *StorageStats) Validate() error

type TableStats 

type TableStats struct {
	Database string `json:"database"`
	Table    string `json:"table"`
	Rows     int64  `json:"rows"`
	// Compressed on-disk size.
	BytesOnDisk           int64 `json:"bytes_on_disk"`
	DataUncompressedBytes int64 `json:"data_uncompressed_bytes"`
	// Number of active parts.
	Parts int64 `json:"parts"`
	// Earliest partition time, when available.
	MinTime OptDateTime `json:"min_time"`
	// Latest partition time, when available.
	MaxTime OptDateTime `json:"max_time"`
}

Ref: #/components/schemas/TableStats

func (*TableStats) Decode 

func (s *TableStats) Decode(d *jx.Decoder) error

Decode decodes TableStats from json.

func (*TableStats) Encode 

func (s *TableStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*TableStats) GetBytesOnDisk 

func (s *TableStats) GetBytesOnDisk() int64

GetBytesOnDisk returns the value of BytesOnDisk.

func (*TableStats) GetDataUncompressedBytes 

func (s *TableStats) GetDataUncompressedBytes() int64

GetDataUncompressedBytes returns the value of DataUncompressedBytes.

func (*TableStats) GetDatabase 

func (s *TableStats) GetDatabase() string

GetDatabase returns the value of Database.

func (*TableStats) GetMaxTime 

func (s *TableStats) GetMaxTime() OptDateTime

GetMaxTime returns the value of MaxTime.

func (*TableStats) GetMinTime 

func (s *TableStats) GetMinTime() OptDateTime

GetMinTime returns the value of MinTime.

func (*TableStats) GetParts 

func (s *TableStats) GetParts() int64

GetParts returns the value of Parts.

func (*TableStats) GetRows 

func (s *TableStats) GetRows() int64

GetRows returns the value of Rows.

func (*TableStats) GetTable 

func (s *TableStats) GetTable() string

GetTable returns the value of Table.

func (*TableStats) MarshalJSON 

func (s *TableStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TableStats) SetBytesOnDisk 

func (s *TableStats) SetBytesOnDisk(val int64)

SetBytesOnDisk sets the value of BytesOnDisk.

func (*TableStats) SetDataUncompressedBytes 

func (s *TableStats) SetDataUncompressedBytes(val int64)

SetDataUncompressedBytes sets the value of DataUncompressedBytes.

func (*TableStats) SetDatabase 

func (s *TableStats) SetDatabase(val string)

SetDatabase sets the value of Database.

func (*TableStats) SetMaxTime 

func (s *TableStats) SetMaxTime(val OptDateTime)

SetMaxTime sets the value of MaxTime.

func (*TableStats) SetMinTime 

func (s *TableStats) SetMinTime(val OptDateTime)

SetMinTime sets the value of MinTime.

func (*TableStats) SetParts 

func (s *TableStats) SetParts(val int64)

SetParts sets the value of Parts.

func (*TableStats) SetRows 

func (s *TableStats) SetRows(val int64)

SetRows sets the value of Rows.

func (*TableStats) SetTable 

func (s *TableStats) SetTable(val string)

SetTable sets the value of Table.

func (*TableStats) UnmarshalJSON 

func (s *TableStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type TenantEfficiency 

type TenantEfficiency struct {
	// Tenant identifier.
	Tenant  string             `json:"tenant"`
	Signals []SignalEfficiency `json:"signals"`
}

One tenant's per-signal efficiency breakdown. Ref: #/components/schemas/TenantEfficiency

func (*TenantEfficiency) Decode 

func (s *TenantEfficiency) Decode(d *jx.Decoder) error

Decode decodes TenantEfficiency from json.

func (*TenantEfficiency) Encode 

func (s *TenantEfficiency) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*TenantEfficiency) GetSignals 

func (s *TenantEfficiency) GetSignals() []SignalEfficiency

GetSignals returns the value of Signals.

func (*TenantEfficiency) GetTenant 

func (s *TenantEfficiency) GetTenant() string

GetTenant returns the value of Tenant.

func (*TenantEfficiency) MarshalJSON 

func (s *TenantEfficiency) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TenantEfficiency) SetSignals 

func (s *TenantEfficiency) SetSignals(val []SignalEfficiency)

SetSignals sets the value of Signals.

func (*TenantEfficiency) SetTenant 

func (s *TenantEfficiency) SetTenant(val string)

SetTenant sets the value of Tenant.

func (*TenantEfficiency) UnmarshalJSON 

func (s *TenantEfficiency) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TenantEfficiency) Validate 

func (s *TenantEfficiency) Validate() error

type TenantStats 

type TenantStats struct {
	// Tenant identifier.
	Tenant string `json:"tenant"`
	// Sum of series across all signals.
	TotalSeries int64 `json:"total_series"`
	// Sum of flushed parts across all signals.
	TotalParts int64               `json:"total_parts"`
	Admission  AdmissionStats      `json:"admission"`
	Signals    []EngineSignalStats `json:"signals"`
}

Ref: #/components/schemas/TenantStats

func (*TenantStats) Decode 

func (s *TenantStats) Decode(d *jx.Decoder) error

Decode decodes TenantStats from json.

func (*TenantStats) Encode 

func (s *TenantStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*TenantStats) GetAdmission 

func (s *TenantStats) GetAdmission() AdmissionStats

GetAdmission returns the value of Admission.

func (*TenantStats) GetSignals 

func (s *TenantStats) GetSignals() []EngineSignalStats

GetSignals returns the value of Signals.

func (*TenantStats) GetTenant 

func (s *TenantStats) GetTenant() string

GetTenant returns the value of Tenant.

func (*TenantStats) GetTotalParts 

func (s *TenantStats) GetTotalParts() int64

GetTotalParts returns the value of TotalParts.

func (*TenantStats) GetTotalSeries 

func (s *TenantStats) GetTotalSeries() int64

GetTotalSeries returns the value of TotalSeries.

func (*TenantStats) MarshalJSON 

func (s *TenantStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TenantStats) SetAdmission 

func (s *TenantStats) SetAdmission(val AdmissionStats)

SetAdmission sets the value of Admission.

func (*TenantStats) SetSignals 

func (s *TenantStats) SetSignals(val []EngineSignalStats)

SetSignals sets the value of Signals.

func (*TenantStats) SetTenant 

func (s *TenantStats) SetTenant(val string)

SetTenant sets the value of Tenant.

func (*TenantStats) SetTotalParts 

func (s *TenantStats) SetTotalParts(val int64)

SetTotalParts sets the value of TotalParts.

func (*TenantStats) SetTotalSeries 

func (s *TenantStats) SetTotalSeries(val int64)

SetTotalSeries sets the value of TotalSeries.

func (*TenantStats) UnmarshalJSON 

func (s *TenantStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TenantStats) Validate 

func (s *TenantStats) Validate() error

type TraceID 

type TraceID string

func (*TraceID) Decode 

func (s *TraceID) Decode(d *jx.Decoder) error

Decode decodes TraceID from json.

func (TraceID) Encode 

func (s TraceID) Encode(e *jx.Encoder)

Encode encodes TraceID as json.

func (TraceID) MarshalJSON 

func (s TraceID) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TraceID) UnmarshalJSON 

func (s *TraceID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (TraceID) Validate 

func (s TraceID) Validate() error

type UnimplementedHandler 

type UnimplementedHandler struct{}

UnimplementedHandler is no-op Handler which returns http.ErrNotImplemented.

func (UnimplementedHandler) GetEfficiency 

func (UnimplementedHandler) GetEfficiency(ctx context.Context) (r *EfficiencyStats, _ error)

GetEfficiency implements getEfficiency operation.

Per-tenant, per-signal capacity and efficiency breakdown of the embedded storage engine: series, parts, points, stored bytes, bytes per point and compression ratios. Unlike the other storage endpoints this one performs backend I/O (per-part object sizes) — poll it at dashboard cadence, not per request. Empty when the embedded engine is not active.

GET /api/v1/storage/efficiency

func (UnimplementedHandler) GetHealth 

func (UnimplementedHandler) GetHealth(ctx context.Context) (r *HealthReport, _ error)

GetHealth implements getHealth operation.

Health of each wired service (query APIs, collector, storage).

GET /api/v1/health

func (UnimplementedHandler) GetInfo 

func (UnimplementedHandler) GetInfo(ctx context.Context) (r *InstanceInfo, _ error)

GetInfo implements getInfo operation.

Build information, uptime and per-signal backend configuration.

GET /api/v1/info

func (UnimplementedHandler) GetRuntime 

func (UnimplementedHandler) GetRuntime(ctx context.Context) (r *RuntimeStats, _ error)

GetRuntime implements getRuntime operation.

Live heap, GC and goroutine counters of the running process.

GET /api/v1/runtime

func (UnimplementedHandler) GetStorage 

func (UnimplementedHandler) GetStorage(ctx context.Context) (r *StorageStats, _ error)

GetStorage implements getStorage operation.

Per-table statistics (rows, on-disk and uncompressed bytes, parts, min/max timestamp) collected from ClickHouse system tables. Empty when no signal is served from ClickHouse.

GET /api/v1/storage

func (UnimplementedHandler) NewError 

func (UnimplementedHandler) NewError(ctx context.Context, err error) (r *ErrorStatusCode)

NewError creates *ErrorStatusCode from error returned by handler.

Used for common default response.

func (UnimplementedHandler) RunAction 

func (UnimplementedHandler) RunAction(ctx context.Context, params RunActionParams) (r *ActionResult, _ error)

RunAction implements runAction operation.

Execute a maintenance action against the running process.

POST /api/v1/actions/{action}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.