costmodelenv.go 22 KB

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