如何定位Rancher指定API对应函数并设置断点调试？

一、定位API对应的处理函数 #

1. 从代码结构入手查找 #

Rancher的v3 API基于自研Norman框架构建，项目级资源（如projects下的deployments）的处理逻辑集中在这些区域：

• 路由注册逻辑：查看pkg/api/server/router目录，搜索含projects和deployments的路由注册文件（如project_router.go），这里定义了路径与处理函数的映射关系。
• 项目资源代理处理：该API本质是将Kubernetes的Deployment资源纳入Rancher项目上下文管理，核心逻辑在pkg/api/handler/projectresource目录下，负责将项目ID（如local:p-4ldrc）映射为K8s命名空间，同时处理权限校验、请求转发到K8s API的流程。
• 代码生成的控制器：Rancher通过代码生成工具生成API控制器，Deployment对应的生成代码位于pkg/generated/norman/apps/v1目录，其中deployment.go包含基础的CRUD处理函数。

2. 精准搜索定位 #

• 直接在源码中搜索路径片段：执行grep -r "/v3/projects.*deployments"命令，找到路由定义位置后，追踪到对应的handler函数。
• 搜索资源标签：查找带有// +kubebuilder:resource:path=deployments,scope=Namespaced标签的结构体定义（通常在pkg/apis/apps/v1或pkg/apis/project.cattle.io/v3目录），对应的处理函数会与该结构体关联。

二、调试该API的方法 #

1. 开启调试日志 #

启动Rancher时添加--debug参数，日志会输出每个API请求的详细调用信息，包括：

• 请求对应的处理函数全路径
• 完整调用栈
• 权限校验、参数解析过程
  通过日志可直接定位到处理该请求的函数位置。

2. 使用Go调试工具（Delve） #

若本地编译Rancher源码，可通过Delve启动调试：

1. 编译时保留调试信息：go build -gcflags="all=-N -l"
2. 启动Delve：dlv exec ./rancher -- --debug
3. 在API入口函数（如pkg/api/server/server.go中的Serve方法）设置断点，发送API请求后跟踪调用栈，逐步定位到目标API的处理逻辑。

3. 临时添加日志验证 #

在疑似处理该API的函数中添加临时日志（如klog.Infof("Handling deployment request for project: %s", projectID)），重新编译启动Rancher后，发送请求查看日志，确认是否命中目标函数。

内容的提问来源于stack exchange，提问作者Muz