Documentation ¶
Overview ¶
Package instrumentation defines behaviors to instrument the CRDT stack.
Index ¶
- type DeleteInstrumentation
- type InsertInstrumentation
- type Instrumentation
- type NopInstrumentation
- func (i NopInstrumentation) DeleteCall()
- func (i NopInstrumentation) DeleteCallDuration(time.Duration)
- func (i NopInstrumentation) DeleteQuorumFailure()
- func (i NopInstrumentation) DeleteRecordCount(int)
- func (i NopInstrumentation) DeleteRecordDuration(time.Duration)
- func (i NopInstrumentation) InsertCall()
- func (i NopInstrumentation) InsertCallDuration(time.Duration)
- func (i NopInstrumentation) InsertQuorumFailure()
- func (i NopInstrumentation) InsertRecordCount(int)
- func (i NopInstrumentation) InsertRecordDuration(time.Duration)
- func (i NopInstrumentation) RepairCall()
- func (i NopInstrumentation) RepairCheckCompleteFailure()
- func (i NopInstrumentation) RepairCheckDuration(time.Duration)
- func (i NopInstrumentation) RepairCheckPartialFailure()
- func (i NopInstrumentation) RepairCheckRedundant()
- func (i NopInstrumentation) RepairDiscarded(int)
- func (i NopInstrumentation) RepairRequestCount(int)
- func (i NopInstrumentation) RepairWriteCount()
- func (i NopInstrumentation) RepairWriteDuration(time.Duration)
- func (i NopInstrumentation) RepairWriteFailure()
- func (i NopInstrumentation) RepairWriteSuccess()
- func (i NopInstrumentation) SelectBlockingDuration(time.Duration)
- func (i NopInstrumentation) SelectCall()
- func (i NopInstrumentation) SelectDuration(time.Duration)
- func (i NopInstrumentation) SelectFirstResponseDuration(time.Duration)
- func (i NopInstrumentation) SelectOverheadDuration(time.Duration)
- func (i NopInstrumentation) SelectPartialError()
- func (i NopInstrumentation) SelectSendAllPromotion()
- type RepairInstrumentation
- type SelectInstrumentation
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DeleteInstrumentation ¶
type DeleteInstrumentation interface { DeleteCall() // called for every invocation of Delete DeleteRecordCount(int) // +N, where N is how many records were provided to the Delete call DeleteCallDuration(time.Duration) // time spent per call DeleteRecordDuration(time.Duration) // time spent per record (average) DeleteQuorumFailure() // called if the Delete failed due to lack of quorum }
DeleteInstrumentation describes metrics for the Delete path.
type InsertInstrumentation ¶
type InsertInstrumentation interface { InsertCall() // called for every invocation of Insert InsertRecordCount(int) // +N, where N is how many records were provided to the Insert call InsertCallDuration(time.Duration) // time spent per call InsertRecordDuration(time.Duration) // time spent per record (average) InsertQuorumFailure() // called if the Insert failed due to lack of quorum }
InsertInstrumentation describes metrics for the Insert path.
type Instrumentation ¶
type Instrumentation interface { InsertInstrumentation SelectInstrumentation DeleteInstrumentation RepairInstrumentation }
Instrumentation describes the behaviors needed by the CRDT stack to report metrics about its performance.
type NopInstrumentation ¶
type NopInstrumentation struct{}
NopInstrumentation satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) DeleteCall ¶
func (i NopInstrumentation) DeleteCall()
DeleteCall satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) DeleteCallDuration ¶
func (i NopInstrumentation) DeleteCallDuration(time.Duration)
DeleteCallDuration satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) DeleteQuorumFailure ¶
func (i NopInstrumentation) DeleteQuorumFailure()
DeleteQuorumFailure satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) DeleteRecordCount ¶
func (i NopInstrumentation) DeleteRecordCount(int)
DeleteRecordCount satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) DeleteRecordDuration ¶
func (i NopInstrumentation) DeleteRecordDuration(time.Duration)
DeleteRecordDuration satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) InsertCall ¶
func (i NopInstrumentation) InsertCall()
InsertCall satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) InsertCallDuration ¶
func (i NopInstrumentation) InsertCallDuration(time.Duration)
InsertCallDuration satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) InsertQuorumFailure ¶
func (i NopInstrumentation) InsertQuorumFailure()
InsertQuorumFailure satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) InsertRecordCount ¶
func (i NopInstrumentation) InsertRecordCount(int)
InsertRecordCount satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) InsertRecordDuration ¶
func (i NopInstrumentation) InsertRecordDuration(time.Duration)
InsertRecordDuration satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) RepairCall ¶
func (i NopInstrumentation) RepairCall()
RepairRequestCall satisfies the Instrumnetation interface but does no work.
func (NopInstrumentation) RepairCheckCompleteFailure ¶
func (i NopInstrumentation) RepairCheckCompleteFailure()
RepairCheckCompleteFailure satisfies the Instrumnetation interface but does no work.
func (NopInstrumentation) RepairCheckDuration ¶
func (i NopInstrumentation) RepairCheckDuration(time.Duration)
RepairCheckDuration satisfies the Instrumnetation interface but does no work.
func (NopInstrumentation) RepairCheckPartialFailure ¶
func (i NopInstrumentation) RepairCheckPartialFailure()
RepairCheckPartialFailure satisfies the Instrumnetation interface but does no work.
func (NopInstrumentation) RepairCheckRedundant ¶
func (i NopInstrumentation) RepairCheckRedundant()
RepairRedundant satisfies the Instrumnetation interface but does no work.
func (NopInstrumentation) RepairDiscarded ¶
func (i NopInstrumentation) RepairDiscarded(int)
RepairDiscarded satisfies the Instrumnetation interface but does no work.
func (NopInstrumentation) RepairRequestCount ¶
func (i NopInstrumentation) RepairRequestCount(int)
RepairRequestCount satisfies the Instrumnetation interface but does no work.
func (NopInstrumentation) RepairWriteCount ¶
func (i NopInstrumentation) RepairWriteCount()
RepairWriteCount satisfies the Instrumnetation interface but does no work.
func (NopInstrumentation) RepairWriteDuration ¶
func (i NopInstrumentation) RepairWriteDuration(time.Duration)
RepairWriteDuration satisfies the Instrumnetation interface but does no work.
func (NopInstrumentation) RepairWriteFailure ¶
func (i NopInstrumentation) RepairWriteFailure()
RepairWriteFailure satisfies the Instrumnetation interface but does no work.
func (NopInstrumentation) RepairWriteSuccess ¶
func (i NopInstrumentation) RepairWriteSuccess()
RepairWriteSuccess satisfies the Instrumnetation interface but does no work.
func (NopInstrumentation) SelectBlockingDuration ¶
func (i NopInstrumentation) SelectBlockingDuration(time.Duration)
SelectBlockingDuration satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) SelectCall ¶
func (i NopInstrumentation) SelectCall()
SelectCall satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) SelectDuration ¶
func (i NopInstrumentation) SelectDuration(time.Duration)
SelectDuration satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) SelectFirstResponseDuration ¶
func (i NopInstrumentation) SelectFirstResponseDuration(time.Duration)
SelectFirstResponseDuration satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) SelectOverheadDuration ¶
func (i NopInstrumentation) SelectOverheadDuration(time.Duration)
SelectOverheadDuration satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) SelectPartialError ¶
func (i NopInstrumentation) SelectPartialError()
SelectPartialError satisfies the Instrumentation interface but does no work.
func (NopInstrumentation) SelectSendAllPromotion ¶
func (i NopInstrumentation) SelectSendAllPromotion()
SelectSendAllPromotion satisfies the Instrumentation interface but does no work.
type RepairInstrumentation ¶
type RepairInstrumentation interface { RepairCall() // called for every invocation of requestRepair RepairRequestCount(int) // +N, where N is the total number of keyMembers for which repair was requested RepairDiscarded(int) // +N, where N is the total number of keyMembers for which the repair request was discarded by the Repairer RepairCheckPartialFailure() // called when a single cluster returns a read error during a check RepairCheckCompleteFailure() // called when no cluster returned any data during a check (hence no repair could be performed) RepairCheckDuration(time.Duration) // time spent checking RepairCheckRedundant() // called when a repair was requested but the check revealed that no action is required RepairWriteCount() // called when the check revealed that a repair is required (i.e. a KeyScoreMember has to be written) RepairWriteSuccess() // called (separately per cluster) after a KeyScoreMember was successfully written RepairWriteFailure() // called (separately per cluster) after writing a KeyScoreMember failed RepairWriteDuration(time.Duration) // time spent (per cluster) writing the KeyScoreMember }
RepairInstrumentation describes metrics for Repairs.
type SelectInstrumentation ¶
type SelectInstrumentation interface { SelectCall() // called for every invocation of Select SelectFirstResponseDuration(time.Duration) // how long until we got the first element SelectPartialError() // called when an individual key gave an error from the cluster SelectBlockingDuration(time.Duration) // time spent waiting for everything SelectOverheadDuration(time.Duration) // time spent not waiting SelectDuration(time.Duration) // overall time performing this read (blocking + overhead) SelectSendAllPromotion() // called when the read strategy promotes a "SendOne" to a "SendAll" because of missing results }
SelectInstrumentation describes metrics for the Select path.