From f7bf9d85bb6468d15b3a0044261f22bfce14283b Mon Sep 17 00:00:00 2001 From: Sukun Date: Thu, 23 Feb 2023 12:59:57 +0530 Subject: [PATCH] identify: add more detailed metrics (#2126) * add identify metrics metrics added: address count protocol count peer push support * address review changes * update dashboards --- CHANGELOG.md | 4 + dashboards/identify/identify.json | 852 ++++++++++++++++++ .../grafana-dashboards/dashboard.json | 355 -------- p2p/protocol/identify/id.go | 50 +- p2p/protocol/identify/metrics.go | 115 ++- p2p/protocol/identify/metrics_test.go | 16 +- 6 files changed, 1000 insertions(+), 392 deletions(-) create mode 100644 dashboards/identify/identify.json delete mode 100644 p2p/protocol/identify/grafana-dashboards/dashboard.json diff --git a/CHANGELOG.md b/CHANGELOG.md index a0344b3f..53023ea3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,6 +29,10 @@ Metrics were added to: * Swarm: - [Early Muxer Selection](https://github.com/libp2p/go-libp2p/pull/2119): Added early_muxer label indicating whether a connection was established using early muxer selection. - [IP Version](https://github.com/libp2p/go-libp2p/pull/2114): Added ip_version label to connection metrics +* Identify: + - Metrics for Identify, IdentifyPush, PushesTriggered (https://github.com/libp2p/go-libp2p/pull/2069) + - Address Count, Protocol Count, Connection IDPush Support (https://github.com/libp2p/go-libp2p/pull/2126) + We also migrated the metric dashboards to a top-level [dashboards](https://github.com/libp2p/go-libp2p/tree/master/dashboards) directory. diff --git a/dashboards/identify/identify.json b/dashboards/identify/identify.json new file mode 100644 index 00000000..491766db --- /dev/null +++ b/dashboards/identify/identify.json @@ -0,0 +1,852 @@ +{ + "__inputs": [ + { + "name": "DS_PROMETHEUS", + "label": "Prometheus", + "description": "", + "type": "datasource", + "pluginId": "prometheus", + "pluginName": "Prometheus" + } + ], + "__elements": {}, + "__requires": [ + { + "type": "grafana", + "id": "grafana", + "name": "Grafana", + "version": "9.3.6" + }, + { + "type": "panel", + "id": "piechart", + "name": "Pie chart", + "version": "" + }, + { + "type": "datasource", + "id": "prometheus", + "name": "Prometheus", + "version": "1.0.0" + }, + { + "type": "panel", + "id": "stat", + "name": "Stat", + "version": "" + }, + { + "type": "panel", + "id": "timeseries", + "name": "Time series", + "version": "" + } + ], + "annotations": { + "list": [ + { + "builtIn": 1, + "datasource": { + "type": "grafana", + "uid": "-- Grafana --" + }, + "enable": true, + "hide": true, + "iconColor": "rgba(0, 211, 255, 1)", + "name": "Annotations & Alerts", + "target": { + "limit": 100, + "matchAny": false, + "tags": [], + "type": "dashboard" + }, + "type": "dashboard" + } + ] + }, + "editable": true, + "fiscalYearStartMonth": 0, + "graphTooltip": 0, + "id": null, + "links": [], + "liveNow": false, + "panels": [ + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "axisCenteredZero": false, + "axisColorMode": "text", + "axisLabel": "", + "axisPlacement": "auto", + "barAlignment": 0, + "drawStyle": "line", + "fillOpacity": 0, + "gradientMode": "none", + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "lineInterpolation": "linear", + "lineWidth": 1, + "pointSize": 5, + "scaleDistribution": { + "type": "linear" + }, + "showPoints": "auto", + "spanNulls": false, + "stacking": { + "group": "A", + "mode": "none" + }, + "thresholdsStyle": { + "mode": "off" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + }, + { + "color": "red", + "value": 80 + } + ] + } + }, + "overrides": [] + }, + "gridPos": { + "h": 9, + "w": 12, + "x": 0, + "y": 0 + }, + "id": 2, + "options": { + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "tooltip": { + "mode": "multi", + "sort": "none" + } + }, + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "editorMode": "code", + "expr": "increase(libp2p_identify_identify_pushes_triggered_total[$__rate_interval])", + "legendFormat": "{{trigger}}", + "range": true, + "refId": "A" + } + ], + "title": "Pushes triggered", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "axisCenteredZero": false, + "axisColorMode": "text", + "axisLabel": "", + "axisPlacement": "auto", + "barAlignment": 0, + "drawStyle": "line", + "fillOpacity": 0, + "gradientMode": "none", + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "lineInterpolation": "linear", + "lineWidth": 1, + "pointSize": 5, + "scaleDistribution": { + "type": "linear" + }, + "showPoints": "auto", + "spanNulls": false, + "stacking": { + "group": "A", + "mode": "none" + }, + "thresholdsStyle": { + "mode": "off" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + }, + { + "color": "red", + "value": 80 + } + ] + } + }, + "overrides": [] + }, + "gridPos": { + "h": 9, + "w": 12, + "x": 12, + "y": 0 + }, + "id": 4, + "options": { + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "tooltip": { + "mode": "multi", + "sort": "none" + } + }, + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "editorMode": "code", + "expr": "rate(libp2p_identify_identify_total[$__rate_interval])", + "legendFormat": "{{dir}}", + "range": true, + "refId": "A" + } + ], + "title": "Identify Messages", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "thresholds" + }, + "mappings": [], + "min": 0, + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + } + ] + }, + "unit": "none" + }, + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "address count" + }, + "properties": [ + { + "id": "color", + "value": { + "fixedColor": "blue", + "mode": "fixed" + } + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 6, + "x": 0, + "y": 9 + }, + "id": 9, + "options": { + "colorMode": "value", + "graphMode": "area", + "justifyMode": "auto", + "orientation": "auto", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "textMode": "auto" + }, + "pluginVersion": "9.3.6", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "editorMode": "code", + "exemplar": false, + "expr": "libp2p_identify_addrs_count", + "legendFormat": "address count", + "range": true, + "refId": "A" + } + ], + "title": "Outgoing Address Count", + "type": "stat" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "thresholds" + }, + "mappings": [], + "min": 0, + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + } + ] + } + }, + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "protocols count" + }, + "properties": [ + { + "id": "color", + "value": { + "fixedColor": "purple", + "mode": "fixed" + } + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 6, + "x": 6, + "y": 9 + }, + "id": 17, + "options": { + "colorMode": "value", + "graphMode": "area", + "justifyMode": "auto", + "orientation": "auto", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "textMode": "auto" + }, + "pluginVersion": "9.3.6", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "editorMode": "code", + "expr": "libp2p_identify_protocols_count", + "legendFormat": "protocols count", + "range": true, + "refId": "A" + } + ], + "title": "Outgoing Protocols Count", + "type": "stat" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "axisCenteredZero": false, + "axisColorMode": "text", + "axisLabel": "", + "axisPlacement": "auto", + "barAlignment": 0, + "drawStyle": "line", + "fillOpacity": 0, + "gradientMode": "none", + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "lineInterpolation": "linear", + "lineWidth": 1, + "pointSize": 5, + "scaleDistribution": { + "type": "linear" + }, + "showPoints": "auto", + "spanNulls": false, + "stacking": { + "group": "A", + "mode": "none" + }, + "thresholdsStyle": { + "mode": "off" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + }, + { + "color": "red", + "value": 80 + } + ] + } + }, + "overrides": [] + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 12, + "y": 9 + }, + "id": 5, + "options": { + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "tooltip": { + "mode": "multi", + "sort": "none" + } + }, + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "editorMode": "code", + "expr": "rate(libp2p_identify_identify_push_total[$__rate_interval])", + "legendFormat": "{{dir}}", + "range": true, + "refId": "A" + } + ], + "title": "Identify Push Messages", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "axisCenteredZero": false, + "axisColorMode": "text", + "axisLabel": "", + "axisPlacement": "auto", + "barAlignment": 0, + "drawStyle": "line", + "fillOpacity": 0, + "gradientMode": "none", + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "lineInterpolation": "linear", + "lineWidth": 1, + "pointSize": 5, + "scaleDistribution": { + "type": "linear" + }, + "showPoints": "auto", + "spanNulls": false, + "stacking": { + "group": "A", + "mode": "none" + }, + "thresholdsStyle": { + "mode": "off" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + }, + { + "color": "red", + "value": 80 + } + ] + } + }, + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "address count" + }, + "properties": [ + { + "id": "color", + "value": { + "fixedColor": "blue", + "mode": "fixed" + } + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 0, + "y": 17 + }, + "id": 11, + "options": { + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "tooltip": { + "mode": "single", + "sort": "none" + } + }, + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "editorMode": "code", + "expr": "histogram_quantile(0.5, sum(rate(libp2p_identify_addrs_received_bucket[$__rate_interval])) by (le))", + "legendFormat": "50th percentile", + "range": true, + "refId": "A" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "editorMode": "code", + "expr": "histogram_quantile(0.90, sum(rate(libp2p_identify_addrs_received_bucket[$__rate_interval])) by (le))", + "hide": false, + "legendFormat": "90th percentile", + "range": true, + "refId": "B" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "editorMode": "code", + "expr": "histogram_quantile(0.99, sum(rate(libp2p_identify_addrs_received_bucket[$__rate_interval])) by (le))", + "hide": false, + "legendFormat": "99 percentile", + "range": true, + "refId": "C" + } + ], + "title": "Incoming Address Count (Avg)", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "axisCenteredZero": false, + "axisColorMode": "text", + "axisLabel": "", + "axisPlacement": "auto", + "barAlignment": 0, + "drawStyle": "line", + "fillOpacity": 0, + "gradientMode": "none", + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "lineInterpolation": "linear", + "lineWidth": 1, + "pointSize": 5, + "scaleDistribution": { + "type": "linear" + }, + "showPoints": "auto", + "spanNulls": false, + "stacking": { + "group": "A", + "mode": "none" + }, + "thresholdsStyle": { + "mode": "off" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + }, + { + "color": "red", + "value": 80 + } + ] + } + }, + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "protocols count" + }, + "properties": [ + { + "id": "color", + "value": { + "fixedColor": "purple", + "mode": "fixed" + } + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 12, + "y": 17 + }, + "id": 13, + "options": { + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "tooltip": { + "mode": "single", + "sort": "none" + } + }, + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "editorMode": "code", + "expr": "histogram_quantile(0.5, sum(rate(libp2p_identify_protocols_received_bucket[$__rate_interval])) by (le))", + "legendFormat": "50th percentile", + "range": true, + "refId": "A" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "editorMode": "code", + "expr": "histogram_quantile(0.90, sum(rate(libp2p_identify_protocols_received_bucket[$__rate_interval])) by (le))", + "hide": false, + "legendFormat": "90th percentile", + "range": true, + "refId": "B" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "editorMode": "code", + "expr": "histogram_quantile(0.99, sum(rate(libp2p_identify_protocols_received_bucket[$__rate_interval])) by (le))", + "hide": false, + "legendFormat": "99th percentile", + "range": true, + "refId": "C" + } + ], + "title": "Incoming Protocols Count (Avg)", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + } + }, + "mappings": [] + }, + "overrides": [] + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 0, + "y": 25 + }, + "id": 15, + "options": { + "legend": { + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "pieType": "pie", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "tooltip": { + "mode": "single", + "sort": "none" + } + }, + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${DS_PROMETHEUS}" + }, + "editorMode": "code", + "expr": "increase(libp2p_identify_conn_push_support_total[$__rate_interval])", + "legendFormat": "{{support}}", + "range": true, + "refId": "A" + } + ], + "title": "New Connections: Push Support", + "type": "piechart" + } + ], + "schemaVersion": 37, + "style": "dark", + "tags": [], + "templating": { + "list": [] + }, + "time": { + "from": "now-15m", + "to": "now" + }, + "timepicker": {}, + "timezone": "", + "title": "libp2p Identify", + "uid": "0NDzQQ0Vz", + "version": 2, + "weekStart": "" +} \ No newline at end of file diff --git a/p2p/protocol/identify/grafana-dashboards/dashboard.json b/p2p/protocol/identify/grafana-dashboards/dashboard.json deleted file mode 100644 index c00850e3..00000000 --- a/p2p/protocol/identify/grafana-dashboards/dashboard.json +++ /dev/null @@ -1,355 +0,0 @@ -{ - "__inputs": [ - { - "name": "DS_PROMETHEUS", - "label": "Prometheus", - "description": "", - "type": "datasource", - "pluginId": "prometheus", - "pluginName": "Prometheus" - } - ], - "__elements": {}, - "__requires": [ - { - "type": "grafana", - "id": "grafana", - "name": "Grafana", - "version": "9.3.6" - }, - { - "type": "datasource", - "id": "prometheus", - "name": "Prometheus", - "version": "1.0.0" - }, - { - "type": "panel", - "id": "timeseries", - "name": "Time series", - "version": "" - } - ], - "annotations": { - "list": [ - { - "builtIn": 1, - "datasource": { - "type": "grafana", - "uid": "-- Grafana --" - }, - "enable": true, - "hide": true, - "iconColor": "rgba(0, 211, 255, 1)", - "name": "Annotations & Alerts", - "target": { - "limit": 100, - "matchAny": false, - "tags": [], - "type": "dashboard" - }, - "type": "dashboard" - } - ] - }, - "editable": true, - "fiscalYearStartMonth": 0, - "graphTooltip": 0, - "id": null, - "links": [], - "liveNow": false, - "panels": [ - { - "datasource": { - "type": "prometheus", - "uid": "${DS_PROMETHEUS}" - }, - "fieldConfig": { - "defaults": { - "color": { - "mode": "palette-classic" - }, - "custom": { - "axisCenteredZero": false, - "axisColorMode": "text", - "axisLabel": "", - "axisPlacement": "auto", - "barAlignment": 0, - "drawStyle": "line", - "fillOpacity": 0, - "gradientMode": "none", - "hideFrom": { - "legend": false, - "tooltip": false, - "viz": false - }, - "lineInterpolation": "linear", - "lineWidth": 1, - "pointSize": 5, - "scaleDistribution": { - "type": "linear" - }, - "showPoints": "auto", - "spanNulls": false, - "stacking": { - "group": "A", - "mode": "none" - }, - "thresholdsStyle": { - "mode": "off" - } - }, - "mappings": [], - "thresholds": { - "mode": "absolute", - "steps": [ - { - "color": "green", - "value": null - }, - { - "color": "red", - "value": 80 - } - ] - } - }, - "overrides": [] - }, - "gridPos": { - "h": 8, - "w": 12, - "x": 0, - "y": 0 - }, - "id": 4, - "options": { - "legend": { - "calcs": [], - "displayMode": "list", - "placement": "bottom", - "showLegend": true - }, - "tooltip": { - "mode": "multi", - "sort": "none" - } - }, - "targets": [ - { - "datasource": { - "type": "prometheus", - "uid": "${DS_PROMETHEUS}" - }, - "editorMode": "code", - "expr": "rate(libp2p_identify_identify_total[$__rate_interval])", - "legendFormat": "{{dir}}", - "range": true, - "refId": "A" - } - ], - "title": "Identify Messages", - "type": "timeseries" - }, - { - "datasource": { - "type": "prometheus", - "uid": "${DS_PROMETHEUS}" - }, - "fieldConfig": { - "defaults": { - "color": { - "mode": "palette-classic" - }, - "custom": { - "axisCenteredZero": false, - "axisColorMode": "text", - "axisLabel": "", - "axisPlacement": "auto", - "barAlignment": 0, - "drawStyle": "line", - "fillOpacity": 0, - "gradientMode": "none", - "hideFrom": { - "legend": false, - "tooltip": false, - "viz": false - }, - "lineInterpolation": "linear", - "lineWidth": 1, - "pointSize": 5, - "scaleDistribution": { - "type": "linear" - }, - "showPoints": "auto", - "spanNulls": false, - "stacking": { - "group": "A", - "mode": "none" - }, - "thresholdsStyle": { - "mode": "off" - } - }, - "mappings": [], - "thresholds": { - "mode": "absolute", - "steps": [ - { - "color": "green", - "value": null - }, - { - "color": "red", - "value": 80 - } - ] - } - }, - "overrides": [] - }, - "gridPos": { - "h": 8, - "w": 12, - "x": 12, - "y": 0 - }, - "id": 5, - "options": { - "legend": { - "calcs": [], - "displayMode": "list", - "placement": "bottom", - "showLegend": true - }, - "tooltip": { - "mode": "multi", - "sort": "none" - } - }, - "targets": [ - { - "datasource": { - "type": "prometheus", - "uid": "${DS_PROMETHEUS}" - }, - "editorMode": "code", - "expr": "rate(libp2p_identify_identify_push_total[$__rate_interval])", - "legendFormat": "{{dir}}", - "range": true, - "refId": "A" - } - ], - "title": "Identify Push Messages", - "type": "timeseries" - }, - { - "datasource": { - "type": "prometheus", - "uid": "${DS_PROMETHEUS}" - }, - "fieldConfig": { - "defaults": { - "color": { - "mode": "palette-classic" - }, - "custom": { - "axisCenteredZero": false, - "axisColorMode": "text", - "axisLabel": "", - "axisPlacement": "auto", - "barAlignment": 0, - "drawStyle": "line", - "fillOpacity": 0, - "gradientMode": "none", - "hideFrom": { - "legend": false, - "tooltip": false, - "viz": false - }, - "lineInterpolation": "linear", - "lineWidth": 1, - "pointSize": 5, - "scaleDistribution": { - "type": "linear" - }, - "showPoints": "auto", - "spanNulls": false, - "stacking": { - "group": "A", - "mode": "none" - }, - "thresholdsStyle": { - "mode": "off" - } - }, - "mappings": [], - "thresholds": { - "mode": "absolute", - "steps": [ - { - "color": "green", - "value": null - }, - { - "color": "red", - "value": 80 - } - ] - } - }, - "overrides": [] - }, - "gridPos": { - "h": 9, - "w": 12, - "x": 0, - "y": 8 - }, - "id": 2, - "options": { - "legend": { - "calcs": [], - "displayMode": "list", - "placement": "bottom", - "showLegend": true - }, - "tooltip": { - "mode": "multi", - "sort": "none" - } - }, - "targets": [ - { - "datasource": { - "type": "prometheus", - "uid": "${DS_PROMETHEUS}" - }, - "editorMode": "code", - "expr": "rate(libp2p_identify_identify_pushes_triggered_total[$__rate_interval])", - "legendFormat": "{{trigger}}", - "range": true, - "refId": "A" - } - ], - "title": "Pushes triggered", - "type": "timeseries" - } - ], - "schemaVersion": 37, - "style": "dark", - "tags": [], - "templating": { - "list": [] - }, - "time": { - "from": "now-1h", - "to": "now" - }, - "timepicker": {}, - "timezone": "", - "title": "libp2p Identify", - "uid": "0NDzQQ0Vz", - "version": 4, - "weekStart": "" -} diff --git a/p2p/protocol/identify/id.go b/p2p/protocol/identify/id.go index 3bbe58bf..390e8afb 100644 --- a/p2p/protocol/identify/id.go +++ b/p2p/protocol/identify/id.go @@ -307,11 +307,8 @@ func (ids *idService) sendPushes(ctx context.Context) { if err != nil { // connection might have been closed recently return } - if ids.metricsTracer != nil { - ids.metricsTracer.IdentifyPush(network.DirOutbound) - } // TODO: find out if the peer supports push if we didn't have any information about push support - if err := ids.sendIdentifyResp(str); err != nil { + if err := ids.sendIdentifyResp(str, true); err != nil { log.Debugw("failed to send identify push", "peer", c.RemotePeer(), "error", err) return } @@ -401,28 +398,19 @@ func (ids *idService) identifyConn(c network.Conn) error { return err } - if ids.metricsTracer != nil { - ids.metricsTracer.Identify(network.DirInbound) - } return ids.handleIdentifyResponse(s, false) } // handlePush handles incoming identify push streams func (ids *idService) handlePush(s network.Stream) { ids.handleIdentifyResponse(s, true) - if ids.metricsTracer != nil { - ids.metricsTracer.IdentifyPush(network.DirInbound) - } } func (ids *idService) handleIdentifyRequest(s network.Stream) { - if ids.metricsTracer != nil { - ids.metricsTracer.Identify(network.DirOutbound) - } - _ = ids.sendIdentifyResp(s) + _ = ids.sendIdentifyResp(s, false) } -func (ids *idService) sendIdentifyResp(s network.Stream) error { +func (ids *idService) sendIdentifyResp(s network.Stream, isPush bool) error { if err := s.Scope().SetService(ServiceName); err != nil { s.Reset() return fmt.Errorf("failed to attaching stream to identify service: %w", err) @@ -432,11 +420,21 @@ func (ids *idService) sendIdentifyResp(s network.Stream) error { ids.currentSnapshot.Lock() snapshot := ids.currentSnapshot.snapshot ids.currentSnapshot.Unlock() + + log.Debugw("sending snapshot", "seq", snapshot.seq, "protocols", snapshot.protocols, "addrs", snapshot.addrs) + + mes := ids.createBaseIdentifyResponse(s.Conn(), &snapshot) + mes.SignedPeerRecord = ids.getSignedRecord(&snapshot) + log.Debugf("%s sending message to %s %s", ID, s.Conn().RemotePeer(), s.Conn().RemoteMultiaddr()) - if err := ids.writeChunkedIdentifyMsg(s, &snapshot); err != nil { + if err := ids.writeChunkedIdentifyMsg(s, mes); err != nil { return err } + if ids.metricsTracer != nil { + ids.metricsTracer.IdentifySent(isPush, len(mes.Protocols), len(mes.ListenAddrs)) + } + ids.connsMu.Lock() defer ids.connsMu.Unlock() e, ok := ids.conns[s.Conn()] @@ -485,6 +483,10 @@ func (ids *idService) handleIdentifyResponse(s network.Stream, isPush bool) erro ids.consumeMessage(mes, c, isPush) + if ids.metricsTracer != nil { + ids.metricsTracer.IdentifyReceived(isPush, len(mes.Protocols), len(mes.ListenAddrs)) + } + ids.connsMu.Lock() defer ids.connsMu.Unlock() e, ok := ids.conns[c] @@ -497,6 +499,11 @@ func (ids *idService) handleIdentifyResponse(s network.Stream, isPush bool) erro } else { e.PushSupport = identifyPushUnsupported } + + if ids.metricsTracer != nil { + ids.metricsTracer.ConnPushSupport(e.PushSupport) + } + ids.conns[c] = e return nil } @@ -536,19 +543,14 @@ func (ids *idService) updateSnapshot() { log.Debugw("updating snapshot", "seq", snapshot.seq, "addrs", snapshot.addrs) } -func (ids *idService) writeChunkedIdentifyMsg(s network.Stream, snapshot *identifySnapshot) error { - c := s.Conn() - log.Debugw("sending snapshot", "seq", snapshot.seq, "protocols", snapshot.protocols, "addrs", snapshot.addrs) - - mes := ids.createBaseIdentifyResponse(c, snapshot) - sr := ids.getSignedRecord(snapshot) - mes.SignedPeerRecord = sr +func (ids *idService) writeChunkedIdentifyMsg(s network.Stream, mes *pb.Identify) error { writer := pbio.NewDelimitedWriter(s) - if sr == nil || proto.Size(mes) <= legacyIDSize { + if mes.SignedPeerRecord == nil || proto.Size(mes) <= legacyIDSize { return writer.WriteMsg(mes) } + sr := mes.SignedPeerRecord mes.SignedPeerRecord = nil if err := writer.WriteMsg(mes); err != nil { return err diff --git a/p2p/protocol/identify/metrics.go b/p2p/protocol/identify/metrics.go index f8ffc6dd..28598fa3 100644 --- a/p2p/protocol/identify/metrics.go +++ b/p2p/protocol/identify/metrics.go @@ -35,17 +35,73 @@ var ( }, []string{"dir"}, ) + connPushSupportTotal = prometheus.NewCounterVec( + prometheus.CounterOpts{ + Namespace: metricNamespace, + Name: "conn_push_support_total", + Help: "Identify Connection Push Support", + }, + []string{"support"}, + ) + protocolsCount = prometheus.NewGauge( + prometheus.GaugeOpts{ + Namespace: metricNamespace, + Name: "protocols_count", + Help: "Protocols Count", + }, + ) + addrsCount = prometheus.NewGauge( + prometheus.GaugeOpts{ + Namespace: metricNamespace, + Name: "addrs_count", + Help: "Address Count", + }, + ) + numProtocolsReceived = prometheus.NewHistogram( + prometheus.HistogramOpts{ + Namespace: metricNamespace, + Name: "protocols_received", + Help: "Number of Protocols received", + Buckets: buckets, + }, + ) + numAddrsReceived = prometheus.NewHistogram( + prometheus.HistogramOpts{ + Namespace: metricNamespace, + Name: "addrs_received", + Help: "Number of addrs received", + Buckets: buckets, + }, + ) collectors = []prometheus.Collector{ pushesTriggered, identify, identifyPush, + connPushSupportTotal, + protocolsCount, + addrsCount, + numProtocolsReceived, + numAddrsReceived, } + // 1 to 20 and then up to 100 in steps of 5 + buckets = append( + prometheus.LinearBuckets(1, 1, 20), + prometheus.LinearBuckets(25, 5, 16)..., + ) ) type MetricsTracer interface { + // TriggeredPushes counts IdentifyPushes triggered by event TriggeredPushes(event any) - Identify(network.Direction) - IdentifyPush(network.Direction) + + // ConnPushSupport counts peers by Push Support + ConnPushSupport(identifyPushSupport) + + // IdentifyReceived tracks metrics on receiving an identify response + IdentifyReceived(isPush bool, numProtocols int, numAddrs int) + + // IdentifySent tracks metrics on sending an identify response + IdentifySent(isPush bool, numProtocols int, numAddrs int) } type metricsTracer struct{} @@ -90,18 +146,61 @@ func (t *metricsTracer) TriggeredPushes(ev any) { pushesTriggered.WithLabelValues(*tags...).Inc() } -func (t *metricsTracer) Identify(dir network.Direction) { +func (t *metricsTracer) IncrementPushSupport(s identifyPushSupport) { tags := metricshelper.GetStringSlice() defer metricshelper.PutStringSlice(tags) - *tags = append(*tags, metricshelper.GetDirection(dir)) - identify.WithLabelValues(*tags...).Inc() + *tags = append(*tags, getPushSupport(s)) + connPushSupportTotal.WithLabelValues(*tags...).Inc() } -func (t *metricsTracer) IdentifyPush(dir network.Direction) { +func (t *metricsTracer) IdentifySent(isPush bool, numProtocols int, numAddrs int) { tags := metricshelper.GetStringSlice() defer metricshelper.PutStringSlice(tags) - *tags = append(*tags, metricshelper.GetDirection(dir)) - identifyPush.WithLabelValues(*tags...).Inc() + if isPush { + *tags = append(*tags, metricshelper.GetDirection(network.DirOutbound)) + identifyPush.WithLabelValues(*tags...).Inc() + } else { + *tags = append(*tags, metricshelper.GetDirection(network.DirInbound)) + identify.WithLabelValues(*tags...).Inc() + } + + protocolsCount.Set(float64(numProtocols)) + addrsCount.Set(float64(numAddrs)) +} + +func (t *metricsTracer) IdentifyReceived(isPush bool, numProtocols int, numAddrs int) { + tags := metricshelper.GetStringSlice() + defer metricshelper.PutStringSlice(tags) + + if isPush { + *tags = append(*tags, metricshelper.GetDirection(network.DirInbound)) + identifyPush.WithLabelValues(*tags...).Inc() + } else { + *tags = append(*tags, metricshelper.GetDirection(network.DirOutbound)) + identify.WithLabelValues(*tags...).Inc() + } + + numProtocolsReceived.Observe(float64(numProtocols)) + numAddrsReceived.Observe(float64(numAddrs)) +} + +func (t *metricsTracer) ConnPushSupport(support identifyPushSupport) { + tags := metricshelper.GetStringSlice() + defer metricshelper.PutStringSlice(tags) + + *tags = append(*tags, getPushSupport(support)) + connPushSupportTotal.WithLabelValues(*tags...).Inc() +} + +func getPushSupport(s identifyPushSupport) string { + switch s { + case identifyPushSupported: + return "supported" + case identifyPushUnsupported: + return "not supported" + default: + return "unknown" + } } diff --git a/p2p/protocol/identify/metrics_test.go b/p2p/protocol/identify/metrics_test.go index 567c1d9e..2cf5a209 100644 --- a/p2p/protocol/identify/metrics_test.go +++ b/p2p/protocol/identify/metrics_test.go @@ -7,7 +7,6 @@ import ( "testing" "github.com/libp2p/go-libp2p/core/event" - "github.com/libp2p/go-libp2p/core/network" ) func TestMetricsNoAllocNoCover(t *testing.T) { @@ -16,12 +15,19 @@ func TestMetricsNoAllocNoCover(t *testing.T) { event.EvtLocalProtocolsUpdated{}, event.EvtNATDeviceTypeChanged{}, } - dirs := []network.Direction{network.DirInbound, network.DirOutbound, network.DirUnknown} + + pushSupport := []identifyPushSupport{ + identifyPushSupportUnknown, + identifyPushSupported, + identifyPushUnsupported, + } + tr := NewMetricsTracer() tests := map[string]func(){ - "TriggeredPushes": func() { tr.TriggeredPushes(events[rand.Intn(len(events))]) }, - "Identify": func() { tr.Identify(dirs[rand.Intn(len(dirs))]) }, - "IdentifyPush": func() { tr.IdentifyPush(dirs[rand.Intn(len(dirs))]) }, + "TriggeredPushes": func() { tr.TriggeredPushes(events[rand.Intn(len(events))]) }, + "ConnPushSupport": func() { tr.ConnPushSupport(pushSupport[rand.Intn(len(pushSupport))]) }, + "IdentifyReceived": func() { tr.IdentifyReceived(rand.Intn(2) == 0, rand.Intn(20), rand.Intn(20)) }, + "IdentifySent": func() { tr.IdentifySent(rand.Intn(2) == 0, rand.Intn(20), rand.Intn(20)) }, } for method, f := range tests { allocs := testing.AllocsPerRun(1000, f)