Skip to content

Commit a3c8b60

Browse files
temblekingtembleking
authored
feat: add troubleshoot_kubernetes_list_top_memory_consumed_by_container (#46)
1 parent 72af9d5 commit a3c8b60

File tree

5 files changed

+212
-0
lines changed

5 files changed

+212
-0
lines changed

‎AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ The handler filters tools dynamically based on `GetMyPermissions` from Sysdig Se
6464
| `troubleshoot_kubernetes_list_top_cpu_consumed_by_workload` | `tool_troubleshoot_kubernetes_list_top_cpu_consumed_by_workload.go` | Identifies the Kubernetes workloads (all containers) consuming the most CPU (in cores). | `promql.exec` | "Show the top 10 workloads consuming the most CPU in cluster 'production'" |
6565
| `troubleshoot_kubernetes_list_top_cpu_consumed_by_container` | `tool_troubleshoot_kubernetes_list_top_cpu_consumed_by_container.go` | Identifies the Kubernetes containers consuming the most CPU (in cores). | `promql.exec` | "Show the top 10 containers consuming the most CPU in cluster 'production'" |
6666
| `troubleshoot_kubernetes_list_top_memory_consumed_by_workload` | `tool_troubleshoot_kubernetes_list_top_memory_consumed_by_workload.go` | Lists memory-intensive workloads (all containers). | `promql.exec` | "Show the top 10 workloads consuming the most memory in cluster 'production'" |
67+
| `troubleshoot_kubernetes_list_top_memory_consumed_by_container` | `tool_troubleshoot_kubernetes_list_top_memory_consumed_by_container.go` | Lists memory-intensive containers. | `promql.exec` | "Show the top 10 containers consuming the most memory in cluster 'production'" |
6768

6869
Every tool has a companion `_test.go` file that exercises request validation, permission metadata, and Sysdig client calls through mocks.
6970
Note that if you add more tools you need to also update this file to reflect that.

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,11 @@ The server dynamically filters the available tools based on the permissions asso
183183
- **Required Permission**: `promql.exec`
184184
- **Sample Prompt**: "Show the top 10 workloads consuming the most memory in cluster 'production'"
185185

186+
- **`troubleshoot_kubernetes_list_top_memory_consumed_by_container`**
187+
- **Description**: Lists memory-intensive containers.
188+
- **Required Permission**: `promql.exec`
189+
- **Sample Prompt**: "Show the top 10 containers consuming the most memory in cluster 'production'"
190+
186191
## Requirements
187192
- [Go](https://go.dev/doc/install) 1.25 or higher (if running without Docker).
188193

‎cmd/server/main.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@ func setupHandler(sysdigClient sysdig.ExtendedClientWithResponsesInterface) *mcp
110110
tools.NewTroubleshootKubernetesListTopCPUConsumedByContainer(sysdigClient),
111111
tools.NewTroubleshootKubernetesListUnderutilizedPodsByMemoryQuota(sysdigClient),
112112
tools.NewTroubleshootKubernetesListTopMemoryConsumedByWorkload(sysdigClient),
113+
tools.NewTroubleshootKubernetesListTopMemoryConsumedByContainer(sysdigClient),
113114
)
114115
return handler
115116
}

