costmodelenv.go 25 KB

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