Open topic with navigation

TIBCO iProcess® Engine 11.9.1

# TIBCO iProcess Objects Director Logging

The following logs are used by TIBCO iProcess Objects Director:

| • | TIBCO iProcess Objects Director Log Process attributes are used to specify the type and amount of information to write to this log. For more information, see TIBCO iProcess Objects Director Log.

| • | UNIX System Log (UNIX systems only) Errors and other operational information generated by TIBCO iProcess Objects Director are written to this standard UNIX log. This log also contains errors/information messages from other UNIX facilities and programs running on the box. For more information, see UNIX System Log.

| • | Windows Event Log (Windows systems only) Errors and other operational information generated by TIBCO iProcess Objects Director are written to this standard Windows log. This log also contains errors/information messages from other Windows processes and programs running on the box.

You can control whether or not messages are written to this log using the WRITEERRSTOEVENTLOG process attribute — see WRITEERRSTOEVENTLOG.

| • | dir_error File (UNIX systems only) This TIBCO iProcess Objects Director-specific error file is created when the Director is installed. It contains error messages generated by TIBCO iProcess Objects Director. It is located in the `$`SWDIR/`logs` directory (where $SWDIR is the directory in which TIBCO iProcess Engine is installed).

## TIBCO iProcess Objects Director Log

The first time TIBCO iProcess Objects Director is used, it creates a log file that records messages generated by TIBCO iProcess Objects Director. The name and location of the TIBCO iProcess Objects Director log file are as follows:

| • | Windows SWDIR\`logs\spodirector` `XX``.log`

| • | UNIX $SWDIR/`logs/spodirector` `XX``.log`

where `XX` is the instance number of TIBCO iProcess Objects Director. If only a single Director process is running, it is “`01`”.

Note: To change the log files directory, specify the directory in the `staffpms` file located in the SWDIR`\etc` directory. For more information, see "Configuring Log Files Directory" in TIBCO iProcess Engine Administrator’s Guide

The amount and type of data written to the TIBCO iProcess Objects Director log is controlled by the following process attributes:

| • | `LOG_LEVEL` level of information written to the log.

| • | `LOG_CATEGORIES` the categories of information to write to the log.

| • | `LOG_FILE_MAX_SIZE` the maximum size of the log file.

| • | `LOG_FILE_MAX_ARCHIVES` the number of archive log files to create if the log rolls over. See the Archived TIBCO iProcess Objects Director Log Files.

| • | `TRACE_MSG` flag specifying whether network (request/response) messages are written to the log. Note that request/response messages are written to the log if the `LOG_LEVEL` attribute is set to `4` (Debug), regardless of the setting of this attribute.

These are described in more detail in the table on the preceding pages.

The TIBCO iProcess Objects Director log is formatted in the same way as the TIBCO iProcess Objects Server log — for information about this format, see TIBCO iProcess Objects Server Administrator’s Guide.

## Archived TIBCO iProcess Objects Director Log Files

If the TIBCO iProcess Objects Director log file reaches the maximum size specified by the `LOG_FILE_MAX_SIZE` process attribute, the log is rolled over. If desired, you can specify that when the log rolls over, the previous log file is archived. This is specified using the `LOG_FILE_MAX_ARCHIVES` process attribute. The default is to not save archived log files.

Archiving log files can be useful if you want to collect many MB of debug log, but you do not want to deal with a very large log file by setting `LOG_FILE_MAX_SIZE` to a large value.

Archived log files are named `spodirectorXX_archive_n.log`, where `XX` is the instance number of TIBCO iProcess Objects Director, and n is a counter that is incremented each time the log rolls over (starting at 1). For example, if the `LOG_FILE_MAX_ARCHIVES` process attribute is set to 2, the first time the log rolls over, it is saved as `spodirectorXX_archive_1.log`. The next time it rolls over, it is saved as `spodirectorXX_archive_2.log`. If it rolls over again, it is saved as `spodirectorXX_archive_3.log`, but `spodirectorXX_archive_1.log` will be deleted because it is only saving two archives.

## UNIX System Log

When running TIBCO iProcess Objects Director in a UNIX environment, error messages can be written to the standard UNIX system log (other UNIX facilities and programs also write errors/information messages to this log). You can control whether or not messages are written to this log using the `WRITEERRSTOEVENTLOG` process attribute — see WRITEERRSTOEVENTLOG.

The location of the UNIX system log can be configured on each UNIX system, but the usual location is `/var/log/messages` on Linux.

All syslog messages are categorized by the type of “subsystem” or “facility” that originated the message, and by the “priority” given the message. The “subsystems” are areas such as “kernel” (message generated by the kernel, i.e., UNIX itself), “user” (messages from various user programs), “mail,” “daemon,” “auth,” and “lpr.” Additionally, “local” subsystems (local0 through local7) are reserved for local program use. The TIBCO iProcess Objects Director uses one of these — local0.

Within each subsystem, various priority levels exist. In TIBCO iProcess Objects Director, the priorities that are used correspond to the debug log levels/types. They are:

| • | local0.info includes “info,” “notice,” “warn,” and “err”

| • | local0.notice includes “notice,” “warn,” and “err”

| • | local0.warn includes “warn,” and “err”

| • | local0.err includes “err” only

Notice that each priority also includes the levels it.

The UNIX system log file is controlled by the configuration file `/etc/syslog.conf`. You could optionally choose to send all TIBCO iProcess Objects Director messages to a different file by adding a line similar to the following to the syslog.conf file:

    local0.info /var/adm/spo_director_messages_only

Note that whenever the `syslog.conf` file is changed, the syslogd daemon must be sent a SIGHUP signal. For example:

    kill -HUP ‘cat /etc/syslog.pid’

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO iProcess® Engine

Copyright © 1994-2024. Cloud Software Group, Inc. All Rights Reserved.