‎internal/infra/mcp/tools/tool_troubleshoot_kubernetes_list_top_memory_consumed_by_container.go‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
package tools
2+
3+
import (
4+
"context"
5+
"encoding/json"
6+
"fmt"
7+
"io"
8+
"strings"
9+
10+
"github.com/mark3labs/mcp-go/mcp"
11+
"github.com/mark3labs/mcp-go/server"
12+
"github.com/sysdiglabs/sysdig-mcp-server/internal/infra/sysdig"
13+
)
14+
15+
type TroubleshootKubernetesListTopMemoryConsumedByContainer struct {
16+
SysdigClient sysdig.ExtendedClientWithResponsesInterface
17+
}
18+
19+
func NewTroubleshootKubernetesListTopMemoryConsumedByContainer(sysdigClient sysdig.ExtendedClientWithResponsesInterface) *TroubleshootKubernetesListTopMemoryConsumedByContainer {
20+
return &TroubleshootKubernetesListTopMemoryConsumedByContainer{
21+
SysdigClient: sysdigClient,
22+
}
23+
}
24+
25+
func (t *TroubleshootKubernetesListTopMemoryConsumedByContainer) RegisterInServer(s *server.MCPServer) {
26+
tool := mcp.NewTool("troubleshoot_kubernetes_list_top_memory_consumed_by_container",
27+
mcp.WithDescription("Lists memory-intensive containers."),
28+
mcp.WithString("cluster_name", mcp.Description("The name of the cluster to filter by.")),
29+
mcp.WithString("namespace_name", mcp.Description("The name of the namespace to filter by.")),
30+
mcp.WithString("workload_type", mcp.Description("The type of the workload to filter by.")),
31+
mcp.WithString("workload_name", mcp.Description("The name of the workload to filter by.")),
32+
mcp.WithNumber("limit",
33+
mcp.Description("Maximum number of containers to return."),
34+
mcp.DefaultNumber(20),
35+
),
36+
mcp.WithOutputSchema[map[string]any](),
37+
WithRequiredPermissions(), // FIXME(fede): Add the required permissions. It should be `promql.exec` but somehow the token does not have that permission even if you are able to execute queries.
38+
)
39+
s.AddTool(tool, t.handle)
40+
}
41+
42+
func (t *TroubleshootKubernetesListTopMemoryConsumedByContainer) handle(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
43+
clusterName := mcp.ParseString(request, "cluster_name", "")
44+
namespaceName := mcp.ParseString(request, "namespace_name", "")
45+
workloadType := mcp.ParseString(request, "workload_type", "")
46+
workloadName := mcp.ParseString(request, "workload_name", "")
47+
limit := mcp.ParseInt(request, "limit", 20)
48+
49+
query := buildTopMemoryConsumedByContainerQuery(clusterName, namespaceName, workloadType, workloadName, limit)
50+
51+
limitQuery := sysdig.LimitQuery(limit)
52+
params := &sysdig.GetQueryV1Params{
53+
Query: query,
54+
Limit: &limitQuery,
55+
}
56+
57+
httpResp, err := t.SysdigClient.GetQueryV1(ctx, params)
58+
if err != nil {
59+
return mcp.NewToolResultErrorFromErr("failed to get container list", err), nil
60+
}
61+
62+
if httpResp.StatusCode != 200 {
63+
bodyBytes, _ := io.ReadAll(httpResp.Body)
64+
return mcp.NewToolResultErrorf("failed to get container list: status code %d, body: %s", httpResp.StatusCode, string(bodyBytes)), nil
65+
}
66+
67+
var queryResponse sysdig.QueryResponseV1
68+
if err := json.NewDecoder(httpResp.Body).Decode(&queryResponse); err != nil {
69+
return mcp.NewToolResultErrorFromErr("failed to decode response", err), nil
70+
}
71+
72+
return mcp.NewToolResultJSON(queryResponse)
73+
}
74+
75+
func buildTopMemoryConsumedByContainerQuery(clusterName, namespaceName, workloadType, workloadName string, limit int) string {
76+
filters := []string{}
77+
if clusterName != "" {
78+
filters = append(filters, fmt.Sprintf(`kube_cluster_name="%s"`, clusterName))
79+
}
80+
if namespaceName != "" {
81+
filters = append(filters, fmt.Sprintf(`kube_namespace_name="%s"`, namespaceName))
82+
}
83+
if workloadType != "" {
84+
filters = append(filters, fmt.Sprintf(`kube_workload_type="%s"`, workloadType))
85+
}
86+
if workloadName != "" {
87+
filters = append(filters, fmt.Sprintf(`kube_workload_name="%s"`, workloadName))
88+
}
89+
90+
filterString := ""
91+
if len(filters) > 0 {
92+
filterString = "{" + strings.Join(filters, ", ") + "}"
93+
}
94+
95+
return fmt.Sprintf(`topk(%d, sum by (kube_cluster_name, kube_namespace_name, kube_workload_type, kube_workload_name, container_label_io_kubernetes_container_name) (sysdig_container_memory_used_bytes%s))`, limit, filterString)
96+
}

