Skip to content

Route pprof via swagger endpoints #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
j-rafique merged 1 commit into from
Oct 9, 2025
Merged

Route pprof via swagger endpoints #202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
468 changes: 182 additions & 286 deletions gen/supernode/service.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

925 changes: 541 additions & 384 deletions gen/supernode/service.pb.gw.go
View file
Open in desktop

Large diffs are not rendered by default.

215 changes: 148 additions & 67 deletions gen/supernode/service.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@
"application/json"
],
"paths": {
"/api/v1/debug/pprof": {
"/api/v1/debug/raw/pprof": {
"get": {
"summary": "Profiling endpoints",
"operationId": "SupernodeService_GetPprofIndex",
"summary": "Raw pprof endpoints - return standard pprof output directly",
"operationId": "SupernodeService_GetRawPprof",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/supernodeGetPprofIndexResponse"
"$ref": "#/definitions/supernodeRawPprofResponse"
}
},
"default": {
Expand All @@ -34,19 +34,29 @@
}
}
},
"parameters": [
{
"name": "debug",
"description": "Debug level (0 for binary, \u003e0 for text)",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"tags": [
"SupernodeService"
]
}
},
"/api/v1/debug/pprof/allocs": {
"/api/v1/debug/raw/pprof/allocs": {
"get": {
"operationId": "SupernodeService_GetPprofAllocs",
"operationId": "SupernodeService_GetRawPprofAllocs",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/supernodeGetPprofProfileResponse"
"$ref": "#/definitions/supernodeRawPprofResponse"
}
},
"default": {
Expand All @@ -59,7 +69,7 @@
"parameters": [
{
"name": "debug",
"description": "Debug level (optional, default 1)",
"description": "Debug level (0 for binary, \u003e0 for text)",
"in": "query",
"required": false,
"type": "integer",
Expand All @@ -71,14 +81,14 @@
]
}
},
"/api/v1/debug/pprof/block": {
"/api/v1/debug/raw/pprof/block": {
"get": {
"operationId": "SupernodeService_GetPprofBlock",
"operationId": "SupernodeService_GetRawPprofBlock",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/supernodeGetPprofProfileResponse"
"$ref": "#/definitions/supernodeRawPprofResponse"
}
},
"default": {
Expand All @@ -91,7 +101,7 @@
"parameters": [
{
"name": "debug",
"description": "Debug level (optional, default 1)",
"description": "Debug level (0 for binary, \u003e0 for text)",
"in": "query",
"required": false,
"type": "integer",
Expand All @@ -103,14 +113,14 @@
]
}
},
"/api/v1/debug/pprof/goroutine": {
"/api/v1/debug/raw/pprof/cmdline": {
"get": {
"operationId": "SupernodeService_GetPprofGoroutine",
"operationId": "SupernodeService_GetRawPprofCmdline",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/supernodeGetPprofProfileResponse"
"$ref": "#/definitions/supernodeRawPprofResponse"
}
},
"default": {
Expand All @@ -123,7 +133,7 @@
"parameters": [
{
"name": "debug",
"description": "Debug level (optional, default 1)",
"description": "Debug level (0 for binary, \u003e0 for text)",
"in": "query",
"required": false,
"type": "integer",
Expand All @@ -135,14 +145,14 @@
]
}
},
"/api/v1/debug/pprof/heap": {
"/api/v1/debug/raw/pprof/goroutine": {
"get": {
"operationId": "SupernodeService_GetPprofHeap",
"operationId": "SupernodeService_GetRawPprofGoroutine",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/supernodeGetPprofProfileResponse"
"$ref": "#/definitions/supernodeRawPprofResponse"
}
},
"default": {
Expand All @@ -155,7 +165,7 @@
"parameters": [
{
"name": "debug",
"description": "Debug level (optional, default 1)",
"description": "Debug level (0 for binary, \u003e0 for text)",
"in": "query",
"required": false,
"type": "integer",
Expand All @@ -167,14 +177,14 @@
]
}
},
"/api/v1/debug/pprof/mutex": {
"/api/v1/debug/raw/pprof/heap": {
"get": {
"operationId": "SupernodeService_GetPprofMutex",
"operationId": "SupernodeService_GetRawPprofHeap",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/supernodeGetPprofProfileResponse"
"$ref": "#/definitions/supernodeRawPprofResponse"
}
},
"default": {
Expand All @@ -187,7 +197,7 @@
"parameters": [
{
"name": "debug",
"description": "Debug level (optional, default 1)",
"description": "Debug level (0 for binary, \u003e0 for text)",
"in": "query",
"required": false,
"type": "integer",
Expand All @@ -199,14 +209,46 @@
]
}
},
"/api/v1/debug/pprof/profile": {
"/api/v1/debug/raw/pprof/mutex": {
"get": {
"operationId": "SupernodeService_GetPprofProfile",
"operationId": "SupernodeService_GetRawPprofMutex",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/supernodeGetPprofProfileResponse"
"$ref": "#/definitions/supernodeRawPprofResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/rpcStatus"
}
}
},
"parameters": [
{
"name": "debug",
"description": "Debug level (0 for binary, \u003e0 for text)",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"tags": [
"SupernodeService"
]
}
},
"/api/v1/debug/raw/pprof/profile": {
"get": {
"operationId": "SupernodeService_GetRawPprofProfile",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/supernodeRawPprofResponse"
}
},
"default": {
Expand All @@ -219,7 +261,7 @@
"parameters": [
{
"name": "seconds",
"description": "Duration in seconds (optional, default 30)",
"description": "CPU profile duration in seconds (default 30)",
"in": "query",
"required": false,
"type": "integer",
Expand All @@ -231,14 +273,14 @@
]
}
},
"/api/v1/debug/pprof/threadcreate": {
"/api/v1/debug/raw/pprof/symbol": {
"get": {
"operationId": "SupernodeService_GetPprofThreadcreate",
"operationId": "SupernodeService_GetRawPprofSymbol",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/supernodeGetPprofProfileResponse"
"$ref": "#/definitions/supernodeRawPprofResponse"
}
},
"default": {
Expand All @@ -251,7 +293,71 @@
"parameters": [
{
"name": "debug",
"description": "Debug level (optional, default 1)",
"description": "Debug level (0 for binary, \u003e0 for text)",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"tags": [
"SupernodeService"
]
}
},
"/api/v1/debug/raw/pprof/threadcreate": {
"get": {
"operationId": "SupernodeService_GetRawPprofThreadcreate",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/supernodeRawPprofResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/rpcStatus"
}
}
},
"parameters": [
{
"name": "debug",
"description": "Debug level (0 for binary, \u003e0 for text)",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"tags": [
"SupernodeService"
]
}
},
"/api/v1/debug/raw/pprof/trace": {
"get": {
"operationId": "SupernodeService_GetRawPprofTrace",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/supernodeRawPprofResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/rpcStatus"
}
}
},
"parameters": [
{
"name": "debug",
"description": "Debug level (0 for binary, \u003e0 for text)",
"in": "query",
"required": false,
"type": "integer",
Expand Down Expand Up @@ -666,41 +772,6 @@
}
}
},
"supernodeGetPprofIndexResponse": {
"type": "object",
"properties": {
"html": {
"type": "string",
"title": "HTML content for the pprof index page"
},
"enabled": {
"type": "boolean",
"title": "Whether profiling is enabled"
}
}
},
"supernodeGetPprofProfileResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"format": "byte",
"title": "Profile data (binary pprof format)"
},
"contentType": {
"type": "string",
"title": "Content type of the response"
},
"enabled": {
"type": "boolean",
"title": "Whether profiling is enabled"
},
"error": {
"type": "string",
"title": "Error message if profiling is disabled"
}
}
},
"supernodeListServicesResponse": {
"type": "object",
"properties": {
Expand All @@ -717,6 +788,16 @@
}
}
},
"supernodeRawPprofResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"format": "byte",
"title": "Raw pprof data exactly as returned by runtime/pprof"
}
}
},
"supernodeServiceInfo": {
"type": "object",
"properties": {
Expand Down
Loading
Loading