Automation Action Script

Script execution home configuration

By default, the Action Script sensor creates and runs the scripts from the agent default temporary directory <instana-agent-dir>/data/tmp. To change this location, add the scriptExecutionHome attributes to the script sensor configuration in the agent configuration file. The scriptExecutionHome value must not contain any space character. If the default temporary directory for the agent <instana-agent-dir>/data/tmp contains any space character, you must specify a value for scriptExecutionHome.

com.instana.plugin.action.script:
  enabled: true
  scriptExecutionHome: '/myExecutionDir' # The path used for action script executions.

RunAs configuration

By default, the Action Script sensor runs the scripts as the user who started the Instana agent. On the Linux, AIX, and Solaris operating systems, the action scripts cannot run as root. Similarly, on Windows, the action scripts cannot run as Administrator. To configure the Action Script sensor to run the action scripts with alternative credentials, add the runAs and scriptExecutionHome attributes to the script sensor configuration in the agent configuration file. The runAs user requires read, write, and execute permissions in the scriptExecutionHome directory. For Windows, you also need to specify the password for the runAs user in the runAsUserPassword attribute. Use the vault for runAsUserPassword as shown in the following YAML configuration. Before you decide on a username for runAs user, review the information in Creating a dedicated user for script actions.

com.instana.plugin.action.script:
  enabled: true
  runAs: 'aUser' 
  scriptExecutionHome: '/myExecutionDir' # The path used for action script executions.
  runAsUserPassword: # Required on Windows operating system.
    configuration_from:
      type: vault
      secret_key:
        path: <secret_path>
        key: <secret_key>

Maximum concurrent actions configuration

By default, the script sensor runs maximum of 10 concurrent script actions. If you want to change the maximum number of concurrent script actions, add the maxConcurrentActions attribute to the script sensor configuration section in the agent configuration file as follows:

com.instana.plugin.action.script:
  enabled: true
  maxConcurrentActions: 5  # optional, default value is 10

Script default timeout configuration

When you create a script action, you can set the maximum time in seconds to wait for the script action to complete. If you do not set the script action timeout during script action creation, then by default, a script action times out after 300 seconds. If you want to change this default timeout for action script execution, add the defaultTimeout attribute to the script sensor configuration section in the agent configuration file as follows:

com.instana.plugin.action.script:
  enabled: true
  defaultTimeout: 600 # optional, default timeout is 300 seconds

Vault integration

If the script action in your action catalog uses Vault parameters, then you need to enable the vault sensor by using the Vault sensor configuration. The vault parameter integration of actions currently supports token authentication and path_to_pem_file and kv_version configuration parameters.