metrics

package
v1.0.0-rc2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 23, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Handler 

type Handler struct{}

Handler implements a Prometheus /metrics endpoint.

func NewHandler 

func NewHandler() *Handler

NewHandler returns a new /metrics endpoint which returns Prometheus formatted statistics.

func (*Handler) Handler 

func (h *Handler) Handler() common.HTTPRequestHandler

Handler returns the Handler that should be invoked when an HTTP GET is requested to the target endpoint. This Handler must be registered with an HTTP server.

func (*Handler) Method 

func (h *Handler) Method() string

Method returns the HTTP method, which is always GET.

func (*Handler) Path 

func (h *Handler) Path() string

Path returns the base path of the target URL for this Handler.

type Metrics 

type Metrics struct {
	// contains filtered or unexported fields
}

Metrics manages the metrics for Orb.

func Get 

func Get() *Metrics

Get returns an Orb metrics provider.

func (*Metrics) AddOperationTime 

func (m *Metrics) AddOperationTime(value time.Duration)

AddOperationTime records the time it takes to add an operation to the queue.

func (*Metrics) AddOperationToBatchTime 

func (m *Metrics) AddOperationToBatchTime(value time.Duration)

AddOperationToBatchTime records the time to add operation to batch.

func (*Metrics) AddProofParseCredential 

func (m *Metrics) AddProofParseCredential(value time.Duration)

AddProofParseCredential records vct parse credential in add proof.

func (*Metrics) AddProofSign 

func (m *Metrics) AddProofSign(value time.Duration)

AddProofSign records vct sign in add proof.

func (*Metrics) AddUnpublishedOperationTime 

func (m *Metrics) AddUnpublishedOperationTime(value time.Duration)

AddUnpublishedOperationTime records the time to add unpublished operation.

func (*Metrics) BatchCutTime 

func (m *Metrics) BatchCutTime(value time.Duration)

BatchCutTime records the time it takes to cut an operation batch. The duration is from the time that the first operation was added to the time that the batch is cut.

func (*Metrics) BatchRollbackTime 

func (m *Metrics) BatchRollbackTime(value time.Duration)

BatchRollbackTime records the time it takes to roll back an operation batch (in case of a transient error). The duration is from the time that the first operation was added to the time that the batch is cut.

func (*Metrics) BatchSize 

func (m *Metrics) BatchSize(value float64)

BatchSize records the size of an operation batch.

func (*Metrics) CASIncrementCacheHitCount 

func (m *Metrics) CASIncrementCacheHitCount()

CASIncrementCacheHitCount increments the number of CAS cache hits.

func (*Metrics) CASReadTime 

func (m *Metrics) CASReadTime(casType string, value time.Duration)

CASReadTime records the time it takes to read a document from CAS storage.

func (*Metrics) CASResolveTime 

func (m *Metrics) CASResolveTime(value time.Duration)

CASResolveTime records the time it takes to resolve a document from CAS.

func (*Metrics) CASWriteSize 

func (m *Metrics) CASWriteSize(modelType string, size int)

CASWriteSize the size (in bytes) of the data written to CAS for the given model type.

func (*Metrics) CASWriteTime 

func (m *Metrics) CASWriteTime(value time.Duration)

CASWriteTime records the time it takes to write a document to CAS.

func (*Metrics) CalculateUnpublishedOperationKey 

func (m *Metrics) CalculateUnpublishedOperationKey(value time.Duration)

CalculateUnpublishedOperationKey records the time to create unpublished operation key.

func (*Metrics) DBBatchTime 

func (m *Metrics) DBBatchTime(dbType string, value time.Duration)

DBBatchTime records the time it takes to batch in db.

func (*Metrics) DBDeleteTime 

func (m *Metrics) DBDeleteTime(dbType string, value time.Duration)

DBDeleteTime records the time it takes to delete in db.

func (*Metrics) DBGetBulkTime 

func (m *Metrics) DBGetBulkTime(dbType string, value time.Duration)

DBGetBulkTime records the time it takes to get bulk in db.

func (*Metrics) DBGetTagsTime 

func (m *Metrics) DBGetTagsTime(dbType string, value time.Duration)

DBGetTagsTime records the time it takes to get tags in db.

