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>"
token_secret = "<max_12_digits>"

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"
}

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"
  app_data_short_term  = "7"
}

Notifications Server Settings

email {

  smtp {
    from      = "[email protected]"
    host      = "relay-1.acme.internal"      
    port      = "25"             
    user      = "[email protected]"        
    password  = "yUnoEm41l"        
    use_ssl   = "true"          
    start_tls = "false"          
  }
}

Proxy Settings

proxy {
  host     = "10.9.4.13"    
  port     = "8080"         
  user     = "anonymous"    
  password = "P4ssword1234"
}

Docker repository settings

docker_repository {
  base_url = "my.mirror.internal/v2/containers.instana.io"
  username = "user"
  password = "pass"
}

OAuth settings

o_auth {
  client_id     = "123456-1n574n4adgjlmnop.apps.googleusercontent.com"
  client_secret = "XNLV-fpf_deadBeEf1234"      
}

End-User Monitoring (EUM) settings

eum {
  tracking_base_url     = "https://mobile.acmecorp.com/eum/"  
}

Generating REST API clients

The URL to the local open API specification is https://{onpremhost}/docs/openapi (since on-prem release 170). For detailed information on how to configure rest API clients, see our Web REST API docs.

Enabling audit logging

To configure an audit logger that logs each login to the Instana system. The following config toggle must be activated at root level in settings.hcl. Then the system must be updated by instana update -f /path/to/settings.hcl. The new log file can be found under the following path in the log directory /instana/butler/audit.log.

toggle "config.audit.log.level" {
  value = "info"
} 

Replacing existing certificates

To replace existing certificates with other certificates, in the settings.hcl file update paths to your certificate files. Then the system must be updated by instana update -f /path/to/settings.hcl.

cert {
  crt = "/mnt/cert/tls.crt"
  key = "/mnt/cert/tls.key"
}

Custom certificates for Webhook or Mail integrarions

To configure your Instana installation to successfully send data to Webhook with a custom certificate you can provide a custom java keystore (jssecacerts) that contains your certificate for our JVMs.

1. Just copy a current jvm keystore from your JVM $JAVA_HOME/lib/security/cacerts
2. Import your custom cert into this keystore, by using the jvm keytool with following command: $JAVA_HOME/bin/keytool -importcert -file custom-crt.crt -alias instana.com -keystore cacerts -storepass changeit

3. Now you have to add the absolute path of the keystore with the configuration key custom_keystore into the settings.hcl.

   custom_keystore="<path_to_javakeystore>"