regna
April 6, 2024, 5:34am
1
If Grafana is open-source, then where is the list of environment variables?
GitHub repo
I tried searching the entire repo and org for a single environment variable (e.g. GF_SERVER_DOMAIN), but it never appears in the source code. Is this closed-source?
That list of env variables doesn’t exist in the source code, because source code tries to map env variable into config option.
E. g.
GF_SERVER_DOMAIN=x
is mapped into config option:
[server]
domain = x
So check default config and you will know which env variables you can use:
##################### Grafana Configuration Defaults #####################
#
# Do not modify this file in grafana installs
#
# possible values : production, development
app_mode = production
# instance name, defaults to HOSTNAME environment variable value or hostname if HOSTNAME var is empty
instance_name = ${HOSTNAME}
#################################### Paths ###############################
[paths]
# Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used)
data = data
# Temporary files in `data` directory older than given duration will be removed
temp_data_lifetime = 24h
# Directory where grafana can store logs
show original
1 Like
regna
April 6, 2024, 3:49pm
3
Thank you, @jangaraj
But do you know where is the code that transforms GF_SERVER_DOMAIN into [server] domain?
No, there is no name of any env variable hardcoded.
It is just clever code - e.g. read default config and then try to find for each config option if there is env variable for that - if it is there, then override default value:
func (cfg *Cfg) applyEnvVariableOverrides(file *ini.File) error {
cfg.appliedEnvOverrides = make([]string, 0)
for _, section := range file.Sections() {
for _, key := range section.Keys() {
envKey := EnvKey(section.Name(), key.Name())
envValue := os.Getenv(envKey)
if len(envValue) > 0 {
key.SetValue(envValue)
cfg.appliedEnvOverrides = append(cfg.appliedEnvOverrides, fmt.Sprintf("%s=%s", envKey, RedactedValue(envKey, envValue)))
}
}
}
return nil
}
2 Likes
regna
April 7, 2024, 3:07am
5
Thanks so much, @jangaraj !
