Installation
When you install the AVTool, it is recommended to use the following folder hierarchy:
cms-install-directory/
avtool/
avtool-app-5.0.0-executable.conf
avtool-app-5.0.0-executable.jar
application.properties
mediaconfig.xml
data/
groovy/
logs/
...
We also provide a Docker image and Helmchart for deployment.
Starting and Stopping
You can use init.d to start and stop the AVTool. Simply create a symlink in /etc/init.d which points to the jar. It should be started by root but will use the owning user of the jar file for running the application.
To start the AVTool directly as non-root user, you have to change the location of the pid and log files to a place accessible by the user. Put a .conf file with the same name as the jar alongside the jar with a content like the following:
JAVA_OPTS="-Xmx1g -Davtool.groovy.dir=/cms-install-directory/avtool/groovy"
PID_FOLDER="/cms-install-directory/avtool/logs/"
LOG_FOLDER="/cms-install-directory/avtool/logs/"
To start the AVTool invoke the avtool-app-5.0.0-executable.jar as follows:
> cd cms-install-directory/avtool
> ./avtool-app-5.0.0-executable.jar start
To stop the AVTool, enter the following:
> cd cms-install-directory/avtool
> ./avtool-app-5.0.0-executable.jar stop
For all possible options look at the Spring Boot documentation.
Monitoring
The AVTool provides Prometheus metrics under the /prometheus endpoint by default. This can be changed with the management.endpoints.web.base-path parameter in the application.yaml/.properties.
The enpoint will return the common jvm, executor and application metrics aswell as some AVTool specific metrics.
The following AVTool specific metrics are available:
| Name | Tags | Description |
|---|---|---|
| avtool_commands_errors_total | A counter for the total number of failed command executions. | |
| avtool_commands_execution_time_seconds_count | priority(high or low), type(publish or remove) | A summary of the execution times of all executed commands in seconds. |
| avtool_commands_execution_time_seconds_sum | priority(high or low), type(publish or remove) | A summary of the execution times of all executed commands in seconds. |
| avtool_commands_execution_time_seconds_max | priority(high or low), type(publish or remove) | A summary of the execution times of all executed commands in seconds. |
| avtool_commands_queue_change_commands_total | operation(add or remove) | A counter of the number of additions and removals of all command queues. |
| avtool_commands_queue_size_commands | priority(high or low) | A gauge of the current size of the different command queues. |
| avtool_download_data_bytes_total | server(Servernames form the mediaconfig) | A counter for the total number of bytes the downloaded from each server |
| avtool_download_files_fails_total | server(Servernames form the mediaconfig) | A counter for the total number of files that failed to download from each server. |
| avtool_download_files_success_total | server(Servernames form the mediaconfig) | A counter for the total number of files that successfully downloaded form each server. |
| avtool_download_speed_bytes_per_second_count | server(Servernames form the mediaconfig) | A summary of the download speed in bytes per second for each server. |
| avtool_download_speed_bytes_per_second_sum | server(Servernames form the mediaconfig) | A summary of the download speed in bytes per second for each server. |
| avtool_download_speed_bytes_per_second_max | server(Servernames form the mediaconfig) | A summary of the download speed in bytes per second for each server. |
| avtool_upload_data_bytes_total | server(Servernames form the mediaconfig) | A counter for the total number of bytes the uploaded to each server |
| avtool_upload_files_fails_total | server(Servernames form the mediaconfig) | A counter for the total number of files that failed to upload to each server. |
| avtool_upload_files_success_total | server(Servernames form the mediaconfig) | A counter for the total number of files that successfully uploaded to each server. |
| avtool_upload_speed_bytes_per_second_count | server(Servernames form the mediaconfig) | A summary of the upload speed in bytes per second for each server. |
| avtool_upload_speed_bytes_per_second_sum | server(Servernames form the mediaconfig) | A summary of the upload speed in bytes per second for each server. |
| avtool_upload_speed_bytes_per_second_max | server(Servernames form the mediaconfig) | A summary of the upload speed in bytes per second for each server. |
