Skip to content

Latest commit

 

History

History
435 lines (317 loc) · 14.7 KB

config_files.rst

File metadata and controls

435 lines (317 loc) · 14.7 KB

Listing of Important perfSONAR Files

esmond

Configuration Files

Main Configuration File

Description:The main configuration file for esmond
CentOS:/etc/esmond/esmond.conf
Debian:/etc/esmond/esmond.conf
Documentation:N/A

Important Scripts

Start-up Script

Description:Esmond is started/stopped/restarted when HTTPD is started/stopped/restarted
CentOS:systemctl start|stop|restart httpd
Debian:service apache2 restart

Data Cleaner

Description:Cleans out old esmond data given a policy file.
CentOS:/usr/lib/esmond/utils/ps_remove_data.py
Debian:/usr/share/esmond/util/ps_remove_data.py
Documentation::ref:`multi_ma_backups-delete`

Log Files

esmond Log

Description:Primary error log for esmond software.
CentOS:/var/log/esmond/esmond.log
Debian:/var/log/esmond/esmond.log

Django Log

Description:Error log related to Django framework such as processing JSON messages and database interactions
CentOS:/var/log/esmond/django.log
Debian:/var/log/esmond/django.log

LS Registration Daemon

Configuration Files

Main Configuration File

Description:The main configuration file for the LS Registration Daemon that describes what you want registered in the Lookup Service.
CentOS:/etc/perfsonar/lsregistrationdaemon.conf
Debian:/etc/perfsonar/lsregistrationdaemon.conf
Documentation::doc:`config_ls_registration`

Logging Configuration File

Description:Configuration file for setting log location, level of detail and various other log-related settings.
CentOS:/etc/perfsonar/lsregistrationdaemon-logger.conf
Debian:/etc/perfsonar/lsregistrationdaemon-logger.conf
Documentation:Log4perl Reference

Important Scripts

Start-up Script

Description:The script used to start/stop/restart a LS Registration Daemon server
CentOS:systemctl start|stop|restart perfsonar-lsregistrationdaemon
Debian:service perfsonar-lsregistrationdaemon start|stop|restart

Log Files

Primary Log file

Description:The log file to which the LS Registration daemon writes to as configured in the default :ref:`logging configuration file <config_files-lsreg-conf-logging>`
CentOS:/var/log/perfsonar/lsregistrationdaemon.log
Debian:/var/log/perfsonar/lsregistrationdaemon.log

OWAMP

Configuration Files

Main Configuration File

Description:The main configuration file for an OWAMP server
CentOS:/etc/owamp-server/owamp-server.conf
Debian:/etc/owamp-server/owamp-server.conf
Documentation::doc:`config_owamp`

Limits File

Description:The OWAMP limits file that defines authentication and authorization parameters for testing
CentOS:/etc/owamp-server/owamp-server.limits
Debian:/etc/owamp-server/owamp-server.limits
Documentation::doc:`config_owamp_limits`

Important Scripts

Start-up Script

Description:The script used to start/stop/restart an OWAMP server
CentOS:systemctl start|stop|restart owamp-server
Debian:service owamp-server start|stop|restart

Log Files

Primary Log file

Description:OWAMP servers and clients can each write to log files. The location of the log file is dependent on your syslog configuration. The entries in this table assume a default configuration.
CentOS:RPM Only: /var/log/messages Toolkit: /var/log/perfsonar/owamp.log
Debian:/var/log/perfsonar/owamp.log

pScheduler

Configuration Files

Limits File

Description:The pScheduler limits file that defines authentication and authorization parameters for testing.
CentOS:/etc/pscheduler/limits.conf
Debian:/etc/pscheduler/limits.conf
Documentation::doc:`config_pscheduler_limits`

Archives Configuration Files

