package
0.2.1
Repository: https://github.com/drand/go-clients.git
Documentation: pkg.go.dev

# Packages

Package pprof is separated out from metrics to isolate the 'init' functionality of pprof, so that it is included when used by binaries, but not if other drand packages get used or integrated into clients that don't expect the pprof side effect to have taken effect.

# Functions

DKGStateChange emits appropriate dkgState, dkgStateTimestamp and dkgLeader metrics.
No description provided by the author
RegisterClientMetrics registers drand client metrics with the given registry.
Start starts a prometheus metrics server with debug endpoints.
No description provided by the author

# Variables

APICallCounter (Group) how many grpc calls.
BeaconDiscrepancyLatency (Group) millisecond duration between time beacon created and calculated time of round.
ClientDNSLatencyVec tracks the observed DNS resolution times.
ClientHTTPHeartbeatFailure measures the number of times HTTP heartbeats fail.
ClientHTTPHeartbeatLatency measures the randomness latency of an HTTP source.
ClientHTTPHeartbeatSuccess measures the success rate of HTTP hearbeat randomness requests.
ClientInFlight measures how many active requests have been made.
ClientLatencyVec tracks raw http request latencies.
ClientMetrics about the drand client requests to servers.
ClientRequests measures how many total requests have been made.
ClientTLSLatencyVec tracks observed TLS connection times.
ClientWatchLatency measures the latency of the watch channel from the client's perspective.
DrandStartTimestamp (group) contains the timestamp in seconds since the epoch of the drand process startup.
DrandStorageBackend reports the database the node is running with.
No description provided by the author
GroupDialFailures (Group) how many failures connecting outbound.
GroupMetrics about the group surface (grp, group-member stuff).
No description provided by the author
No description provided by the author
HTTPCallCounter (HTTP) how many http requests.
HTTPInFlight (HTTP) how many http requests exist.
HTTPLatency (HTTP) how long http request handling takes.
HTTPMetrics about the public surface area (http requests, cdn stuff).
IsDrandNode (Group) is 1 for drand nodes, 0 for relays.
LastBeaconRound is the most recent round (as also seen at /health) stored.
OutgoingConnections (Group) how many GrpcClient connections are present.
OutgoingConnectionState (Group) tracks the state of an outgoing connection, using the states from https://github.com/grpc/grpc-go/blob/8075dd35d2738b352c4355b4b353dc1e9183bea7/connectivity/connectivity.go#L51-L62 Due to the fact that grpc-go doesn't support adding a listener for state tracking, this is emitted only when getting a connection to the remote host.
PrivateMetrics about the internal world (go process, private stuff).

# Interfaces

Client is the same as net.MetricsClient but avoids cyclic dependencies in our metric and net code.

# Type aliases

Handler abstracts a helper for relaying http requests to a group peer.