Skip to main content
Version: v1

IGeneratedSummaryStats Interface

In addition to the normal summary tree + stats, this contains additional stats only relevant at the root of the tree.

Signature​

export interface IGeneratedSummaryStats extends ISummaryStats

Extends: ISummaryStats

Properties​

PropertyModifiersTypeDescription
dataStoreCountnumberThe total number of data stores in the container.
gcBlobNodeCountoptionalnumberThe number of gc blobs in this summary.
gcStateUpdatedDataStoreCountoptionalnumberThe number of data stores whose GC reference state was updated in this summary.
gcTotalBlobsSizeoptionalnumberThe size of the gc blobs in this summary.
nonSystemOpsSinceLastSummarynumberNumber of non-system ops since the last summary. See @fluidframework/protocol-base#isSystemMessage
opsSizesSinceLastSummarynumberSum of the sizes of all op contents since the last summary
summarizedDataStoreCountnumberThe number of data stores that were summarized in this summary.
summaryNumbernumberThe summary number for a container's summary. Incremented on summaries throughout its lifetime.

Property Details​

dataStoreCount​

The total number of data stores in the container.

Signature​

readonly dataStoreCount: number;

Type: number

gcBlobNodeCount​

The number of gc blobs in this summary.

Signature​

readonly gcBlobNodeCount?: number;

Type: number

gcStateUpdatedDataStoreCount​

The number of data stores whose GC reference state was updated in this summary.

Signature​

readonly gcStateUpdatedDataStoreCount?: number;

Type: number

gcTotalBlobsSize​

The size of the gc blobs in this summary.

Signature​

readonly gcTotalBlobsSize?: number;

Type: number

nonSystemOpsSinceLastSummary​

Number of non-system ops since the last summary. See @fluidframework/protocol-base#isSystemMessage

Signature​

readonly nonSystemOpsSinceLastSummary: number;

Type: number

opsSizesSinceLastSummary​

Sum of the sizes of all op contents since the last summary

Signature​

readonly opsSizesSinceLastSummary: number;

Type: number

summarizedDataStoreCount​

The number of data stores that were summarized in this summary.

Signature​

readonly summarizedDataStoreCount: number;

Type: number

summaryNumber​

The summary number for a container's summary. Incremented on summaries throughout its lifetime.

Signature​

readonly summaryNumber: number;

Type: number