Description:The configuration files for pScheduler's archives. Contains individual archive specifications applied to every measurement the system runs.
CentOS:/etc/pscheduler/default-archives/*
Debian:/etc/pscheduler/default-archives/*
Documentation:

Database Configuration Files

Description:The configuration files for pScheduler's database. Contains files maintained by the system and should not be altered at the risk of breaking pScheduler’s ability to use its database.
CentOS:/etc/pscheduler/database/*
Debian:/etc/pscheduler/database/*
Documentation:

Log Files

Primary Log file

Description:The log file written when the pScheduler daemon is run.
CentOS:/var/log/pscheduler/pscheduler.log
Debian:/var/log/pscheduler/pscheduler.log

pSConfig

Configuration Files

pSConfig pScheduler Agent Configuration File

Description:The pSConfig pScheduler Agent configuration file
CentOS:/etc/perfsonar/psconfig/pscheduler-agent.json
Debian:/etc/perfsonar/psconfig/pscheduler-agent.json
Documentation:N/A

pSConfig MaDDash Agent Configuration File

Description:The pSConfig MaDDash Agent configuration file
CentOS:/etc/perfsonar/psconfig/maddash-agent.json
Debian:/etc/perfsonar/psconfig/maddash-agent.json
Documentation:N/A

pSConfig pScheduler Agent Include Directory

Description:Directory for pSConfig templates that automatically get loaded by pScheduler agent
CentOS:/etc/perfsonar/psconfig/pscheduler.d
Debian:/etc/perfsonar/psconfig/pscheduler.d
Documentation:N/A

pSConfig MaDDash Agent Include Directory

Description:Directory for pSConfig templates that automatically get loaded by MaDDash agent
CentOS:/etc/perfsonar/psconfig/maddash.d
Debian:/etc/perfsonar/psconfig/maddash.d
Documentation:N/A

pSConfig Archive Include Directory

Description:Directory for archive definitions that automatically get loaded by agent(s)
CentOS:/etc/perfsonar/psconfig/archives.d
Debian:/etc/perfsonar/psconfig/archives.d
Documentation:N/A

pSConfig Transform Include Directory

Description:Directory for JQ transformations that automatically get applied to all templates downloaded by agent(s)
CentOS:/etc/perfsonar/psconfig/transforms.d
Debian:/etc/perfsonar/psconfig/transforms.d
Documentation:N/A

Important Scripts

pSConfig pScheduler Agent Start-up Script

Description:Scripts used to start|stop|restart the pSConfig pScheduler Agent
CentOS:systemctl start|stop|restart psconfig-pscheduler-agent
Debian:service psconfig-pscheduler-agent start|stop|restart

pSConfig MaDDash Agent Start-up Script

Description:Scripts used to start|stop|restart the pSConfig MaDDash Agent
CentOS:systemctl start|stop|restart psconfig-maddash-agent
Debian:service psconfig-maddash-agent start|stop|restart

psconfig command

Description:Command used to perform numerous tasks related to pSConfig
CentOS:psconfig COMMAND [OPTIONS]
Debian:psconfig COMMAND [OPTIONS]

Log Files

pSConfig pScheduler Agent Log

Description:Primary log for pSConfig pScheduler Agent
CentOS:/var/log/perfsonar/psconfig-pscheduler-agent.log
Debian:/var/log/perfsonar/psconfig-pscheduler-agent.log

pSConfig pScheduler Agent Tasks Log

Description:Log of all the pScheduler tasks managed by the agent
CentOS:/var/log/perfsonar/psconfig-pscheduler-agent-tasks.log
Debian:/var/log/perfsonar/psconfig-pscheduler-agent-tasks.log

pSConfig pScheduler Agent Transactions Log

Description:Log of each interaction by agent with pScheduler server(s)
CentOS:/var/log/perfsonar/psconfig-pscheduler-agent-transactions.log
Debian:/var/log/perfsonar/psconfig-pscheduler-agent-transactions.log

pSConfig MaDDash Agent Log

Description:Primary log for pSConfig MaDDash Agent
CentOS:/var/log/perfsonar/psconfig-maddash-agent.log
Debian:/var/log/perfsonar/psconfig-maddash-agent.log

Toolkit

Configuration Files

Note

The Toolkit contains other configuration files but in general non-developers should not be changing them. As such they are not listed here.

Measurement Archive Data Retention Policy

Description:The configuration file used by the :ref:`esmond data cleaner <config_files-esmond-scripts-ps_remove_data>` script when running in the :ref:`cron <config_files-toolkit-cron-clean_esmond_db>` installed by the Toolkit.
CentOS:/etc/perfsonar/toolkit/clean_esmond_db.conf
Debian:/etc/perfsonar/toolkit/clean_esmond_db.conf
Documentation::ref:`multi_ma_backups-delete`

Important Scripts

Toolkit Configuration Script

Description:A script to help configure users and other basic features of the Toolkit.
CentOS:/usr/lib/perfsonar/scripts/nptoolkit-configure.py
Debian:/usr/lib/perfsonar/scripts/nptoolkit-configure.py
Documentation::doc:`manage_users`

Configuration Daemon Start-up Script

Description:The script used to start/stop/restart the service used by the administrative web interface to configure the host
CentOS:systemctl start|stop|restart perfsonar-configdaemon
Debian:service perfsonar-toolkit-config-daemon start|stop|restart

Network Interface Card Configuration Script

Description:The script detects if the NIC is misconfigured, and makes necessary configuration changes to NIC if they are.
CentOS:systemctl start|stop|restart perfsonar-configure_nic_parameters
Debian:service perfsonar-configure_nic_parameters start|stop|restart

'Message of the Day' Script

Description:Generates the login message on start-up that appears to command-line users
CentOS:systemctl start|stop|restart perfsonar-generate_motd
Debian:service perfsonar-generate_motd start|stop|restart

Multi-Interface Routing Setup Script

Description:A script to help with the configuration of routing for hosts running tests on multiple interfaces.
CentOS:/usr/lib/perfsonar/scripts/mod_interface_route
Debian:/usr/lib/perfsonar/scripts/mod_interface_route
Documentation::doc:`manage_dual_xface`

Installed Cron Jobs

Measurement Archive Data Cleaner

Description:Cleans out data in the measurement archive according to retention policy in :ref:`config_files-toolkit-conf-clean_esmond_db`. Runs at 2:30AM every morning.
CentOS:/etc/cron.d/cron-clean_esmond_db
Debian:/etc/cron.d/cron-clean_esmond_db

Regular Service Restarts and Maintenance

Description:Verifies expected processes are running every hour and performs a regular restart of services that require it every moring at 1:05AM. It also cleans out stale files from OWAMP and Regular Testing at this time.
CentOS:/etc/cron.d/cron-service_watcher
Debian:/etc/cron.d/perfsonar-toolkit-servicewatcher

Log Files

Configuration Daemon Log

Description:The log file for the :ref:`configuration daemon <config_files-toolkit-scripts-config_daemon>`
CentOS:/var/log/perfsonar/configdaemon.log
Debian:/var/log/perfsonar/configdaemon.log

Service Watcher Log

Description:Logs generated by the :ref:`cron <config_files-toolkit-cron-service_watcher>` that verifies services are running and performs regular restarts/maintenance.
CentOS:/var/log/perfsonar/servicewatcher.log and /var/log/perfsonar/servicewatcher_error.log
Debian:/var/log/perfsonar/servicewatcher.log and /var/log/perfsonar/servicewatcher_error.log
Debian:N/A

Web Interface Logs

Description:Log files for the web interface.
CentOS:/var/log/perfsonar/web_admin/web_admin.log
Debian:/var/log/perfsonar/web_admin/web_admin.log