costmodelenv.go 23 KB

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