func (*Metrics) DBGetTime 

func (m *Metrics) DBGetTime(dbType string, value time.Duration)

DBGetTime records the time it takes to get data in db.

func (*Metrics) DBPutTime 

func (m *Metrics) DBPutTime(dbType string, value time.Duration)

DBPutTime records the time it takes to store data in db.

func (*Metrics) DBQueryTime 

func (m *Metrics) DBQueryTime(dbType string, value time.Duration)

DBQueryTime records the time it takes to query in db.

func (*Metrics) DecorateOperationTime 

func (m *Metrics) DecorateOperationTime(value time.Duration)

DecorateOperationTime records the time to decorate operation.

func (*Metrics) DecorateTime 

func (m *Metrics) DecorateTime(value time.Duration)

DecorateTime records the time it takes to decorate operation (for update handler).

func (*Metrics) DeleteDocumentFromCreateDocumentStoreTime 

func (m *Metrics) DeleteDocumentFromCreateDocumentStoreTime(value time.Duration)

DeleteDocumentFromCreateDocumentStoreTime records deleting document from create document store.

func (*Metrics) DocumentCreateUpdateTime 

func (m *Metrics) DocumentCreateUpdateTime(value time.Duration)

DocumentCreateUpdateTime records the time it takes the REST handler to process a create/update operation.

func (*Metrics) DocumentResolveTime 

func (m *Metrics) DocumentResolveTime(value time.Duration)

DocumentResolveTime records the time it takes the REST handler to resolve a document.

func (*Metrics) ExportPublicKeyCount 

func (m *Metrics) ExportPublicKeyCount()

ExportPublicKeyCount increments the number of export public key hits.

func (*Metrics) ExportPublicKeyTime 

func (m *Metrics) ExportPublicKeyTime(value time.Duration)

ExportPublicKeyTime records the time for export public key.

func (*Metrics) GetAOEndpointAndResolveDocumentFromAOTime 

func (m *Metrics) GetAOEndpointAndResolveDocumentFromAOTime(value time.Duration)

GetAOEndpointAndResolveDocumentFromAOTime records the time it takes to get anchor origin endpoint and resolve document from anchor origin when decorating operation (for update handler).

func (*Metrics) GetAnchorOriginEndpointTime 

func (m *Metrics) GetAnchorOriginEndpointTime(value time.Duration)

GetAnchorOriginEndpointTime records getting anchor origin endpoint information.

func (*Metrics) GetCreateOperationResultTime 

func (m *Metrics) GetCreateOperationResultTime(value time.Duration)

GetCreateOperationResultTime records the time to create operation result response.

func (*Metrics) GetProtocolVersionTime 

func (m *Metrics) GetProtocolVersionTime(value time.Duration)

GetProtocolVersionTime records the time to get protocol version.

func (*Metrics) GetPublishedOperations 

func (m *Metrics) GetPublishedOperations(value time.Duration)

GetPublishedOperations records the time to get published operations for suffix.

func (*Metrics) GetUnpublishedOperations 

func (m *Metrics) GetUnpublishedOperations(value time.Duration)

GetUnpublishedOperations records the time it takes to get unpublished operations for suffix.

func (*Metrics) HTTPCreateUpdateTime 

func (m *Metrics) HTTPCreateUpdateTime(value time.Duration)

HTTPCreateUpdateTime records the time rest call for create or update.

func (*Metrics) HTTPResolveTime 

func (m *Metrics) HTTPResolveTime(value time.Duration)

HTTPResolveTime records the time rest call for resolve.

func (*Metrics) InboxHandlerTime 

func (m *Metrics) InboxHandlerTime(activityType string, value time.Duration)

InboxHandlerTime records the time it takes to handle an activity posted to the inbox.

func (*Metrics) OutboxIncrementActivityCount 

func (m *Metrics) OutboxIncrementActivityCount(activityType string)

OutboxIncrementActivityCount increments the number of activities of the given type posted to the outbox.

func (*Metrics) OutboxPostTime 

func (m *Metrics) OutboxPostTime(value time.Duration)

OutboxPostTime records the time it takes to post a message to the outbox.

func (*Metrics) OutboxResolveInboxesTime 