‎internal/infra/mcp/tools/tool_troubleshoot_kubernetes_list_top_memory_consumed_by_container_test.go‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
package tools_test
2+
3+
import (
4+
"bytes"
5+
"context"
6+
"io"
7+
"net/http"
8+
9+
"github.com/mark3labs/mcp-go/mcp"
10+
"github.com/mark3labs/mcp-go/server"
11+
. "github.com/onsi/ginkgo/v2"
12+
. "github.com/onsi/gomega"
13+
"github.com/sysdiglabs/sysdig-mcp-server/internal/infra/mcp/tools"
14+
"github.com/sysdiglabs/sysdig-mcp-server/internal/infra/sysdig"
15+
"github.com/sysdiglabs/sysdig-mcp-server/internal/infra/sysdig/mocks"
16+
"go.uber.org/mock/gomock"
17+
)
18+
19+
var _ = Describe("TroubleshootKubernetesListTopMemoryConsumedByContainer Tool", func() {
20+
var (
21+
tool *tools.TroubleshootKubernetesListTopMemoryConsumedByContainer
22+
mockSysdig *mocks.MockExtendedClientWithResponsesInterface
23+
mcpServer *server.MCPServer
24+
ctrl *gomock.Controller
25+
)
26+
27+
BeforeEach(func() {
28+
ctrl = gomock.NewController(GinkgoT())
29+
mockSysdig = mocks.NewMockExtendedClientWithResponsesInterface(ctrl)
30+
tool = tools.NewTroubleshootKubernetesListTopMemoryConsumedByContainer(mockSysdig)
31+
mcpServer = server.NewMCPServer("test", "test")
32+
tool.RegisterInServer(mcpServer)
33+
})
34+
35+
It("should register successfully in the server", func() {
36+
Expect(mcpServer.GetTool("troubleshoot_kubernetes_list_top_memory_consumed_by_container")).NotTo(BeNil())
37+
})
38+
39+
When("listing top memory consumed by container", func() {
40+
DescribeTable("it succeeds", func(ctx context.Context, toolName string, request mcp.CallToolRequest, expectedParamsRequested sysdig.GetQueryV1Params) {
41+
mockSysdig.EXPECT().GetQueryV1(gomock.Any(), &expectedParamsRequested).Return(&http.Response{
42+
StatusCode: http.StatusOK,
43+
Body: io.NopCloser(bytes.NewBufferString(`{"status":"success"}`)),
44+
}, nil)
45+
46+
serverTool := mcpServer.GetTool(toolName)
47+
result, err := serverTool.Handler(ctx, request)
48+
Expect(err).NotTo(HaveOccurred())
49+
50+
resultData, ok := result.Content[0].(mcp.TextContent)
51+
Expect(ok).To(BeTrue())
52+
Expect(resultData.Text).To(MatchJSON(`{"status":"success"}`))
53+
},
54+
Entry(nil,
55+
"troubleshoot_kubernetes_list_top_memory_consumed_by_container",
56+
mcp.CallToolRequest{
57+
Params: mcp.CallToolParams{
58+
Name: "troubleshoot_kubernetes_list_top_memory_consumed_by_container",
59+
Arguments: map[string]any{},
60+
},
61+
},
62+
sysdig.GetQueryV1Params{
63+
Query: `topk(20, sum by (kube_cluster_name, kube_namespace_name, kube_workload_type, kube_workload_name, container_label_io_kubernetes_container_name) (sysdig_container_memory_used_bytes))`,
64+
Limit: toPtr(sysdig.LimitQuery(20)),
65+
},
66+
),
67+
Entry(nil,
68+
"troubleshoot_kubernetes_list_top_memory_consumed_by_container",
69+
mcp.CallToolRequest{
70+
Params: mcp.CallToolParams{
71+
Name: "troubleshoot_kubernetes_list_top_memory_consumed_by_container",
72+
Arguments: map[string]any{
73+
"cluster_name": "prod",
74+
"namespace_name": "default",
75+
"limit": 10,
76+
},
77+
},
78+
},
79+
sysdig.GetQueryV1Params{
80+
Query: `topk(10, sum by (kube_cluster_name, kube_namespace_name, kube_workload_type, kube_workload_name, container_label_io_kubernetes_container_name) (sysdig_container_memory_used_bytes{kube_cluster_name="prod", kube_namespace_name="default"}))`,
81+
Limit: toPtr(sysdig.LimitQuery(10)),
82+
},
83+
),
84+
Entry(nil,
85+
"troubleshoot_kubernetes_list_top_memory_consumed_by_container",
86+
mcp.CallToolRequest{
87+
Params: mcp.CallToolParams{
88+
Name: "troubleshoot_kubernetes_list_top_memory_consumed_by_container",
89+
Arguments: map[string]any{
90+
"cluster_name": "prod",
91+
"namespace_name": "default",
92+
"workload_name": "api",
93+
"workload_type": "deployment",
94+
"limit": 5,
95+
},
96+
},
97+
},
98+
sysdig.GetQueryV1Params{
99+
Query: `topk(5, sum by (kube_cluster_name, kube_namespace_name, kube_workload_type, kube_workload_name, container_label_io_kubernetes_container_name) (sysdig_container_memory_used_bytes{kube_cluster_name="prod", kube_namespace_name="default", kube_workload_type="deployment", kube_workload_name="api"}))`,
100+
Limit: toPtr(sysdig.LimitQuery(5)),
101+
},
102+
),
103+
)
104+
})
105+
})
106+
107+
func toPtr[T any](v T) *T {
108+
return &v
109+
}

0 commit comments

Comments
 (0)