costmodelenv.go 23 KB

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