func (m *Metrics) OutboxResolveInboxesTime(value time.Duration)

OutboxResolveInboxesTime records the time it takes to resolve inboxes for an outbox post.

func (*Metrics) ParseOperationTime 

func (m *Metrics) ParseOperationTime(value time.Duration)

ParseOperationTime records the time to parse operation.

func (*Metrics) ProcessAnchorTime 

func (m *Metrics) ProcessAnchorTime(value time.Duration)

ProcessAnchorTime records the time it takes for the Observer to process an anchor credential.

func (*Metrics) ProcessDIDTime 

func (m *Metrics) ProcessDIDTime(value time.Duration)

ProcessDIDTime records the time it takes for the Observer to process a DID.

func (*Metrics) ProcessOperation 

func (m *Metrics) ProcessOperation(value time.Duration)

ProcessOperation records the overall time to process operation.

func (*Metrics) ProcessWitnessedAnchorCredentialTime 

func (m *Metrics) ProcessWitnessedAnchorCredentialTime(value time.Duration)

ProcessWitnessedAnchorCredentialTime records the time it takes to process a witnessed anchor credential by publishing it to the Observer and posting a 'Create' activity.

func (*Metrics) ProcessorResolveTime 

func (m *Metrics) ProcessorResolveTime(value time.Duration)

ProcessorResolveTime records the time it takes for processor to resolve document when decorating operation (for update handler).

func (*Metrics) PutPublishedOperations 

func (m *Metrics) PutPublishedOperations(value time.Duration)

PutPublishedOperations records the time to store published operations.

func (*Metrics) PutUnpublishedOperation 

func (m *Metrics) PutUnpublishedOperation(value time.Duration)

PutUnpublishedOperation records the time it takes to store unpublished operation.

func (*Metrics) RequestDiscoveryTime 

func (m *Metrics) RequestDiscoveryTime(value time.Duration)

RequestDiscoveryTime records the time it takes to request discovery.

func (*Metrics) ResolveDocumentFromAnchorOriginTime 

func (m *Metrics) ResolveDocumentFromAnchorOriginTime(value time.Duration)

ResolveDocumentFromAnchorOriginTime records resolving document from anchor origin.

func (*Metrics) ResolveDocumentFromCreateDocumentStoreTime 

func (m *Metrics) ResolveDocumentFromCreateDocumentStoreTime(value time.Duration)

ResolveDocumentFromCreateDocumentStoreTime records resolving document from create document store.

func (*Metrics) ResolveDocumentLocallyTime 

func (m *Metrics) ResolveDocumentLocallyTime(value time.Duration)

ResolveDocumentLocallyTime records resolving document locally.

func (*Metrics) SignCount 

func (m *Metrics) SignCount()

SignCount increments the number of sign hits.

func (*Metrics) SignTime 

func (m *Metrics) SignTime(value time.Duration)

SignTime records the time for sign.

func (*Metrics) SignerAddLinkedDataProof 

func (m *Metrics) SignerAddLinkedDataProof(value time.Duration)

SignerAddLinkedDataProof records add data linked proof.

func (*Metrics) SignerGetKey 

func (m *Metrics) SignerGetKey(value time.Duration)

SignerGetKey records get key time.

func (*Metrics) SignerSign 

func (m *Metrics) SignerSign(value time.Duration)

SignerSign records sign.

func (*Metrics) ValidateOperationTime 

func (m *Metrics) ValidateOperationTime(value time.Duration)

ValidateOperationTime records the time to validate operation.

func (*Metrics) VerifyCIDTime 

func (m *Metrics) VerifyCIDTime(value time.Duration)

VerifyCIDTime records verifying CID for document resolution.

func (*Metrics) VerifyCount 

func (m *Metrics) VerifyCount()

VerifyCount increments the number of verify hits.

func (*Metrics) VerifyTime 

func (m *Metrics) VerifyTime(value time.Duration)

VerifyTime records the time for verify.

func (*Metrics) WitnessAddProof 

func (m *Metrics) WitnessAddProof(value time.Duration)

WitnessAddProof records vct witness add proof.

func (*Metrics) WitnessAddProofVctNil 

