Skip to content

Settings: Agents

What is Agent

Agent is a light weight service that should be installed on each render engine.
For more, indepth, information about Agent see Agent Section of the documentation

Info

The agent can be installed directly from the server by opening the following URL in a browser on the render engine: http://[SERVER IP]:5550/admin/installers

Agent is represented in Erizos studio by this symbol:

The Agent manages the caching of the media assets, and projects, on the local disk of the render engine.

By navigating to “http://[SERVER IP]:5550/admin/settings” in your browser, and then selecting "Agents" in the main menu, you will see a list of all the available outputs you configured in Erizos studio, and whether or not each output has an Agent installed.

Agent Dashboard

Clicking on any of the Outputs will open the Agent dashboard, where you can find additional information that the Agent provides:

  1. Cache- Agent is responsible for streamlining the access to your graphic assets on air.
    The cache is a folder in the local file system of the machine, that Agent uses to store the assets used by the active Show.

    Under the cache you will find some general information about the machine that the output is installed on:

  2. The hard disk space usage.

  3. The CPU installed, with graphs that show its utilization and its memory usage.
  4. The GPU installed, with graphs that show its utilization and its memory usage.

agent data 1

agent data 2

Agents Logs

Agent also keeps logs, under which you can see:

  1. Every action agent has performed in log format.
  2. By clicking on each of the log entries you can get json formatted information about that entry
  3. If additional commands were executed in that entry you will be able to see the order of events.

agent logs

Agents Settings

By navigating to “http://[SERVER IP]:5510” in your browser of choice and choosing the Settings tab you will have access to the following settings for Agent:

  1. Cache folder: You can select where Agent will manage the cache folder by filling a path to a folder in your file system.
  2. Concurrent File: You can set the value on how many files are to be copied at once
  3. Force Verify Cache: Check if there is a newer version of the asset received. WARNING: on large files this can slow down the system.

  4. Clean up Schedule: once a day Agent is cleaning old files from the cache folder; you can set the time in which the cache is being emptied.
    by default the clean up is scheduled to 4AM.
    to define what files are considered old file see “Day to keep” (number 4) below.

    Info

    The clean up time is written in Corn string format, for more information corn string

  5. Quota: set the maximum size of the cache folder in GB.

  6. Day to keep: set how many days Agent will keep unused cached files. Files that are not used for the set number of days will be clean in the daily cleanup
  7. Publish address over http: for files that are served over http, for example, http://... instead of C:\...
    This setting is most used when using Singular as the render engine
  8. Log Level:: Select the Log Level for the Agent

agent logs

Override UE Launch arguments

You can also override default settings such as setting up Command line Arguments, and Launching UE in the Editor.

  1. Force Launch: Force Launch the Project
  2. Launch UE in Editor: Launch UE in the Editor
  3. Command Line Arguments: You can send command to UE by passing arguments through Agent.
  4. Default Unreal Engine Executable: If you are using a custom build Unreal Editor, you can override the default UE executable by providing the path where the Engine folder of the Custom Build is located.

agent logs

Override Property Default Value
False Force Launch False
False Launch UE in Editor False
False Command Line Arguments Empty
False Default Unreal Engine Executable Empty

Note

You can learn more about Unreal Engine Command-Line Arguments in this link.