rest api: /debug/extra/pprof admin endpoint for debugging

It allows to control SetMutexProfileFraction and SetBlockProfileRate by passing non-negative rate values.
algorand · Jun 7, 2024 · c1bbdad · c1bbdad
1 parent 6c91f52
commit c1bbdad
Show file tree

Hide file tree

Showing 12 changed files with 1,719 additions and 1,361 deletions.
diff --git a/daemon/algod/api/algod.oas2.json b/daemon/algod/api/algod.oas2.json
@@ -1305,6 +1305,44 @@
         }
       ]
     },
+    "/debug/extra/pprof": {
+      "get": {
+        "description": "Retrieves the current settings for blocking and mutex profiles",
+        "tags": [
+          "private"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "schemes": [
+          "http"
+        ],
+        "operationId": "GetDebugExtraProf",
+        "responses": {
+          "200": {
+            "$ref": "#/responses/DebugExtraProfResponse"
+          }
+        }
+      },
+      "put": {
+        "description": "Enables blocking and mutex profiles, and returns the old settings",
+        "tags": [
+          "private"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "schemes": [
+          "http"
+        ],
+        "operationId": "PutDebugExtraProf",
+        "responses": {
+          "200": {
+            "$ref": "#/responses/DebugExtraProfResponse"
+          }
+        }
+      }
+    },
     "/v2/shutdown": {
       "post": {
         "description": "Special management endpoint to shutdown the node. Optionally provide a timeout parameter to indicate that the node should begin shutting down after a number of seconds.",
@@ -4053,6 +4091,26 @@
         }
       }
     },
+    "DebugExtraProf": {
+      "description": "algod mutex and blocking profiling state.",
+      "type": "object",
+      "title": "algod mutex and blocking profiling state.",
+      "tags": [
+        "private"
+      ],
+      "properties": {
+        "block-rate": {
+          "description": "The rate of blocking events. The profiler aims to sample an average of one blocking event per rate nanoseconds spent blocked. To turn off profiling entirely, pass rate 0.",
+          "example": 1000,
+          "type": "integer"
+        },
+        "mutex-rate": {
+          "description": "The rate of mutex events. On average 1/rate events are reported. To turn off profiling entirely, pass rate 0",
+          "example": 1000,
+          "type": "integer"
+        }
+      }
+    },
     "BuildVersion": {
       "tags": [
         "common"
@@ -5500,6 +5558,12 @@
       "schema": {
         "$ref": "#/definitions/Version"
       }
+    },
+    "DebugExtraProfResponse": {
+      "description": "DebugPprof is the response to the /debug/extra/pprof endpoint",
+      "schema": {
+        "$ref": "#/definitions/DebugExtraProf"
+      }
     }
   },
   "securityDefinitions": {

diff --git a/daemon/algod/api/algod.oas3.yml b/daemon/algod/api/algod.oas3.yml
@@ -520,6 +520,16 @@
         },
         "description": "Teal compile Result"
       },
+      "DebugExtraProfResponse": {
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/DebugExtraProf"
+            }
+          }
+        },
+        "description": "DebugPprof is the response to the /debug/extra/pprof endpoint"
+      },
       "DisassembleResponse": {
         "content": {
           "application/json": {
@@ -1790,6 +1800,23 @@
         "title": "BuildVersion contains the current algod build version information.",
         "type": "object"
       },
+      "DebugExtraProf": {
+        "description": "algod mutex and blocking profiling state.",
+        "properties": {
+          "block-rate": {
+            "description": "The rate of blocking events. The profiler aims to sample an average of one blocking event per rate nanoseconds spent blocked. To turn off profiling entirely, pass rate 0.",
+            "example": 1000,
+            "type": "integer"
+          },
+          "mutex-rate": {
+            "description": "The rate of mutex events. On average 1/rate events are reported. To turn off profiling entirely, pass rate 0",
+            "example": 1000,
+            "type": "integer"
+          }
+        },
+        "title": "algod mutex and blocking profiling state.",
+        "type": "object"
+      },
       "DryrunRequest": {
         "description": "Request data type for dryrun endpoint. Given the Transactions and simulated ledger state upload, run TEAL scripts and return debugging information.",
         "properties": {
@@ -2748,6 +2775,46 @@
   },
   "openapi": "3.0.1",
   "paths": {
+    "/debug/extra/pprof": {
+      "get": {
+        "description": "Retrieves the current settings for blocking and mutex profiles",
+        "operationId": "GetDebugExtraProf",
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DebugExtraProf"
+                }
+              }
+            },
+            "description": "DebugPprof is the response to the /debug/extra/pprof endpoint"
+          }
+        },
+        "tags": [
+          "private"
+        ]
+      },
+      "put": {
+        "description": "Enables blocking and mutex profiles, and returns the old settings",
+        "operationId": "PutDebugExtraProf",
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DebugExtraProf"
+                }
+              }
+            },
+            "description": "DebugPprof is the response to the /debug/extra/pprof endpoint"
+          }
+        },
+        "tags": [
+          "private"
+        ]
+      }
+    },
     "/genesis": {
       "get": {
         "description": "Returns the entire genesis file in json.",

diff --git a/daemon/algod/api/server/common/handlers.go b/daemon/algod/api/server/common/handlers.go
@@ -186,8 +186,6 @@ func VersionsHandler(ctx lib.ReqContext, context echo.Context) {
 		},
 	}
 	json.NewEncoder(w).Encode(response.Body)
-
-	return
 }
 
 // CORS