Configuration Conventions

Configuration Sources

The tCell Agent loads configuration from multiple sources in order of priority:

1. Agent-specific configuration source (for example, Rails Initializers)
2. Environment variables
3. Configuration file (tcell_agent.config)

You can use all of these at the same time, but a setting at a higher priority overrides any equivalent setting in a lower priority source. See Server Agent Options for a list of the environment variables, their matching config file properties, descriptions, and values.

Configuration File

You can download a configuration (config) file from the Admin section of the tCell UI, pre-configured for the selected application. Every config file property listed in Server Agent Options uses JSON dot notation to show where it belongs in the JSON config. All properties should be inside an Application object.

Property position in JSON Application object
1
{
2
  "version": 1,
3
  "applications": [
4
    {
5
        “property”: “value”,
6
        ...
7
    }
8
  ]
9
}

Config file examples

These example config files show config properties within the Application object.

JSON
1
{
2
  "version": 1,
3
  "applications": [  
4
    {
5
      "app_id": "simulcamapp-kI6x1",
6
      "api_key": "AQBfEfqfx8tKF6QU9B2SpiFgl67STG8R_Ox3Wgk9n9gEpDKioYekVWJeyIU\",
7
      "tcell_api_url": "https://na.agent.tcell.insight.acme.com/api/v1",
8
      "tcell_input_url": "https://na.input.tcell.insight.acme.com/api/v1",
9
      "js_agent_api_base_url": "https://na.agent.tcell.insight.acme.com/api/v1"
10
    }
11
  ]
12
}

JSON
1
{
2
  "version": 1,
3
  "applications": [
4
    {
5
      "app_id": "appapp",
6
      "api_key": "keykey",
7
      "tcell_api_url": "https://us.agent.tcell.insight.acme.com/api/v1",
8
      "tcell_input_url": "https://us.input.tcell.insight.acme.com/api/v1",
9
      "logging_options": {
10
        "enabled":true,
11
        "level":"DEBUG",   <--------
12
        "destination":"stdout"  <----------
13
      },
14
      "js_agent_api_base_url": "https://us.agent.tcell.insight.acme.com/api/v1",
15
      "iis_url_rewrite": true   <----------
16
    }
17
  ]
18
}

Log and Cache Directory Defaults

Each of these settings has a default, but that default may change based on the type of agent. Any default can be overridden through a config file or environment variable.

The default log directory is, in order of priority:

1. $TCELL_AGENT_HOME/logs
2. Agent-specific default

The default cache directory is, in order of priority:

1. $TCELL_AGENT_HOME/cache
2. Agent-specific default

Config File Path

The path to the config file is, in order of priority:

1. Agent-specific override
2. $TCELL_AGENT_CONFIG
3. $TCELL_AGENT_HOME/tcell_agent.config
4. Agent-specific default

On startup, the agent will log all configuration values (including defaults) and their sources.