Add metrics reporting #37
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,11 @@ | ||
| module github.com/libp2p/go-libp2p-kbucket | ||
|
|
||
| require ( | ||
| github.com/btcsuite/btcutil v0.0.0-20190207003914-4c204d697803 | ||
| github.com/ipfs/go-ipfs-util v0.0.1 | ||
| github.com/ipfs/go-log v0.0.1 | ||
| github.com/libp2p/go-libp2p-core v0.0.1 | ||
| github.com/libp2p/go-libp2p-peerstore v0.1.0 | ||
| github.com/minio/sha256-simd v0.0.0-20190131020904-2d45a736cd16 | ||
| go.opencensus.io v0.22.0 | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| package metrics | ||
|
|
||
| import ( | ||
| "context" | ||
| "github.com/btcsuite/btcutil/base58" | ||
| "go.opencensus.io/stats" | ||
| "go.opencensus.io/stats/view" | ||
| "go.opencensus.io/tag" | ||
| "time" | ||
| ) | ||
|
|
||
| // Keys | ||
| var ( | ||
| keyLocalId, _ = tag.NewKey("local_dht_id") | ||
| keyBucketIndex, _ = tag.NewKey("bucket_index") | ||
| ) | ||
|
|
||
| // Constants for measure names are exported and can be used to | ||
| // fetch views from the `DefaultViews` map. | ||
| const ( | ||
| MeasureBucketsFull = "libp2p.io/dht/k-bucket/full_buckets" | ||
| MeasureBucketsNonEmpty = "libp2p.io/dht/k-bucket/non_empty_buckets" | ||
| MeasureBucketUtilization = "libp2p.io/dht/k-bucket/utilization" | ||
| MeasurePeerLatency = "libp2p.io/dht/k-bucket/peer_latency" | ||
| MeasurePeersAdded = "libp2p.io/dht/k-bucket/peers_added" | ||
| MeasurePeersRejectedHighLatency = "libp2p.io/dht/k-bucket/peers_rejected_high_latency" | ||
| MeasurePeersRejectedNoCapacity = "libp2p.io/dht/k-bucket/peers_rejected_capacity" | ||
| MeasurePeersRefreshed = "libp2p.io/dht/k-bucket/peers_refreshed" | ||
| MeasurePeersRemoved = "libp2p.io/dht/k-bucket/peers_removed" | ||
| ) | ||
|
|
||
| // Measures are exported so that consumers can create their own views if the `DefaultViews` | ||
| // aren't sufficient. However, they should be updated using the functions below to avoid | ||
| // leaking OpenCensus cruft throughout the rest of the code. | ||
| var ( | ||
| KBucketsFull = stats.Int64(MeasureBucketsFull, | ||
| "Number of k-buckets that are at capacity (have k entries).", stats.UnitDimensionless) | ||
| KBucketsNonEmpty = stats.Int64(MeasureBucketsNonEmpty, | ||
| "Number of k-buckets with at least one entry.", stats.UnitDimensionless) | ||
| KBucketUtilization = stats.Int64(MeasureBucketUtilization, | ||
| "Number of entries per k-bucket.", stats.UnitDimensionless) | ||
| KBucketPeerLatency = stats.Float64(MeasurePeerLatency, | ||
| "Recorded latency measurements for all peers added to each bucket, per bucket.", stats.UnitMilliseconds) | ||
| KBucketPeersAdded = stats.Int64(MeasurePeersAdded, | ||
| "Number of peers added to each k-bucket (cumulative). Note that peers can be counted twice if added and removed.", stats.UnitDimensionless) | ||
| KBucketPeersRejectedHighLatency = stats.Int64(MeasurePeersRejectedHighLatency, | ||
| "Number of peers rejected from k-buckets due to high latency.", stats.UnitDimensionless) | ||
| KBucketPeersRejectedNoCapacity = stats.Int64(MeasurePeersRejectedNoCapacity, | ||
| "Number of peers rejected from the routing table because their k-bucket was full.", stats.UnitDimensionless) | ||
| KBucketPeersRefreshed = stats.Int64(MeasurePeersRefreshed, | ||
| "Number of peers moved to the front of a k-bucket that they were already in.", stats.UnitDimensionless) | ||
| KBucketPeersRemoved = stats.Int64(MeasurePeersRemoved, | ||
| "Number of peers removed from each k-bucket (cumulative). "+ | ||
| "Peers may be counted twice if added and removed.", stats.UnitDimensionless) | ||
| ) | ||
|
|
||
| // LocalContext returns `ctx` tagged with the local dht `id` for metrics reporting. | ||
| func LocalContext(ctx context.Context, id []byte) context.Context { | ||
| pretty := base58.Encode(id) | ||
| ctx, _ = tag.New(ctx, tag.Upsert(keyLocalId, pretty)) | ||
| return ctx | ||
| } | ||
|
|
||
| // RecordBucketsFull records the current number of buckets `n` that are at capacity. | ||
| func RecordBucketsFull(ctx context.Context, n int) { | ||
| stats.Record(ctx, KBucketsFull.M(int64(n))) | ||
| } | ||
|
|
||
| // RecordBucketsNonEmpty records the current number of buckets `n` that have at least one entry. | ||
| func RecordBucketsNonEmpty(ctx context.Context, n int) { | ||
| stats.Record(ctx, KBucketsNonEmpty.M(int64(n))) | ||
| } | ||
|
|
||
| // recordWithBucketIndex is a helper func that applies a tag to the measurements `ms` | ||
| // indicating the index of the bucket to which the measurement applies. | ||
| func recordWithBucketIndex(ctx context.Context, bucketIndex int, ms ...stats.Measurement) { | ||
| _ = stats.RecordWithTags(ctx, | ||
| []tag.Mutator{tag.Upsert(keyBucketIndex, string(bucketIndex))}, | ||
|
There was a problem hiding this comment.
|
||
| ms..., | ||
| ) | ||
| } | ||
|
|
||
| // RecordBucketUtilization records the current number of entries `n` for | ||
| // the given `bucketIndex`. | ||
| func RecordBucketUtilization(ctx context.Context, bucketIndex int, n int) { | ||
| recordWithBucketIndex(ctx, bucketIndex, KBucketUtilization.M(int64(n))) | ||
| } | ||
|
|
||
| // RecordPeerAdded records that a peer was added to the bucket with index `bucketIndex`. | ||
| // It also records the `measuredLatency` of the peer at the time they were added. | ||
| func RecordPeerAdded(ctx context.Context, bucketIndex int, measuredLatency time.Duration) { | ||
| recordWithBucketIndex(ctx, bucketIndex, | ||
| KBucketPeersAdded.M(1), | ||
| KBucketPeerLatency.M(float64(measuredLatency/time.Millisecond))) | ||
| } | ||
|
|
||
| // RecordPeerRejectedHighLatency records that a peer was rejected from the bucket with | ||
| // index `bucketIndex` because their measured connection latency was too high. | ||
| func RecordPeerRejectedHighLatency(ctx context.Context, bucketIndex int) { | ||
| recordWithBucketIndex(ctx, bucketIndex, KBucketPeersRejectedHighLatency.M(1)) | ||
| } | ||
|
|
||
| // RecordPeerRejectedNoCapacity records that a peer was rejected from the bucket with | ||
| // index `bucketIndex` because the bucket was full, and no members were eligible for eviction. | ||
| func RecordPeerRejectedNoCapacity(ctx context.Context, bucketIndex int) { | ||
| recordWithBucketIndex(ctx, bucketIndex, KBucketPeersRejectedNoCapacity.M(1)) | ||
| } | ||
|
|
||
| // RecordPeerRefreshed records that a peer in the bucket with index `bucketIndex` | ||
| // had its "last seen" status updated, moving it to the head of its bucket. | ||
| func RecordPeerRefreshed(ctx context.Context, bucketIndex int) { | ||
| recordWithBucketIndex(ctx, bucketIndex, KBucketPeersRefreshed.M(1)) | ||
| } | ||
|
|
||
| // RecordPeerRemoved records that a peer was removed from the bucket with | ||
| // index `bucketIndex`. | ||
| func RecordPeerRemoved(ctx context.Context, bucketIndex int) { | ||
| recordWithBucketIndex(ctx, bucketIndex, KBucketPeersRemoved.M(1)) | ||
| } | ||
|
|
||
| var DefaultViews = map[string]*view.View{ | ||
|
There was a problem hiding this comment. Initialisation of views should be separate from the construction of the default views. Also |
||
| MeasureBucketsFull: { | ||
| Measure: KBucketsFull, | ||
| TagKeys: []tag.Key{keyLocalId}, | ||
| Aggregation: view.LastValue(), | ||
| }, | ||
|
|
||
| MeasureBucketsNonEmpty: { | ||
| Measure: KBucketsNonEmpty, | ||
| TagKeys: []tag.Key{keyLocalId}, | ||
| Aggregation: view.LastValue(), | ||
| }, | ||
|
|
||
| MeasureBucketUtilization: { | ||
| Measure: KBucketUtilization, | ||
| TagKeys: []tag.Key{keyLocalId, keyBucketIndex}, | ||
| Aggregation: view.LastValue(), | ||
| }, | ||
|
|
||
| MeasurePeersAdded: { | ||
| Measure: KBucketPeersAdded, | ||
| TagKeys: []tag.Key{keyLocalId, keyBucketIndex}, | ||
| Aggregation: view.Count(), | ||
| }, | ||
|
|
||
| MeasurePeersRejectedHighLatency: { | ||
| Measure: KBucketPeersRejectedHighLatency, | ||
| TagKeys: []tag.Key{keyLocalId, keyBucketIndex}, | ||
| Aggregation: view.Count(), | ||
| }, | ||
|
|
||
| MeasurePeersRejectedNoCapacity: { | ||
| Measure: KBucketPeersRejectedNoCapacity, | ||
| TagKeys: []tag.Key{keyLocalId, keyBucketIndex}, | ||
| Aggregation: view.Count(), | ||
| }, | ||
|
|
||
| MeasurePeersRemoved: { | ||
| Measure: KBucketPeersRemoved, | ||
| TagKeys: []tag.Key{keyLocalId, keyBucketIndex}, | ||
| Aggregation: view.Count(), | ||
| }, | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nitpick: If you are multi-lining a function call, put each parameter on a new line and not a combination. In this particular case, the third parameter is lost at the end of the line.