costmodel.go 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411
  1. package costmodel
  2. import (
  3. "context"
  4. "fmt"
  5. "net/http"
  6. "os"
  7. "os/signal"
  8. "syscall"
  9. "time"
  10. "github.com/julienschmidt/httprouter"
  11. "github.com/opencost/opencost/core/pkg/util/apiutil"
  12. "github.com/opencost/opencost/pkg/cloudcost"
  13. "github.com/opencost/opencost/pkg/customcost"
  14. "github.com/prometheus/client_golang/prometheus/promhttp"
  15. "github.com/rs/cors"
  16. mcp_sdk "github.com/modelcontextprotocol/go-sdk/mcp"
  17. "github.com/opencost/opencost/core/pkg/errors"
  18. "github.com/opencost/opencost/core/pkg/log"
  19. "github.com/opencost/opencost/core/pkg/version"
  20. "github.com/opencost/opencost/pkg/costmodel"
  21. "github.com/opencost/opencost/pkg/env"
  22. "github.com/opencost/opencost/pkg/filemanager"
  23. opencost_mcp "github.com/opencost/opencost/pkg/mcp"
  24. "github.com/opencost/opencost/pkg/metrics"
  25. )
  26. const shutdownTimeout = 30 * time.Second
  27. func Execute(conf *Config) error {
  28. log.Infof("Starting cost-model version %s", version.FriendlyVersion())
  29. if conf == nil {
  30. conf = DefaultConfig()
  31. }
  32. conf.log()
  33. // Create cancellable context for graceful shutdown
  34. ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
  35. defer cancel()
  36. router := httprouter.New()
  37. var a *costmodel.Accesses
  38. if conf.KubernetesEnabled {
  39. a = costmodel.Initialize(router)
  40. err := StartExportWorker(context.Background(), a.Model)
  41. if err != nil {
  42. log.Errorf("couldn't start CSV export worker: %v", err)
  43. }
  44. // Register OpenCost Specific Endpoints
  45. router.GET("/allocation", a.ComputeAllocationHandler)
  46. router.GET("/allocation/summary", a.ComputeAllocationHandlerSummary)
  47. router.GET("/assets", a.ComputeAssetsHandler)
  48. if conf.CarbonEstimatesEnabled {
  49. router.GET("/assets/carbon", a.ComputeAssetsCarbonHandler)
  50. }
  51. }
  52. var cloudCostPipelineService *cloudcost.PipelineService
  53. if conf.CloudCostEnabled {
  54. cloudCostPipelineService = costmodel.InitializeCloudCost(router)
  55. }
  56. var customCostPipelineService *customcost.PipelineService
  57. if conf.CustomCostEnabled {
  58. customCostPipelineService = costmodel.InitializeCustomCost(router)
  59. }
  60. // this endpoint is intentionally left out of the "if env.IsCustomCostEnabled()" conditional; in the handler, it is
  61. // valid for CustomCostPipelineService to be nil
  62. router.GET("/customCost/status", customCostPipelineService.GetCustomCostStatusHandler())
  63. // Initialize MCP Server if enabled and Kubernetes is available
  64. if conf.MCPServerEnabled && a != nil {
  65. // Get cloud cost querier if cloud costs are enabled
  66. var cloudCostQuerier cloudcost.Querier
  67. if conf.CloudCostEnabled && cloudCostPipelineService != nil {
  68. cloudCostQuerier = cloudCostPipelineService.GetCloudCostQuerier()
  69. }
  70. err := StartMCPServer(ctx, a, cloudCostQuerier)
  71. if err != nil {
  72. log.Errorf("Failed to start MCP server: %v", err)
  73. }
  74. } else if conf.MCPServerEnabled {
  75. log.Warnf("MCP Server is enabled but Kubernetes is not available. MCP server requires Kubernetes to function.")
  76. } else {
  77. if value, exists := os.LookupEnv(env.MCPServerEnabledEnvVar); !exists || value == "" {
  78. log.Infof("MCP server is now disabled by default. If you wish to use the MCP server, please set the %s environment variable to true.", env.MCPServerEnabledEnvVar)
  79. }
  80. }
  81. apiutil.ApplyContainerDiagnosticEndpoints(router)
  82. rootMux := http.NewServeMux()
  83. rootMux.Handle("/", router)
  84. rootMux.Handle("/metrics", promhttp.Handler())
  85. telemetryHandler := metrics.ResponseMetricMiddleware(rootMux)
  86. handler := cors.AllowAll().Handler(telemetryHandler)
  87. server := &http.Server{
  88. Addr: fmt.Sprint(":", conf.Port),
  89. Handler: errors.PanicHandlerMiddleware(handler),
  90. }
  91. serverErrors := make(chan error, 1)
  92. go func() {
  93. log.Infof("HTTP server starting on port %d", conf.Port)
  94. serverErrors <- server.ListenAndServe()
  95. }()
  96. select {
  97. case err := <-serverErrors:
  98. if err != nil && err != http.ErrServerClosed {
  99. return err
  100. }
  101. return nil
  102. case <-ctx.Done():
  103. log.Infof("Shutdown signal received, starting graceful shutdown...")
  104. if customCostPipelineService != nil {
  105. customCostPipelineService.Stop()
  106. }
  107. shutdownCtx, shutdownCancel := context.WithTimeout(context.Background(), shutdownTimeout)
  108. defer shutdownCancel()
  109. if err := server.Shutdown(shutdownCtx); err != nil {
  110. log.Errorf("Error during server shutdown: %v", err)
  111. server.Close()
  112. return err
  113. }
  114. log.Infof("Graceful shutdown completed")
  115. return nil
  116. }
  117. }
  118. func StartExportWorker(ctx context.Context, model costmodel.AllocationModel) error {
  119. exportPath := env.GetExportCSVFile()
  120. if exportPath == "" {
  121. log.Infof("%s is not set, CSV export is disabled", env.ExportCSVFile)
  122. return nil
  123. }
  124. fm, err := filemanager.NewFileManager(exportPath)
  125. if err != nil {
  126. return fmt.Errorf("could not create file manager: %v", err)
  127. }
  128. go func() {
  129. log.Info("Starting CSV exporter worker...")
  130. // perform first update immediately
  131. nextRunAt := time.Now()
  132. for {
  133. select {
  134. case <-ctx.Done():
  135. return
  136. case <-time.After(time.Until(nextRunAt)):
  137. err := costmodel.UpdateCSV(ctx, fm, model, env.GetExportCSVLabelsAll(), env.GetExportCSVLabelsList())
  138. if err != nil {
  139. // it's background worker, log error and carry on, maybe next time it will work
  140. log.Errorf("Error updating CSV: %s", err)
  141. }
  142. now := time.Now().UTC()
  143. // next launch is at 00:10 UTC tomorrow
  144. // extra 10 minutes is to let prometheus to collect all the data for the previous day
  145. nextRunAt = time.Date(now.Year(), now.Month(), now.Day(), 0, 10, 0, 0, now.Location()).AddDate(0, 0, 1)
  146. }
  147. }
  148. }()
  149. return nil
  150. }
  151. // StartMCPServer starts the MCP server as a background service
  152. func StartMCPServer(ctx context.Context, accesses *costmodel.Accesses, cloudCostQuerier cloudcost.Querier) error {
  153. log.Info("Initializing MCP server...")
  154. // Create MCP server using existing OpenCost dependencies
  155. mcpServer := opencost_mcp.NewMCPServer(accesses.Model, accesses.CloudProvider, cloudCostQuerier)
  156. // Create MCP SDK server
  157. sdkServer := mcp_sdk.NewServer(&mcp_sdk.Implementation{
  158. Name: "opencost-mcp-server",
  159. Version: version.Version,
  160. }, nil)
  161. // Define tool handlers
  162. handleAllocationCosts := func(ctx context.Context, req *mcp_sdk.CallToolRequest, args AllocationArgs) (*mcp_sdk.CallToolResult, interface{}, error) {
  163. // Parse step duration if provided
  164. var step time.Duration
  165. var err error
  166. if args.Step != "" {
  167. step, err = time.ParseDuration(args.Step)
  168. if err != nil {
  169. return nil, nil, fmt.Errorf("invalid step duration '%s': %w", args.Step, err)
  170. }
  171. }
  172. queryRequest := &opencost_mcp.OpenCostQueryRequest{
  173. QueryType: opencost_mcp.AllocationQueryType,
  174. Window: args.Window,
  175. AllocationParams: &opencost_mcp.AllocationQuery{
  176. Step: step,
  177. Accumulate: args.Accumulate,
  178. ShareIdle: args.ShareIdle,
  179. Aggregate: args.Aggregate,
  180. IncludeIdle: args.IncludeIdle,
  181. IdleByNode: args.IdleByNode,
  182. IncludeProportionalAssetResourceCosts: args.IncludeProportionalAssetResourceCosts,
  183. IncludeAggregatedMetadata: args.IncludeAggregatedMetadata,
  184. ShareLB: args.ShareLB,
  185. Filter: args.Filter,
  186. },
  187. }
  188. mcpReq := &opencost_mcp.MCPRequest{
  189. Query: queryRequest,
  190. }
  191. mcpResp, err := mcpServer.ProcessMCPRequest(ctx, mcpReq)
  192. if err != nil {
  193. return nil, nil, fmt.Errorf("failed to process allocation request: %w", err)
  194. }
  195. return nil, mcpResp, nil
  196. }
  197. handleAssetCosts := func(ctx context.Context, req *mcp_sdk.CallToolRequest, args AssetArgs) (*mcp_sdk.CallToolResult, interface{}, error) {
  198. queryRequest := &opencost_mcp.OpenCostQueryRequest{
  199. QueryType: opencost_mcp.AssetQueryType,
  200. Window: args.Window,
  201. AssetParams: &opencost_mcp.AssetQuery{},
  202. }
  203. mcpReq := &opencost_mcp.MCPRequest{
  204. Query: queryRequest,
  205. }
  206. mcpResp, err := mcpServer.ProcessMCPRequest(ctx, mcpReq)
  207. if err != nil {
  208. return nil, nil, fmt.Errorf("failed to process asset request: %w", err)
  209. }
  210. return nil, mcpResp, nil
  211. }
  212. handleCloudCosts := func(ctx context.Context, req *mcp_sdk.CallToolRequest, args CloudCostArgs) (*mcp_sdk.CallToolResult, interface{}, error) {
  213. queryRequest := &opencost_mcp.OpenCostQueryRequest{
  214. QueryType: opencost_mcp.CloudCostQueryType,
  215. Window: args.Window,
  216. CloudCostParams: &opencost_mcp.CloudCostQuery{
  217. Aggregate: args.Aggregate,
  218. Accumulate: args.Accumulate,
  219. Filter: args.Filter,
  220. Provider: args.Provider,
  221. Service: args.Service,
  222. Category: args.Category,
  223. Region: args.Region,
  224. AccountID: args.Account,
  225. },
  226. }
  227. mcpReq := &opencost_mcp.MCPRequest{
  228. Query: queryRequest,
  229. }
  230. mcpResp, err := mcpServer.ProcessMCPRequest(ctx, mcpReq)
  231. if err != nil {
  232. return nil, nil, fmt.Errorf("failed to process cloud cost request: %w", err)
  233. }
  234. return nil, mcpResp, nil
  235. }
  236. handleEfficiency := func(ctx context.Context, req *mcp_sdk.CallToolRequest, args EfficiencyArgs) (*mcp_sdk.CallToolResult, interface{}, error) {
  237. queryRequest := &opencost_mcp.OpenCostQueryRequest{
  238. QueryType: opencost_mcp.EfficiencyQueryType,
  239. Window: args.Window,
  240. EfficiencyParams: &opencost_mcp.EfficiencyQuery{
  241. Aggregate: args.Aggregate,
  242. Filter: args.Filter,
  243. EfficiencyBufferMultiplier: args.BufferMultiplier,
  244. },
  245. }
  246. mcpReq := &opencost_mcp.MCPRequest{
  247. Query: queryRequest,
  248. }
  249. mcpResp, err := mcpServer.ProcessMCPRequest(ctx, mcpReq)
  250. if err != nil {
  251. return nil, nil, fmt.Errorf("failed to process efficiency request: %w", err)
  252. }
  253. return nil, mcpResp, nil
  254. }
  255. // Register tools
  256. mcp_sdk.AddTool(sdkServer, &mcp_sdk.Tool{
  257. Name: "get_allocation_costs",
  258. Description: "Retrieves allocation cost data.",
  259. }, handleAllocationCosts)
  260. mcp_sdk.AddTool(sdkServer, &mcp_sdk.Tool{
  261. Name: "get_asset_costs",
  262. Description: "Retrieves asset cost data.",
  263. }, handleAssetCosts)
  264. mcp_sdk.AddTool(sdkServer, &mcp_sdk.Tool{
  265. Name: "get_cloud_costs",
  266. Description: "Retrieves cloud cost data.",
  267. }, handleCloudCosts)
  268. mcp_sdk.AddTool(sdkServer, &mcp_sdk.Tool{
  269. Name: "get_efficiency",
  270. Description: "Retrieves resource efficiency metrics with rightsizing recommendations and cost savings analysis. Computes CPU and memory efficiency (usage/request ratio), provides recommended resource requests, and calculates potential cost savings. Optional buffer_multiplier parameter (default: 1.2 for 20% headroom) can be set to values like 1.4 for 40% headroom.",
  271. }, handleEfficiency)
  272. // Create HTTP handler
  273. handler := mcp_sdk.NewStreamableHTTPHandler(func(r *http.Request) *mcp_sdk.Server {
  274. return sdkServer
  275. }, &mcp_sdk.StreamableHTTPOptions{
  276. JSONResponse: true,
  277. })
  278. // Add logging middleware
  279. loggingHandler := http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
  280. log.Debugf("MCP HTTP request: %s %s from %s", req.Method, req.URL.Path, req.RemoteAddr)
  281. handler.ServeHTTP(w, req)
  282. })
  283. // Start HTTP server on configured port
  284. port := env.GetMCPHTTPPort()
  285. log.Infof("Starting MCP HTTP server on port %d...", port)
  286. server := &http.Server{
  287. Addr: fmt.Sprintf(":%d", port),
  288. Handler: loggingHandler,
  289. }
  290. // Start server in a goroutine
  291. go func() {
  292. if err := server.ListenAndServe(); err != nil && err != http.ErrServerClosed {
  293. log.Errorf("MCP server failed: %v", err)
  294. }
  295. }()
  296. // Graceful shutdown goroutine
  297. go func() {
  298. <-ctx.Done()
  299. log.Info("Shutting down MCP server...")
  300. shutdownCtx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
  301. defer cancel()
  302. if err := server.Shutdown(shutdownCtx); err != nil {
  303. log.Errorf("MCP server shutdown error: %v", err)
  304. } else {
  305. log.Info("MCP server shut down successfully")
  306. }
  307. }()
  308. log.Info("MCP server started successfully")
  309. return nil
  310. }
  311. // Tool argument structures for MCP server
  312. type AllocationArgs struct {
  313. Window string `json:"window"`
  314. Aggregate string `json:"aggregate"`
  315. // Allocation query parameters
  316. Step string `json:"step,omitempty"`
  317. Resolution string `json:"resolution,omitempty"`
  318. Accumulate bool `json:"accumulate,omitempty"`
  319. ShareIdle bool `json:"share_idle,omitempty"`
  320. IncludeIdle bool `json:"include_idle,omitempty"`
  321. IdleByNode bool `json:"idle_by_node,omitempty"`
  322. IncludeProportionalAssetResourceCosts bool `json:"include_proportional_asset_resource_costs,omitempty"`
  323. IncludeAggregatedMetadata bool `json:"include_aggregated_metadata,omitempty"`
  324. ShareLB bool `json:"share_lb,omitempty"`
  325. Filter string `json:"filter,omitempty"`
  326. }
  327. type AssetArgs struct {
  328. Window string `json:"window"`
  329. }
  330. type CloudCostArgs struct {
  331. Window string `json:"window"`
  332. Aggregate string `json:"aggregate"`
  333. // Cloud cost query parameters
  334. Accumulate string `json:"accumulate,omitempty"`
  335. Filter string `json:"filter,omitempty"`
  336. Provider string `json:"provider,omitempty"`
  337. Service string `json:"service,omitempty"`
  338. Category string `json:"category,omitempty"`
  339. Region string `json:"region,omitempty"`
  340. Account string `json:"account,omitempty"`
  341. }
  342. type EfficiencyArgs struct {
  343. Window string `json:"window"` // Time window (e.g., "today", "yesterday", "7d", "lastweek")
  344. Aggregate string `json:"aggregate,omitempty"` // Aggregation level (e.g., "pod", "namespace", "controller")
  345. Filter string `json:"filter,omitempty"` // Filter expression (same as allocation filters)
  346. BufferMultiplier *float64 `json:"buffer_multiplier,omitempty"` // Buffer multiplier for recommendations (default: 1.2 for 20% headroom, e.g., 1.4 for 40%)
  347. }