func (m *Metrics) WitnessAddProofVctNil(value time.Duration)

WitnessAddProofVctNil records vct witness.

func (*Metrics) WitnessAddVC 

func (m *Metrics) WitnessAddVC(value time.Duration)

WitnessAddVC records vct witness add vc.

func (*Metrics) WitnessAnchorCredentialTime 

func (m *Metrics) WitnessAnchorCredentialTime(value time.Duration)

WitnessAnchorCredentialTime records the time it takes for a verifiable credential to gather proofs from all required witnesses (according to witness policy). The start time is when the verifiable credential is issued and the end time is the time that the witness policy is satisfied.

func (*Metrics) WitnessVerifyVCTSignature 

func (m *Metrics) WitnessVerifyVCTSignature(value time.Duration)

WitnessVerifyVCTSignature records vct witness verify vct.

func (*Metrics) WitnessWebFinger 

func (m *Metrics) WitnessWebFinger(value time.Duration)

WitnessWebFinger records vct witness web finger.

func (*Metrics) WriteAnchorBuildCredentialTime 

func (m *Metrics) WriteAnchorBuildCredentialTime(value time.Duration)

WriteAnchorBuildCredentialTime records the time it takes to build credential inside write anchor.

func (*Metrics) WriteAnchorGetPreviousAnchorsGetBulkTime 

func (m *Metrics) WriteAnchorGetPreviousAnchorsGetBulkTime(value time.Duration)

WriteAnchorGetPreviousAnchorsGetBulkTime records the time it takes to get bulk inside previous anchor.

func (*Metrics) WriteAnchorGetPreviousAnchorsTime 

func (m *Metrics) WriteAnchorGetPreviousAnchorsTime(value time.Duration)

WriteAnchorGetPreviousAnchorsTime records the time it takes to get previous anchor.

func (*Metrics) WriteAnchorGetWitnessesTime 

func (m *Metrics) WriteAnchorGetWitnessesTime(value time.Duration)

WriteAnchorGetWitnessesTime records the time it takes to get witnesses inside write anchor.

func (*Metrics) WriteAnchorPostOfferActivityTime 

func (m *Metrics) WriteAnchorPostOfferActivityTime(value time.Duration)

WriteAnchorPostOfferActivityTime records the time it takes to post offer activity inside write anchor.

func (*Metrics) WriteAnchorResolveHostMetaLinkTime 

func (m *Metrics) WriteAnchorResolveHostMetaLinkTime(value time.Duration)

WriteAnchorResolveHostMetaLinkTime records the time it takes to resolve host meta link.

func (*Metrics) WriteAnchorSignCredentialTime 

func (m *Metrics) WriteAnchorSignCredentialTime(value time.Duration)

WriteAnchorSignCredentialTime records the time it takes to sign credential inside write anchor.

func (*Metrics) WriteAnchorSignLocalWatchTime 

func (m *Metrics) WriteAnchorSignLocalWatchTime(value time.Duration)

WriteAnchorSignLocalWatchTime records the time it takes to watch inside sign local.

func (*Metrics) WriteAnchorSignLocalWitnessLogTime 

func (m *Metrics) WriteAnchorSignLocalWitnessLogTime(value time.Duration)

WriteAnchorSignLocalWitnessLogTime records the time it takes to witness log inside sign local.

func (*Metrics) WriteAnchorSignWithLocalWitnessTime 

func (m *Metrics) WriteAnchorSignWithLocalWitnessTime(value time.Duration)

WriteAnchorSignWithLocalWitnessTime records the time it takes to sign with local witness.

func (*Metrics) WriteAnchorSignWithServerKeyTime 

func (m *Metrics) WriteAnchorSignWithServerKeyTime(value time.Duration)

WriteAnchorSignWithServerKeyTime records the time it takes to sign with server key.

func (*Metrics) WriteAnchorStoreTime 

func (m *Metrics) WriteAnchorStoreTime(value time.Duration)

WriteAnchorStoreTime records the time it takes to store an anchor event.

func (*Metrics) WriteAnchorTime 

func (m *Metrics) WriteAnchorTime(value time.Duration)

WriteAnchorTime records the time it takes to write an anchor credential and post an 'Offer' activity.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.