Documentation ¶
Index ¶
- type Report
- func (r *Report) Complete()
- func (r *Report) FailedPoR(sg oid.ID)
- func (r *Report) PassedPoR(sg oid.ID)
- func (r *Report) Result() *Result
- func (r *Report) SetPDPResults(passed, failed [][]byte)
- func (r *Report) SetPlacementCounters(hit, miss, fail uint32)
- func (r *Report) SetPoRCounters(requests, retries uint32)
- type Reporter
- type Result
- type Task
- func (t *Task) AuditContext() context.Context
- func (t *Task) ContainerID() cid.ID
- func (t *Task) ContainerNodes() [][]netmap.NodeInfo
- func (t *Task) ContainerStructure() container.Container
- func (t *Task) NetworkMap() *netmap.NetMap
- func (t *Task) Reporter() Reporter
- func (t *Task) StorageGroupList() []storagegroup.StorageGroup
- func (t *Task) WithAuditContext(ctx context.Context) *Task
- func (t *Task) WithContainerID(cnr cid.ID) *Task
- func (t *Task) WithContainerNodes(cnrNodes [][]netmap.NodeInfo) *Task
- func (t *Task) WithContainerStructure(cnr container.Container) *Task
- func (t *Task) WithNetworkMap(nm *netmap.NetMap) *Task
- func (t *Task) WithReporter(r Reporter) *Task
- func (t *Task) WithStorageGroupList(sgList []storagegroup.StorageGroup) *Task
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Report ¶
type Report struct {
// contains filtered or unexported fields
}
Report tracks the progress of auditing container data.
func (*Report) SetPDPResults ¶
SetPDPResults sets lists of nodes according to their PDP results.
func (*Report) SetPlacementCounters ¶
SetPlacementCounters sets counters of compliance with placement.
func (*Report) SetPoRCounters ¶
SetPoRCounters sets amounts of head requests and retries at PoR audit stage.
type Result ¶ added in v0.43.0
type Result struct { // NeoFS epoch when the data audit was performed. AuditEpoch uint64 // Container which data was audited. Container cid.ID // Binary-encoded public key of the Inner Ring member who conducted the audit. AuditorPublicKey []byte // Completion flag. Completed bool // Proof-of-Retrievability check results. PoR struct { // Number of requests made to get all headers of the objects inside storage // groups. Requests uint32 // Number of retries. Retries uint32 // Storage groups for which the check was passed. PassedStorageGroups []oid.ID // Storage groups for which the check was failed. FailedStorageGroups []oid.ID } // Proof-of-Placement check results. PoP struct { // Number of sampled objects placed in an optimal way compliant with the // Container storage policy. Hits uint32 // Number of objects placed in a suboptimal way according to the Container // placement policy, but still at a satisfactory replication level. Misses uint32 // Number of objects stored in a way not confirming to the Container storage // policy. Failures uint32 } // Proof-of-Data-Possession check results. PDP struct { // Binary-encoded public keys of sStorage nodes that passed at least one check. PassedStorageNodes [][]byte // Binary-encoded public keys of sStorage nodes that failed at least one check. FailedStorageNodes [][]byte } // contains filtered or unexported fields }
Result groups results of the data audit performed by the Inner Ring member.
New instances must be constructed using NewResult.
func NewResult ¶ added in v0.43.0
NewResult constructs new audit result for the container performed by subject authenticated with specified binary-encoded public key at the given epoch.
func (Result) Marshal ¶ added in v0.43.0
Marshal encodes Result into a Protocol Buffers V3 binary format.
type Task ¶
type Task struct {
// contains filtered or unexported fields
}
Task groups groups the container audit parameters.
func (*Task) AuditContext ¶
AuditContext returns context of the audit of the current epoch.
func (*Task) ContainerID ¶
ContainerID returns identifier of the container under audit.
func (*Task) ContainerNodes ¶
ContainerNodes returns nodes in the container under audit.
func (*Task) ContainerStructure ¶
ContainerStructure returns structure of the container under audit.
func (*Task) NetworkMap ¶
NetworkMap returns network map of audit epoch.
func (*Task) StorageGroupList ¶
func (t *Task) StorageGroupList() []storagegroup.StorageGroup
StorageGroupList returns list of storage groups from container under audit.
func (*Task) WithAuditContext ¶
WithAuditContext sets context of the audit of the current epoch.
func (*Task) WithContainerID ¶
WithContainerID sets identifier of the container under audit.
func (*Task) WithContainerNodes ¶
WithContainerNodes sets nodes in the container under audit.
func (*Task) WithContainerStructure ¶
WithContainerStructure sets structure of the container under audit.
func (*Task) WithNetworkMap ¶
WithNetworkMap sets network map of audit epoch.
func (*Task) WithReporter ¶
WithReporter sets audit report writer.
func (*Task) WithStorageGroupList ¶
func (t *Task) WithStorageGroupList(sgList []storagegroup.StorageGroup) *Task
WithStorageGroupList sets a list of storage groups from container under audit.