Struct mz_persist_client::usage::StorageUsageClient

pub struct StorageUsageClient {
    cfg: PersistConfig,
    blob: Arc<dyn Blob>,
    metrics: Arc<Metrics>,
    state_versions: Arc<StateVersions>,
}

Provides access to storage usage metrics for a specific Blob

Fields

cfg: PersistConfig

blob: Arc<dyn Blob>

metrics: Arc<Metrics>

state_versions: Arc<StateVersions>

Implementations

impl StorageUsageClient

pub fn open(client: PersistClient) -> Self

Creates a new StorageUsageClient.

pub async fn shard_usage_referenced( &self, shard_id: ShardId, ) -> ShardUsageReferenced

Computes ShardUsageReferenced for a single shard. Suitable for customer billing.

pub async fn shards_usage_referenced<I>( &self, shard_ids: I, ) -> ShardsUsageReferenced

where I: IntoIterator<Item = ShardId>,

Computes ShardUsageReferenced for a given set of shards. Suitable for customer billing.

pub async fn shard_usage_audit(&self, shard_id: ShardId) -> ShardUsageAudit

Computes ShardUsageAudit for a single shard.

Performs a full scan of Blob and mz_persist::location::Consensus to compute a full audit of blob usage, categorizing both referenced and unreferenced blobs (see ShardUsageAudit for full details). While ShardUsageAudit::referenced_bytes is suitable for billing, prefer Self::shard_usage_referenced to avoid the (costly!) scan of Blob if the additional categorizations are not needed.

pub async fn shards_usage_audit(&self) -> ShardsUsageAudit

Computes ShardUsageAudit for every shard in an env.

See Self::shard_usage_audit for more details on when to use a full audit.

async fn blob_raw_usage(&self, prefix: BlobKeyPrefix<'_>) -> BlobUsage

async fn shard_usage_given_blob_usage( &self, shard_id: ShardId, blob_usage: &ShardBlobUsage, ) -> ShardUsageAudit

Trait Implementations

impl Clone for StorageUsageClient

fn clone(&self) -> StorageUsageClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StorageUsageClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.