Configuration (settings.hcl)

To create a template for the settings.hcl file

The settings.hcl file is generated during the installation process.

If required, run instana settings template to create a settings.hcl file with default (empty) values.

Default configuration

The values for the following parameters are populated during the installation.

type      = "single"
profile   = "normal"
tenant    = "<Your-tenancy-identifier>"
unit      = "<Your-backend-identifier>"
agent_key = "<Your-agent-key>"
sales_key = "<Your-sales-key>"
host_name = "<The-hostname-of-the-machine-the-backend-is-installed-on>"
cert {
  crt     = "<Path-to-your-signed-certificate>"
  key     = "<Path-to-your-private-key-file>"
}

Data directories

Instana defaults to the following directory structures.

dir {
  metrics  = "/mnt/metrics"
  traces   = "/mnt/traces"
  data     = "/mnt/data"
  logs     = "/var/log/instana"
}
Directory Description Type
Metrics The parent directory of where Cassandra creates its data directory. We recommend to put this on a high IO device on it’s own disks (/mnt/metrics). string
Traces The parent directory of where Clickhouse creates its data directory. We recommend to put this on a high IO device on it’s own disks (/mnt/traces). string
Data The parent directory of where Instana and third party components store data. string
Logs The parent directory of where all the components in our stack create log files. string

Data retention

The following data retention parameters are calculated during the installation. A value of zero tells the system to not drop rollups of this time span. A zero value for smaller rollups can cause the disks to quickly fill up.

retention {
  rollup5     = "86400"
  rollup60    = "2678400"
  rollup300   = "8035200"
  rollup3600  = "0"
  short_term_in_days  = "7"
}
Retention Description Type
rollup5 Duration (in seconds) that 5-second-rollups are available. int
rollup60 Duration (in seconds) that 1-minute-rollups are available. int
rollup300 Duration (in seconds) that 5-minute-rollups are available. int
rollup3600 Duration (in seconds) that 1-hour-rollups are available. int
short_term_in_days Days of retention for all data. Change is effective only on new data (apart from website and mobile apps which are affected immediately). int

Notifications server settings

email {
  token_secret = "Ju~B_JK]O=U1"  

  smtp {
    from      = "notif@acmecorp.com"
    host      = "relay-1.acme.internal"      
    port      = "25"             
    user      = "ops-notif@acmecorp.com"        
    password  = "yUnoEm41l"        
    use_ssl   = "true"          
    start_tls = "false"          
  }
}
Parameter Description Type
token_secret 12 character string used as a hash to generate links used by our notification emails. string
from Sender email address from our notification emails. string
host SMTP server address or hostname that sends our notification emails. string
port Port of the SMTP server that sends our notification emails. int
user Username for the SMTP server that sends our notification emails. string
password Password for the SMTP server that sends our notification emails. string
use_ssl Indicates whether the SMTP server that sends our notification emails is spoken to via SSL. bool
start_tls Indicates whether the SMTP server that sends our notification emails is spoken to via SSL. bool

Proxy settings

proxy {
  host     = "10.9.4.13"    
  port     = "8080"         
  user     = "anonymous"    
  password = "P4ssword1234"
}
Parameter Description Type
host If your backend server communicates with the cluster-external internet via a proxy server, this is either the address or hostname. string
port Port for the proxy server to speak to. int
user Username for the proxy server. int
password Password for the proxy server. string

OAuth settings

o_auth {
  client_id     = "123456-1n574n4adgjlmnop.apps.googleusercontent.com"
  client_secret = "XNLV-fpf_deadBeEf1234"      
}
Parameter Description Type
client_id Client ID for the Google oauth credential. string
client_secret Client secret password for the Google oauth credential. string