costmodelenv.go 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719
  1. package env
  2. import (
  3. "fmt"
  4. "time"
  5. "github.com/opencost/opencost/core/pkg/env"
  6. "github.com/opencost/opencost/core/pkg/log"
  7. "github.com/opencost/opencost/core/pkg/util/timeutil"
  8. )
  9. const (
  10. APIPortEnvVar = "API_PORT"
  11. AWSAccessKeyIDEnvVar = "AWS_ACCESS_KEY_ID"
  12. AWSAccessKeySecretEnvVar = "AWS_SECRET_ACCESS_KEY"
  13. AWSClusterIDEnvVar = "AWS_CLUSTER_ID"
  14. AWSPricingURL = "AWS_PRICING_URL"
  15. AlibabaAccessKeyIDEnvVar = "ALIBABA_ACCESS_KEY_ID"
  16. AlibabaAccessKeySecretEnvVar = "ALIBABA_SECRET_ACCESS_KEY"
  17. AzureOfferIDEnvVar = "AZURE_OFFER_ID"
  18. AzureBillingAccountEnvVar = "AZURE_BILLING_ACCOUNT"
  19. AzureDownloadBillingDataToDiskEnvVar = "AZURE_DOWNLOAD_BILLING_DATA_TO_DISK"
  20. KubecostNamespaceEnvVar = "KUBECOST_NAMESPACE"
  21. KubecostScrapeIntervalEnvVar = "KUBECOST_SCRAPE_INTERVAL"
  22. PodNameEnvVar = "POD_NAME"
  23. ClusterIDEnvVar = "CLUSTER_ID"
  24. ClusterProfileEnvVar = "CLUSTER_PROFILE"
  25. PrometheusServerEndpointEnvVar = "PROMETHEUS_SERVER_ENDPOINT"
  26. MaxQueryConcurrencyEnvVar = "MAX_QUERY_CONCURRENCY"
  27. QueryLoggingFileEnvVar = "QUERY_LOGGING_FILE"
  28. RemoteEnabledEnvVar = "REMOTE_WRITE_ENABLED"
  29. RemotePWEnvVar = "REMOTE_WRITE_PASSWORD"
  30. SQLAddressEnvVar = "SQL_ADDRESS"
  31. UseCSVProviderEnvVar = "USE_CSV_PROVIDER"
  32. UseCustomProviderEnvVar = "USE_CUSTOM_PROVIDER"
  33. CSVRegionEnvVar = "CSV_REGION"
  34. CSVEndpointEnvVar = "CSV_ENDPOINT"
  35. CSVPathEnvVar = "CSV_PATH"
  36. ConfigPathEnvVar = "CONFIG_PATH"
  37. CloudProviderAPIKeyEnvVar = "CLOUD_PROVIDER_API_KEY"
  38. DisableAggregateCostModelCache = "DISABLE_AGGREGATE_COST_MODEL_CACHE"
  39. EmitPodAnnotationsMetricEnvVar = "EMIT_POD_ANNOTATIONS_METRIC"
  40. EmitNamespaceAnnotationsMetricEnvVar = "EMIT_NAMESPACE_ANNOTATIONS_METRIC"
  41. EmitDeprecatedMetrics = "EMIT_DEPRECATED_METRICS"
  42. EmitKsmV1MetricsEnvVar = "EMIT_KSM_V1_METRICS"
  43. EmitKsmV1MetricsOnly = "EMIT_KSM_V1_METRICS_ONLY"
  44. ThanosEnabledEnvVar = "THANOS_ENABLED"
  45. ThanosQueryUrlEnvVar = "THANOS_QUERY_URL"
  46. ThanosOffsetEnvVar = "THANOS_QUERY_OFFSET"
  47. ThanosMaxSourceResEnvVar = "THANOS_MAX_SOURCE_RESOLUTION"
  48. PProfEnabledEnvVar = "PPROF_ENABLED"
  49. LogCollectionEnabledEnvVar = "LOG_COLLECTION_ENABLED"
  50. ProductAnalyticsEnabledEnvVar = "PRODUCT_ANALYTICS_ENABLED"
  51. ErrorReportingEnabledEnvVar = "ERROR_REPORTING_ENABLED"
  52. ValuesReportingEnabledEnvVar = "VALUES_REPORTING_ENABLED"
  53. DBBasicAuthUsername = "DB_BASIC_AUTH_USERNAME"
  54. DBBasicAuthPassword = "DB_BASIC_AUTH_PW"
  55. DBBearerToken = "DB_BEARER_TOKEN"
  56. MultiClusterBasicAuthUsername = "MC_BASIC_AUTH_USERNAME"
  57. MultiClusterBasicAuthPassword = "MC_BASIC_AUTH_PW"
  58. MultiClusterBearerToken = "MC_BEARER_TOKEN"
  59. InsecureSkipVerify = "INSECURE_SKIP_VERIFY"
  60. KubeConfigPathEnvVar = "KUBECONFIG_PATH"
  61. UTCOffsetEnvVar = "UTC_OFFSET"
  62. CurrentClusterIdFilterEnabledVar = "CURRENT_CLUSTER_ID_FILTER_ENABLED"
  63. CacheWarmingEnabledEnvVar = "CACHE_WARMING_ENABLED"
  64. ETLEnabledEnvVar = "ETL_ENABLED"
  65. ETLMaxPrometheusQueryDurationMinutes = "ETL_MAX_PROMETHEUS_QUERY_DURATION_MINUTES"
  66. ETLResolutionSeconds = "ETL_RESOLUTION_SECONDS"
  67. LegacyExternalAPIDisabledVar = "LEGACY_EXTERNAL_API_DISABLED"
  68. PromClusterIDLabelEnvVar = "PROM_CLUSTER_ID_LABEL"
  69. PricingConfigmapName = "PRICING_CONFIGMAP_NAME"
  70. MetricsConfigmapName = "METRICS_CONFIGMAP_NAME"
  71. KubecostJobNameEnvVar = "KUBECOST_JOB_NAME"
  72. KubecostConfigBucketEnvVar = "KUBECOST_CONFIG_BUCKET"
  73. ClusterInfoFileEnabledEnvVar = "CLUSTER_INFO_FILE_ENABLED"
  74. ClusterCacheFileEnabledEnvVar = "CLUSTER_CACHE_FILE_ENABLED"
  75. PrometheusQueryOffsetEnvVar = "PROMETHEUS_QUERY_OFFSET"
  76. PrometheusRetryOnRateLimitResponseEnvVar = "PROMETHEUS_RETRY_ON_RATE_LIMIT"
  77. PrometheusRetryOnRateLimitMaxRetriesEnvVar = "PROMETHEUS_RETRY_ON_RATE_LIMIT_MAX_RETRIES"
  78. PrometheusRetryOnRateLimitDefaultWaitEnvVar = "PROMETHEUS_RETRY_ON_RATE_LIMIT_DEFAULT_WAIT"
  79. PrometheusHeaderXScopeOrgIdEnvVar = "PROMETHEUS_HEADER_X_SCOPE_ORGID"
  80. IngestPodUIDEnvVar = "INGEST_POD_UID"
  81. ETLReadOnlyMode = "ETL_READ_ONLY"
  82. AllocationNodeLabelsEnabled = "ALLOCATION_NODE_LABELS_ENABLED"
  83. AllocationNodeLabelsIncludeList = "ALLOCATION_NODE_LABELS_INCLUDE_LIST"
  84. regionOverrideList = "REGION_OVERRIDE_LIST"
  85. ExportCSVFile = "EXPORT_CSV_FILE"
  86. ExportCSVLabelsList = "EXPORT_CSV_LABELS_LIST"
  87. ExportCSVLabelsAll = "EXPORT_CSV_LABELS_ALL"
  88. ExportCSVMaxDays = "EXPORT_CSV_MAX_DAYS"
  89. DataRetentionDailyResolutionDaysEnvVar = "DATA_RETENTION_DAILY_RESOLUTION_DAYS"
  90. DataRetentionHourlyResolutionHoursEnvVar = "DATA_RETENTION_HOURLY_RESOLUTION_HOURS"
  91. // We assume that Kubernetes is enabled if there is a KUBERNETES_PORT environment variable present
  92. KubernetesEnabledEnvVar = "KUBERNETES_PORT"
  93. CloudCostEnabledEnvVar = "CLOUD_COST_ENABLED"
  94. CloudCostConfigPath = "CLOUD_COST_CONFIG_PATH"
  95. CloudCostMonthToDateIntervalVar = "CLOUD_COST_MONTH_TO_DATE_INTERVAL"
  96. CloudCostRefreshRateHoursEnvVar = "CLOUD_COST_REFRESH_RATE_HOURS"
  97. CloudCostQueryWindowDaysEnvVar = "CLOUD_COST_QUERY_WINDOW_DAYS"
  98. CloudCostRunWindowDaysEnvVar = "CLOUD_COST_RUN_WINDOW_DAYS"
  99. CustomCostEnabledEnvVar = "CUSTOM_COST_ENABLED"
  100. CustomCostQueryWindowDaysEnvVar = "CUSTOM_COST_QUERY_WINDOW_DAYS"
  101. CustomCostRefreshRateHoursEnvVar = "CUSTOM_COST_REFRESH_RATE_HOURS"
  102. PluginConfigDirEnvVar = "PLUGIN_CONFIG_DIR"
  103. PluginExecutableDirEnvVar = "PLUGIN_EXECUTABLE_DIR"
  104. OCIPricingURL = "OCI_PRICING_URL"
  105. CarbonEstimatesEnabledEnvVar = "CARBON_ESTIMATES_ENABLED"
  106. )
  107. const DefaultConfigMountPath = "/var/configs"
  108. func IsETLReadOnlyMode() bool {
  109. return env.GetBool(ETLReadOnlyMode, false)
  110. }
  111. func GetExportCSVFile() string {
  112. return env.Get(ExportCSVFile, "")
  113. }
  114. func GetExportCSVLabelsAll() bool {
  115. return env.GetBool(ExportCSVLabelsAll, false)
  116. }
  117. func GetKubecostScrapeInterval() time.Duration {
  118. return env.GetDuration(KubecostScrapeIntervalEnvVar, 0)
  119. }
  120. func GetExportCSVLabelsList() []string {
  121. return env.GetList(ExportCSVLabelsList, ",")
  122. }
  123. func IsPProfEnabled() bool {
  124. return env.GetBool(PProfEnabledEnvVar, false)
  125. }
  126. func GetExportCSVMaxDays() int {
  127. return env.GetInt(ExportCSVMaxDays, 90)
  128. }
  129. // GetAPIPort returns the environment variable value for APIPortEnvVar which
  130. // is the port number the API is available on.
  131. func GetAPIPort() int {
  132. return env.GetInt(APIPortEnvVar, 9003)
  133. }
  134. // GetKubecostConfigBucket returns a file location for a mounted bucket configuration which is used to store
  135. // a subset of kubecost configurations that require sharing via remote storage.
  136. func GetKubecostConfigBucket() string {
  137. return env.Get(KubecostConfigBucketEnvVar, "")
  138. }
  139. // IsClusterInfoFileEnabled returns true if the cluster info is read from a file or pulled from the local
  140. // cloud provider and kubernetes.
  141. func IsClusterInfoFileEnabled() bool {
  142. return env.GetBool(ClusterInfoFileEnabledEnvVar, false)
  143. }
  144. // IsClusterCacheFileEnabled returns true if the kubernetes cluster data is read from a file or pulled from the local
  145. // kubernetes API.
  146. func IsClusterCacheFileEnabled() bool {
  147. return env.GetBool(ClusterCacheFileEnabledEnvVar, false)
  148. }
  149. // IsPrometheusRetryOnRateLimitResponse will attempt to retry if a 429 response is received OR a 400 with a body containing
  150. // ThrottleException (common in AWS services like AMP)
  151. func IsPrometheusRetryOnRateLimitResponse() bool {
  152. return env.GetBool(PrometheusRetryOnRateLimitResponseEnvVar, true)
  153. }
  154. // GetPrometheusRetryOnRateLimitMaxRetries returns the maximum number of retries that should be attempted prior to failing.
  155. // Only used if IsPrometheusRetryOnRateLimitResponse() is true.
  156. func GetPrometheusRetryOnRateLimitMaxRetries() int {
  157. return env.GetInt(PrometheusRetryOnRateLimitMaxRetriesEnvVar, 5)
  158. }
  159. // GetPrometheusRetryOnRateLimitDefaultWait returns the default wait time for a retriable rate limit response without a
  160. // Retry-After header.
  161. func GetPrometheusRetryOnRateLimitDefaultWait() time.Duration {
  162. return env.GetDuration(PrometheusRetryOnRateLimitDefaultWaitEnvVar, 100*time.Millisecond)
  163. }
  164. // GetPrometheusHeaderXScopeOrgId returns the default value for X-Scope-OrgID header used for requests in Mimir/Cortex-Tenant API.
  165. // To use Mimir(or Cortex-Tenant) instead of Prometheus add variable from cluster settings:
  166. // "PROMETHEUS_HEADER_X_SCOPE_ORGID": "my-cluster-name"
  167. // Then set Prometheus URL to prometheus API endpoint:
  168. // "PROMETHEUS_SERVER_ENDPOINT": "http://mimir-url/prometheus/"
  169. func GetPrometheusHeaderXScopeOrgId() string {
  170. return env.Get(PrometheusHeaderXScopeOrgIdEnvVar, "")
  171. }
  172. // GetPrometheusQueryOffset returns the time.Duration to offset all prometheus queries by. NOTE: This env var is applied
  173. // to all non-range queries made via our query context. This should only be applied when there is a significant delay in
  174. // data arriving in the target prom db. For example, if supplying a thanos or cortex querier for the prometheus server, using
  175. // a 3h offset will ensure that current time = current time - 3h.
  176. //
  177. // This offset is NOT the same as the GetThanosOffset() option, as that is only applied to queries made specifically targeting
  178. // thanos. This offset is applied globally.
  179. func GetPrometheusQueryOffset() time.Duration {
  180. offset := env.Get(PrometheusQueryOffsetEnvVar, "")
  181. if offset == "" {
  182. return 0
  183. }
  184. dur, err := timeutil.ParseDuration(offset)
  185. if err != nil {
  186. return 0
  187. }
  188. return dur
  189. }
  190. func GetPricingConfigmapName() string {
  191. return env.Get(PricingConfigmapName, "pricing-configs")
  192. }
  193. func GetMetricsConfigmapName() string {
  194. return env.Get(MetricsConfigmapName, "metrics-config")
  195. }
  196. // IsEmitNamespaceAnnotationsMetric returns true if cost-model is configured to emit the kube_namespace_annotations metric
  197. // containing the namespace annotations
  198. func IsEmitNamespaceAnnotationsMetric() bool {
  199. return env.GetBool(EmitNamespaceAnnotationsMetricEnvVar, false)
  200. }
  201. // IsEmitPodAnnotationsMetric returns true if cost-model is configured to emit the kube_pod_annotations metric containing
  202. // pod annotations.
  203. func IsEmitPodAnnotationsMetric() bool {
  204. return env.GetBool(EmitPodAnnotationsMetricEnvVar, false)
  205. }
  206. // IsEmitKsmV1Metrics returns true if cost-model is configured to emit all necessary KSM v1
  207. // metrics that were removed in KSM v2
  208. func IsEmitKsmV1Metrics() bool {
  209. return env.GetBool(EmitKsmV1MetricsEnvVar, true)
  210. }
  211. func IsEmitKsmV1MetricsOnly() bool {
  212. return env.GetBool(EmitKsmV1MetricsOnly, false)
  213. }
  214. func IsEmitDeprecatedMetrics() bool {
  215. return env.GetBool(EmitDeprecatedMetrics, false)
  216. }
  217. // GetAWSAccessKeyID returns the environment variable value for AWSAccessKeyIDEnvVar which represents
  218. // the AWS access key for authentication
  219. func GetAWSAccessKeyID() string {
  220. awsAccessKeyID := env.Get(AWSAccessKeyIDEnvVar, "")
  221. // If the sample nil service key name is set, zero it out so that it is not
  222. // misinterpreted as a real service key.
  223. if awsAccessKeyID == "AKIXXX" {
  224. awsAccessKeyID = ""
  225. }
  226. return awsAccessKeyID
  227. }
  228. // GetAWSAccessKeySecret returns the environment variable value for AWSAccessKeySecretEnvVar which represents
  229. // the AWS access key secret for authentication
  230. func GetAWSAccessKeySecret() string {
  231. return env.Get(AWSAccessKeySecretEnvVar, "")
  232. }
  233. // GetAWSClusterID returns the environment variable value for AWSClusterIDEnvVar which represents
  234. // an AWS specific cluster identifier.
  235. func GetAWSClusterID() string {
  236. return env.Get(AWSClusterIDEnvVar, "")
  237. }
  238. // GetAWSPricingURL returns an optional alternative URL to fetch AWS pricing data from; for use in airgapped environments
  239. func GetAWSPricingURL() string {
  240. return env.Get(AWSPricingURL, "")
  241. }
  242. // GetAlibabaAccessKeyID returns the environment variable value for AlibabaAccessKeyIDEnvVar which represents
  243. // the Alibaba access key for authentication
  244. func GetAlibabaAccessKeyID() string {
  245. return env.Get(AlibabaAccessKeyIDEnvVar, "")
  246. }
  247. // GetAlibabaAccessKeySecret returns the environment variable value for AlibabaAccessKeySecretEnvVar which represents
  248. // the Alibaba access key secret for authentication
  249. func GetAlibabaAccessKeySecret() string {
  250. return env.Get(AlibabaAccessKeySecretEnvVar, "")
  251. }
  252. // GetAzureOfferID returns the environment variable value for AzureOfferIDEnvVar which represents
  253. // the Azure offer ID for determining prices.
  254. func GetAzureOfferID() string {
  255. return env.Get(AzureOfferIDEnvVar, "")
  256. }
  257. // GetAzureBillingAccount returns the environment variable value for
  258. // AzureBillingAccountEnvVar which represents the Azure billing
  259. // account for determining prices. If this is specified
  260. // customer-specific prices will be downloaded from the consumption
  261. // price sheet API.
  262. func GetAzureBillingAccount() string {
  263. return env.Get(AzureBillingAccountEnvVar, "")
  264. }
  265. // IsAzureDownloadBillingDataToDisk returns the environment variable value for
  266. // AzureDownloadBillingDataToDiskEnvVar which indicates whether the Azure
  267. // Billing Data should be held in memory or written to disk.
  268. func IsAzureDownloadBillingDataToDisk() bool {
  269. return env.GetBool(AzureDownloadBillingDataToDiskEnvVar, true)
  270. }
  271. // GetKubecostNamespace returns the environment variable value for KubecostNamespaceEnvVar which
  272. // represents the namespace the cost model exists in.
  273. func GetKubecostNamespace() string {
  274. return env.Get(KubecostNamespaceEnvVar, "kubecost")
  275. }
  276. // GetPodName returns the name of the current running pod. If this environment variable is not set,
  277. // empty string is returned.
  278. func GetPodName() string {
  279. return env.Get(PodNameEnvVar, "")
  280. }
  281. // GetClusterProfile returns the environment variable value for ClusterProfileEnvVar which
  282. // represents the cluster profile configured for
  283. func GetClusterProfile() string {
  284. return env.Get(ClusterProfileEnvVar, "development")
  285. }
  286. // GetClusterID returns the environment variable value for ClusterIDEnvVar which represents the
  287. // configurable identifier used for multi-cluster metric emission.
  288. func GetClusterID() string {
  289. return env.Get(ClusterIDEnvVar, "")
  290. }
  291. // GetPromClusterFilter returns environment variable value CurrentClusterIdFilterEnabledVar which
  292. // represents additional prometheus filter for all metrics for current cluster id
  293. func GetPromClusterFilter() string {
  294. if env.GetBool(CurrentClusterIdFilterEnabledVar, false) {
  295. return fmt.Sprintf("%s=\"%s\"", GetPromClusterLabel(), GetClusterID())
  296. }
  297. return ""
  298. }
  299. // GetPrometheusServerEndpoint returns the environment variable value for PrometheusServerEndpointEnvVar which
  300. // represents the prometheus server endpoint used to execute prometheus queries.
  301. func GetPrometheusServerEndpoint() string {
  302. return env.Get(PrometheusServerEndpointEnvVar, "")
  303. }
  304. func GetInsecureSkipVerify() bool {
  305. return env.GetBool(InsecureSkipVerify, false)
  306. }
  307. // IsAggregateCostModelCacheDisabled returns the environment variable value for DisableAggregateCostModelCache which
  308. // will inform the aggregator on whether to load cached data. Defaults to false
  309. func IsAggregateCostModelCacheDisabled() bool {
  310. return env.GetBool(DisableAggregateCostModelCache, false)
  311. }
  312. // IsRemoteEnabled returns the environment variable value for RemoteEnabledEnvVar which represents whether
  313. // or not remote write is enabled for prometheus for use with SQL backed persistent storage.
  314. func IsRemoteEnabled() bool {
  315. return env.GetBool(RemoteEnabledEnvVar, false)
  316. }
  317. // GetRemotePW returns the environment variable value for RemotePWEnvVar which represents the remote
  318. // persistent storage password.
  319. func GetRemotePW() string {
  320. return env.Get(RemotePWEnvVar, "")
  321. }
  322. // GetSQLAddress returns the environment variable value for SQLAddressEnvVar which represents the SQL
  323. // database address used with remote persistent storage.
  324. func GetSQLAddress() string {
  325. return env.Get(SQLAddressEnvVar, "")
  326. }
  327. // IsUseCSVProvider returns the environment variable value for UseCSVProviderEnvVar which represents
  328. // whether or not the use of a CSV cost provider is enabled.
  329. func IsUseCSVProvider() bool {
  330. return env.GetBool(UseCSVProviderEnvVar, false)
  331. }
  332. // IsUseCustomProvider returns the environment variable value for UseCustomProviderEnvVar which represents
  333. // whether or not the use of a custom cost provider is enabled.
  334. func IsUseCustomProvider() bool {
  335. return env.GetBool(UseCustomProviderEnvVar, false)
  336. }
  337. // GetCSVRegion returns the environment variable value for CSVRegionEnvVar which represents the
  338. // region configured for a CSV provider.
  339. func GetCSVRegion() string {
  340. return env.Get(CSVRegionEnvVar, "")
  341. }
  342. // GetCSVEndpoint returns the environment variable value for CSVEndpointEnvVar which represents the
  343. // endpoint configured for a S3 CSV provider another than AWS S3.
  344. func GetCSVEndpoint() string {
  345. return env.Get(CSVEndpointEnvVar, "")
  346. }
  347. // GetCSVPath returns the environment variable value for CSVPathEnvVar which represents the key path
  348. // configured for a CSV provider.
  349. func GetCSVPath() string {
  350. return env.Get(CSVPathEnvVar, "")
  351. }
  352. // GetCostAnalyzerVolumeMountPath is an alias of GetConfigPath, which returns the mount path for the
  353. // Cost Analyzer volume, which stores configs, persistent data, etc.
  354. func GetCostAnalyzerVolumeMountPath() string {
  355. return GetConfigPathWithDefault(DefaultConfigMountPath)
  356. }
  357. // GetConfigPath returns the environment variable value for ConfigPathEnvVar which represents the cost
  358. // model configuration path
  359. func GetConfigPathWithDefault(defaultValue string) string {
  360. return env.Get(ConfigPathEnvVar, defaultValue)
  361. }
  362. // GetCloudProviderAPI returns the environment variable value for CloudProviderAPIEnvVar which represents
  363. // the API key provided for the cloud provider.
  364. func GetCloudProviderAPIKey() string {
  365. return env.Get(CloudProviderAPIKeyEnvVar, "")
  366. }
  367. // IsThanosEnabled returns the environment variable value for ThanosEnabledEnvVar which represents whether
  368. // or not thanos is enabled.
  369. func IsThanosEnabled() bool {
  370. return env.GetBool(ThanosEnabledEnvVar, false)
  371. }
  372. // GetThanosQueryUrl returns the environment variable value for ThanosQueryUrlEnvVar which represents the
  373. // target query endpoint for hitting thanos.
  374. func GetThanosQueryUrl() string {
  375. return env.Get(ThanosQueryUrlEnvVar, "")
  376. }
  377. // GetThanosOffset returns the environment variable value for ThanosOffsetEnvVar which represents the total
  378. // amount of time to offset all queries made to thanos.
  379. func GetThanosOffset() string {
  380. return env.Get(ThanosOffsetEnvVar, "3h")
  381. }
  382. // GetThanosMaxSourceResolution returns the environment variable value for ThanosMaxSourceResEnvVar which represents
  383. // the max source resolution to use when querying thanos.
  384. func GetThanosMaxSourceResolution() string {
  385. res := env.Get(ThanosMaxSourceResEnvVar, "raw")
  386. switch res {
  387. case "raw":
  388. return "0s"
  389. case "0s":
  390. fallthrough
  391. case "5m":
  392. fallthrough
  393. case "1h":
  394. return res
  395. default:
  396. return "0s"
  397. }
  398. }
  399. // IsLogCollectionEnabled returns the environment variable value for LogCollectionEnabledEnvVar which represents
  400. // whether or not log collection has been enabled for kubecost deployments.
  401. func IsLogCollectionEnabled() bool {
  402. return env.GetBool(LogCollectionEnabledEnvVar, true)
  403. }
  404. // IsProductAnalyticsEnabled returns the environment variable value for ProductAnalyticsEnabledEnvVar
  405. func IsProductAnalyticsEnabled() bool {
  406. return env.GetBool(ProductAnalyticsEnabledEnvVar, true)
  407. }
  408. // IsErrorReportingEnabled returns the environment variable value for ErrorReportingEnabledEnvVar
  409. func IsErrorReportingEnabled() bool {
  410. return env.GetBool(ErrorReportingEnabledEnvVar, true)
  411. }
  412. // IsValuesReportingEnabled returns the environment variable value for ValuesReportingEnabledEnvVar
  413. func IsValuesReportingEnabled() bool {
  414. return env.GetBool(ValuesReportingEnabledEnvVar, true)
  415. }
  416. // GetMaxQueryConcurrency returns the environment variable value for MaxQueryConcurrencyEnvVar
  417. func GetMaxQueryConcurrency() int {
  418. return env.GetInt(MaxQueryConcurrencyEnvVar, 5)
  419. }
  420. // GetQueryLoggingFile returns a file location if query logging is enabled. Otherwise, empty string
  421. func GetQueryLoggingFile() string {
  422. return env.Get(QueryLoggingFileEnvVar, "")
  423. }
  424. func GetDBBasicAuthUsername() string {
  425. return env.Get(DBBasicAuthUsername, "")
  426. }
  427. func GetDBBasicAuthUserPassword() string {
  428. return env.Get(DBBasicAuthPassword, "")
  429. }
  430. func GetDBBearerToken() string {
  431. return env.Get(DBBearerToken, "")
  432. }
  433. // GetMultiClusterBasicAuthUsername returns the environment variable value for MultiClusterBasicAuthUsername
  434. func GetMultiClusterBasicAuthUsername() string {
  435. return env.Get(MultiClusterBasicAuthUsername, "")
  436. }
  437. // GetMultiClusterBasicAuthPassword returns the environment variable value for MultiClusterBasicAuthPassword
  438. func GetMultiClusterBasicAuthPassword() string {
  439. return env.Get(MultiClusterBasicAuthPassword, "")
  440. }
  441. func GetMultiClusterBearerToken() string {
  442. return env.Get(MultiClusterBearerToken, "")
  443. }
  444. // GetKubeConfigPath returns the environment variable value for KubeConfigPathEnvVar
  445. func GetKubeConfigPath() string {
  446. return env.Get(KubeConfigPathEnvVar, "")
  447. }
  448. // GetUTCOffset returns the environment variable value for UTCOffset
  449. func GetUTCOffset() string {
  450. return env.Get(UTCOffsetEnvVar, "")
  451. }
  452. // GetParsedUTCOffset returns the duration of the configured UTC offset
  453. func GetParsedUTCOffset() time.Duration {
  454. offset, err := timeutil.ParseUTCOffset(GetUTCOffset())
  455. if err != nil {
  456. log.Warnf("Failed to parse UTC offset: %s", err)
  457. return time.Duration(0)
  458. }
  459. return offset
  460. }
  461. // GetKubecostJobName returns the environment variable value for KubecostJobNameEnvVar
  462. func GetKubecostJobName() string {
  463. return env.Get(KubecostJobNameEnvVar, "kubecost")
  464. }
  465. func IsCacheWarmingEnabled() bool {
  466. return env.GetBool(CacheWarmingEnabledEnvVar, true)
  467. }
  468. func IsETLEnabled() bool {
  469. return env.GetBool(ETLEnabledEnvVar, true)
  470. }
  471. func GetETLMaxPrometheusQueryDuration() time.Duration {
  472. dayMins := 60 * 24
  473. mins := time.Duration(env.GetInt64(ETLMaxPrometheusQueryDurationMinutes, int64(dayMins)))
  474. return mins * time.Minute
  475. }
  476. // GetETLResolution determines the resolution of ETL queries. The smaller the
  477. // duration, the higher the resolution; the higher the resolution, the more
  478. // accurate the query results, but the more computationally expensive.
  479. func GetETLResolution() time.Duration {
  480. // Use the configured ETL resolution, or default to
  481. // 5m (i.e. 300s)
  482. secs := time.Duration(env.GetInt64(ETLResolutionSeconds, 300))
  483. return secs * time.Second
  484. }
  485. func LegacyExternalCostsAPIDisabled() bool {
  486. return env.GetBool(LegacyExternalAPIDisabledVar, false)
  487. }
  488. // GetPromClusterLabel returns the environment variable value for PromClusterIDLabel
  489. func GetPromClusterLabel() string {
  490. return env.Get(PromClusterIDLabelEnvVar, "cluster_id")
  491. }
  492. // IsIngestingPodUID returns the env variable from ingestPodUID, which alters the
  493. // contents of podKeys in Allocation
  494. func IsIngestingPodUID() bool {
  495. return env.GetBool(IngestPodUIDEnvVar, false)
  496. }
  497. func GetAllocationNodeLabelsEnabled() bool {
  498. return env.GetBool(AllocationNodeLabelsEnabled, true)
  499. }
  500. var defaultAllocationNodeLabelsIncludeList []string = []string{
  501. "cloud.google.com/gke-nodepool",
  502. "eks.amazonaws.com/nodegroup",
  503. "kubernetes.azure.com/agentpool",
  504. "node.kubernetes.io/instance-type",
  505. "topology.kubernetes.io/region",
  506. "topology.kubernetes.io/zone",
  507. }
  508. func GetAllocationNodeLabelsIncludeList() []string {
  509. // If node labels are not enabled, return an empty list.
  510. if !GetAllocationNodeLabelsEnabled() {
  511. return []string{}
  512. }
  513. list := env.GetList(AllocationNodeLabelsIncludeList, ",")
  514. // If node labels are enabled, but the white list is empty, use defaults.
  515. if len(list) == 0 {
  516. return defaultAllocationNodeLabelsIncludeList
  517. }
  518. return list
  519. }
  520. func GetRegionOverrideList() []string {
  521. regionList := env.GetList(regionOverrideList, ",")
  522. if regionList == nil {
  523. return []string{}
  524. }
  525. return regionList
  526. }
  527. func GetDataRetentionDailyResolutionDays() int64 {
  528. return env.GetInt64(DataRetentionDailyResolutionDaysEnvVar, 30)
  529. }
  530. func GetDataRetentionHourlyResolutionHours() int64 {
  531. return env.GetInt64(DataRetentionHourlyResolutionHoursEnvVar, 49)
  532. }
  533. func IsKubernetesEnabled() bool {
  534. return env.Get(KubernetesEnabledEnvVar, "") != ""
  535. }
  536. func IsCloudCostEnabled() bool {
  537. return env.GetBool(CloudCostEnabledEnvVar, false)
  538. }
  539. func IsCustomCostEnabled() bool {
  540. return env.GetBool(CustomCostEnabledEnvVar, false)
  541. }
  542. func GetCloudCostConfigPath() string {
  543. return env.Get(CloudCostConfigPath, "cloud-integration.json")
  544. }
  545. func GetCloudCostMonthToDateInterval() int {
  546. return env.GetInt(CloudCostMonthToDateIntervalVar, 6)
  547. }
  548. func GetCloudCostRefreshRateHours() int64 {
  549. return env.GetInt64(CloudCostRefreshRateHoursEnvVar, 6)
  550. }
  551. func GetCloudCostQueryWindowDays() int64 {
  552. return env.GetInt64(CloudCostQueryWindowDaysEnvVar, 7)
  553. }
  554. func GetCustomCostQueryWindowHours() int64 {
  555. return env.GetInt64(CustomCostQueryWindowDaysEnvVar, 1)
  556. }
  557. func GetCustomCostQueryWindowDays() int64 {
  558. return env.GetInt64(CustomCostQueryWindowDaysEnvVar, 7)
  559. }
  560. func GetCloudCostRunWindowDays() int64 {
  561. return env.GetInt64(CloudCostRunWindowDaysEnvVar, 3)
  562. }
  563. func GetOCIPricingURL() string {
  564. return env.Get(OCIPricingURL, "https://apexapps.oracle.com/pls/apex/cetools/api/v1/products")
  565. }
  566. func GetPluginConfigDir() string {
  567. return env.Get(PluginConfigDirEnvVar, "/opt/opencost/plugin/config")
  568. }
  569. func GetPluginExecutableDir() string {
  570. return env.Get(PluginExecutableDirEnvVar, "/opt/opencost/plugin/bin")
  571. }
  572. func GetCustomCostRefreshRateHours() string {
  573. return env.Get(CustomCostRefreshRateHoursEnvVar, "12h")
  574. }
  575. func IsCarbonEstimatesEnabled() bool {
  576. return env.GetBool(CarbonEstimatesEnabledEnvVar, false)
  577. }