Expand description
Prometheus metrics for observability
This module provides comprehensive metrics collection for monitoring IPFRS interface performance, usage patterns, and system health.
§Global registry (lazy_static)
The module exposes a set of well-known lazy_static metrics that register
themselves in the default prometheus registry. These are used by the
HTTP middleware and route helpers.
§Per-node registry (IpfrsMetrics)
For fine-grained per-node observability (block operations, DHT, inference
sessions, GossipSub, storage and GC) each Node or gateway instance
can hold an IpfrsMetrics value. Metrics are registered in a
private prometheus::Registry so multiple test instances do not
collide.
Structs§
- ASYNC_
TASKS_ ACTIVE - Number of goroutines (async tasks)
- AUTH_
ATTEMPTS_ TOTAL - Authentication attempts
- AUTH_
SESSIONS_ ACTIVE - Active authenticated sessions
- BATCH_
OPERATION_ DURATION_ SECONDS - Batch operation duration
- BATCH_
OPERATION_ SIZE - Batch operation size (number of items)
- BLOCKS_
RETRIEVED_ TOTAL - Total blocks retrieved
- BLOCKS_
STORED_ TOTAL - Total blocks stored
- BLOCK_
ERRORS_ TOTAL - Block operation errors
- BLOCK_
RETRIEVAL_ DURATION_ SECONDS - Block retrieval duration
- CACHE_
HITS_ TOTAL - Cache hits
- CACHE_
MISSES_ TOTAL - Cache misses
- CACHE_
SIZE_ BYTES - Current cache size
- DOWNLOAD_
BYTES_ TOTAL - Total bytes downloaded
- GRPC_
REQUESTS_ TOTAL - gRPC requests total
- GRPC_
REQUEST_ DURATION_ SECONDS - gRPC request duration
- HTTP_
CONNECTIONS_ ACTIVE - Currently active HTTP connections
- HTTP_
REQUESTS_ TOTAL - Total number of HTTP requests by endpoint and method
- HTTP_
REQUEST_ DURATION_ SECONDS - HTTP request duration in seconds
- HTTP_
REQUEST_ SIZE_ BYTES - HTTP request body size in bytes
- HTTP_
RESPONSE_ SIZE_ BYTES - HTTP response size in bytes
- Ipfrs
Metrics - Global metrics registry for IPFRS.
- MEMORY_
ALLOCATED_ BYTES - Total memory allocated (in bytes)
- RATE_
LIMIT_ HITS_ TOTAL - Rate limit hits (requests blocked)
- RATE_
LIMIT_ TOKENS_ AVAILABLE - Available rate limit tokens
- STREAMING_
CHUNK_ SIZE_ BYTES - Streaming chunk size
- STREAMING_
OPERATIONS_ ACTIVE - Active streaming operations
- TENSOR_
OPERATIONS_ TOTAL - Tensor operations total
- TENSOR_
SIZE_ BYTES - Tensor size in bytes
- TENSOR_
SLICE_ OPERATIONS_ TOTAL - Tensor slice operations
- Timer
- Helper struct for timing operations
- UPLOAD_
BYTES_ TOTAL - Total bytes uploaded
- WEBSOCKET_
CONNECTIONS_ ACTIVE - Active WebSocket connections
- WEBSOCKET_
MESSAGES_ RECEIVED_ TOTAL - WebSocket messages received
- WEBSOCKET_
MESSAGES_ SENT_ TOTAL - WebSocket messages sent
Functions§
- encode_
metrics - Encode all metrics in Prometheus text format
- finish_
http_ request_ timer - Finish timing an HTTP request
- new_
shared_ metrics - Create a new
SharedMetricsinstance. - record_
auth_ attempt - Record authentication attempt
- record_
block_ error - Record block error
- record_
block_ retrieved - Record block retrieval
- record_
block_ stored - Record block storage
- record_
cache_ hit - Record cache hit
- record_
cache_ miss - Record cache miss
- record_
download_ bytes - Record download bytes
- record_
http_ request - Record an HTTP request
- record_
http_ request_ size - Record HTTP request size
- record_
http_ response_ size - Record HTTP response size
- record_
rate_ limit_ hit - Record rate limit hit
- record_
upload_ bytes - Record upload bytes
- start_
http_ request_ timer - Start timing an HTTP request
Type Aliases§
- Shared
Metrics - A thread-safe shared handle to an
IpfrsMetricsinstance.