costmodelenv.go 26 KB

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