costmodel.go 14 KB

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