package metrics

Import Path
	github.com/libp2p/go-libp2p/core/metrics (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 3 packages

Involved Source Files

	  d bandwidth.go
		Package metrics provides metrics collection and reporting interfaces for libp2p.

	  d reporter.go
		Package metrics provides metrics collection and reporting interfaces for libp2p.
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type BandwidthCounter (struct)
		BandwidthCounter tracks incoming and outgoing data transferred by the local peer.
		Metrics are available for total bandwidth across all peers / protocols, as well
		as segmented by remote peer ID and protocol ID.

		Methods (total 11)
			(*BandwidthCounter) GetBandwidthByPeer() map[peer.ID]Stats
				GetBandwidthByPeer returns a map of all remembered peers and the bandwidth
				metrics with respect to each. This method may be very expensive.

			(*BandwidthCounter) GetBandwidthByProtocol() map[protocol.ID]Stats
				GetBandwidthByProtocol returns a map of all remembered protocols and
				the bandwidth metrics with respect to each. This method may be moderately
				expensive.

			(*BandwidthCounter) GetBandwidthForPeer(p peer.ID) (out Stats)
				GetBandwidthForPeer returns a Stats struct with bandwidth metrics associated with the given peer.ID.
				The metrics returned include all traffic sent / received for the peer, regardless of protocol.

			(*BandwidthCounter) GetBandwidthForProtocol(proto protocol.ID) (out Stats)
				GetBandwidthForProtocol returns a Stats struct with bandwidth metrics associated with the given protocol.ID.
				The metrics returned include all traffic sent / received for the protocol, regardless of which peers were
				involved.

			(*BandwidthCounter) GetBandwidthTotals() (out Stats)
				GetBandwidthTotals returns a Stats struct with bandwidth metrics for all data sent / received by the
				local peer, regardless of protocol or remote peer IDs.

			(*BandwidthCounter) LogRecvMessage(size int64)
				LogRecvMessage records the size of an incoming message
				without associating the bandwidth to a specific peer or protocol.

			(*BandwidthCounter) LogRecvMessageStream(size int64, proto protocol.ID, p peer.ID)
				LogRecvMessageStream records the size of an incoming message over a single logical stream.
				Bandwidth is associated with the given protocol.ID and peer.ID.

			(*BandwidthCounter) LogSentMessage(size int64)
				LogSentMessage records the size of an outgoing message
				without associating the bandwidth to a specific peer or protocol.

			(*BandwidthCounter) LogSentMessageStream(size int64, proto protocol.ID, p peer.ID)
				LogSentMessageStream records the size of an outgoing message over a single logical stream.
				Bandwidth is associated with the given protocol.ID and peer.ID.

			(*BandwidthCounter) Reset()
				Reset clears all stats.

			(*BandwidthCounter) TrimIdle(since time.Time)
				TrimIdle trims all timers idle since the given time.

		Implements (at least one exported)
			*BandwidthCounter : Reporter
		As Outputs Of (at least one exported)
			func NewBandwidthCounter() *BandwidthCounter

	 type Reporter (interface)
		Reporter provides methods for logging and retrieving metrics.

		Methods (total 9)
			( Reporter) GetBandwidthByPeer() map[peer.ID]Stats
			( Reporter) GetBandwidthByProtocol() map[protocol.ID]Stats
			( Reporter) GetBandwidthForPeer(peer.ID) Stats
			( Reporter) GetBandwidthForProtocol(protocol.ID) Stats
			( Reporter) GetBandwidthTotals() Stats
			( Reporter) LogRecvMessage(int64)
			( Reporter) LogRecvMessageStream(int64, protocol.ID, peer.ID)
			( Reporter) LogSentMessage(int64)
			( Reporter) LogSentMessageStream(int64, protocol.ID, peer.ID)
		Implemented By (at least one exported)
			*BandwidthCounter
		As Inputs Of (at least 2)
			func github.com/libp2p/go-libp2p.BandwidthReporter(rep Reporter) libp2p.Option
			func github.com/libp2p/go-libp2p/p2p/net/swarm.WithMetrics(reporter Reporter) swarm.Option

	 type Stats (struct)
		Stats represents a point-in-time snapshot of bandwidth metrics.
		
		The TotalIn and TotalOut fields record cumulative bytes sent / received.
		The RateIn and RateOut fields record bytes sent / received per second.

		Fields (total 4)
			RateIn float64
			RateOut float64
			TotalIn int64
			TotalOut int64
		As Outputs Of (at least 10)
			func (*BandwidthCounter).GetBandwidthByPeer() map[peer.ID]Stats
			func (*BandwidthCounter).GetBandwidthByProtocol() map[protocol.ID]Stats
			func (*BandwidthCounter).GetBandwidthForPeer(p peer.ID) (out Stats)
			func (*BandwidthCounter).GetBandwidthForProtocol(proto protocol.ID) (out Stats)
			func (*BandwidthCounter).GetBandwidthTotals() (out Stats)
			func Reporter.GetBandwidthByPeer() map[peer.ID]Stats
			func Reporter.GetBandwidthByProtocol() map[protocol.ID]Stats
			func Reporter.GetBandwidthForPeer(peer.ID) Stats
			func Reporter.GetBandwidthForProtocol(protocol.ID) Stats
			func Reporter.GetBandwidthTotals() Stats


Package-Level Functions (only one)

	 func NewBandwidthCounter() *BandwidthCounter
		NewBandwidthCounter creates a new BandwidthCounter.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.