costmodelenv.go 22 KB

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