Logging on Linux¶
The PLOSSYS 5 log data is administrated and visualized by means of Elastic Stack.
Display the Log Data of PLOSSYS 5 via Kibana¶
The log data of PLOSSYS 5 can be displayed and evaluated via the Kibana user interface.
For opening the Kibana user interface, enter the following URL into a Web browser:
http://<admin_server>:5601
Hint - search settings
Kibana does not save search settings, but the search settings are included in the URL. So, you can save the search settings as bookmarks.
Set the Log Level¶
For setting the log level for all services of PLOSSYS 5 or a specific one, the following key has to be set for any
or for a specific service:
LOG_LEVEL
: Log level for the correspondent service
Example - setting key via PLOSSYS CLI for all services
plossys config set LOG_LEVEL debug
Example - setting key via PLOSSYS CLI for the seal-rest
service
plossys config set LOG_LEVEL debug --service seal-rest
For available values for the log level, refer to LOG_LEVEL
.
Log Audit Data¶
For specifying audit data, the current configuration of the services for example, the following keys are available:
-
AUDIT_LOG
: Logging of audit data -
AUDIT_LOG_USER
: Logging of the user names in the audit data -
JWT_USERNAME
: Property name set in the JSON Web Token (JWT) for accessing the user name
Log the Job Metadata¶
For logging all job properties, the following key has to be set for the seal-ipp-checkin
or the seal-ipp-checkin
service:
- The
LOG_FULL_JOB_PROPERTIES
: Logging of the job metadata
Show the Log File of a Specific Service¶
plossys log show <service_name>
Show the Log File of a Specific Job¶
plossys job logs <job_id>
Show the Temporary Files of a Specific Job¶
plossys job tempfiles <job_id>
Log Files¶
PLOSSYS 5 and Infrastructure Services¶
The log files of the PLOSSYS 5 and the infrastructure services such as MongoDB or Consul are located in the following directory:
/var/log/seal
System and Service Manager systemd
¶
For the logging of the system and service manager, systemd
, refer to the documentation of your Linux distribution.
File Size¶
In order to control the size of the log data, the log files are rotated. For this purpose, the configuration file /etc/logrotate.d/plossys
is created during the installation.