9.0

Edit

WFAgent

Service overview

Management

wfmanager (start | stop | restart | status) wfagent
Log files

Access logs: ${install_dir}/supervisord/log/wfagent.out.log
Error logs: ${install_dir}/supervisord/log/wfagent.err.log

Service logs: ${install_dir}/wfagent/logs/
metrics.log
status-agent-error.log
status-agent.log
status-agent-process.log
status-agent-user-actions-process.log
xvfb-err.log
xvfb-out.log
Startup scripts ${install_dir}/supervisord/apps/wfagent.ini
${install_dir}/wfagent/.wfagent
Configuration files

Components configuration:
${install_dir}/wfagent/settings/*.yml
Default Ports

internal port: 10101

Default parameters

Configuration file Name Default Value Description
config.yml

install_dir

 /opt/workfusion Directory to put user files, logs and configs
config.yml wfagent_master_db_port 13017 Default service port for Mongo DB
config.yml

wfagent_notifications_enabled

 false Set to true if notification should be enabled
config.yml wfagent_email_host localhost Hostname the email should be send from
config.yml wfagent_email_port 25 Default port for email notification
config.yml wfagent_email_sender agent@example.com Sender's email
config.yml wfagent_notification_recepient admin@example.com Recipient's email
secrets.yml

wfagent_username

 wfagent Username for APM in web UI
secrets.yml wfagent_password wfapass Password for APM in web UI
secrets.yml wfagent_master_db_admin_user mongodb Admin username for Mongo DB on APM server
secrets.yml wfagent_master_db_admin_pass mongodb Admin password for Mongo DB on APM server
secrets.yml wfagent_master_db_user wfagent Username for Mongo DB on APM server
secrets.yml wfagent_master_db_pass wfagent Password for Mongo DB on APM server
secrets.yml wfagent_mongodb_ro_user wfagent_ro Username for Mongo DB read-only user on APM server
secrets.yml wfagent_mongodb_ro_pass wfagent_secret Password for Mongo DB read-only user on APM server
secrets.yml wfagent_email_username
Email's username for wfagent service
secrets.yml

wfagent_email_password
Email's password for wfagent service

Troubleshooting

  • Check configuration for syntax errors or warnings

    All configuration files are stored at settings directory:

    ${install_dir}/wfagent/settings/

    common.yml
group_apm.yml
group_app.yml
group_db.yml
group_ocr.yml
mongodb-ocr.yml
mongodb-rpa.yml
mongodb-wfa.yml
mysql.yml
nexus.yml
nginx_apm.yml
nginx_app.yml
nginx_db.yml
nginx_ocr.yml
notifications.yml
ocr.yml
postgres.yml
riak.yml
rpa-manager.yml
rpa.yml
vault_secret.yml
vault.yml
wfbi.yml
workfusion.yml
workspace-production.yml
workspace-sandbox.yml

  • Check if TCP port 10101 is available (port may be custom).

    netstat command output

    $ netstat -lntp | grep 10101
tcp6       0      0 127.0.0.1:10101         :::*                    LISTEN      4622/java

    ss command output

    $ ss -ltn | grep 10101
LISTEN     0      100       ::ffff:127.0.0.1:10101                   :::*

    lsof command output

    $ lsof -P -n -i :10101 | grep LISTEN
java    4622 wfuser   30u  IPv6  22975      0t0  TCP 127.0.0.1:10101 (LISTEN)

  • Check the default log files:

    • Access logs: ${install_dir}/supervisord/log/wfagent.out.log
    • Error logs: ${install_dir}/supervisord/log/wfagent.err.log
    $ tail -f ${install_dir}/supervisord/log/wfagent.err.log ${install_dir}/supervisord/log/wfagent.out.log

  • Wfmanager util can be used to check wfagent out (access) log:

    wfmanager tail wfagent

  • Additional logs are stored in the service's log directory:

    ${install_dir}/wfagent/logs/

    metrics.log
status-agent-error.log
status-agent.log
status-agent-process.log
status-agent-user-actions-process.log
xvfb-err.log
xvfb-out.log

  • Enable debug information.

    Add the appropriate log level to ${install_dir}/wfagent/.wfagent (default is info) using the -Ddebug option and restart wfagent service:

    ${install_dir}/wfagent/.wfagent

    JAVA_OPTS="${JAVA_DEFAULT_OPTS} -Xmx256M -Ddebug=ERROR"

    wfmanager restart wfagent
← PreviousNext →