Logging

AVEVA adapters write daily log messages for the adapter, the system, and OMF egress to flat text files in the following locations:

• Windows: %ProgramData%\OSIsoft\Adapters{AdapterInstance}\Logs

• Linux: /usr/share/OSIsoft/Adapters/{AdapterInstance}/Logs

Each message in the log displays the message severity level, timestamp, and the message itself.

To configure logging:

1. Initialize the configuration using the PUT method in conjunction with the http://localhost:5590/api/v1/configuration/<ComponentId>/Logging REST endpoint.

2. Using a text editor, create an empty text file.

3. Copy and paste an example configuration for logging into the file. For sample JSON, see the Logging example.

4. Update the example JSON parameters for your environment. See Logging parameters for a table of all available parameters.

5. Save the file. For example, ConfigureLogging.json.

6. Open a command line session. Change directory to the location of ConfigureLogging.json.

7. Enter the following cURL command (which uses the PUT method) to initialize the logging configuration.

   curl -d "@ConfigureLogging.json" -H "Content-Type: application/json" -X PUT "http://localhost:5590/api/v1/configuration/<ComponentId>/Logging"

   Note: If you installed the adapter to listen on a non-default port, update 5590 to the port number in use.

   For a list of other REST operations you can perform, like updating or retrieving a logging configuration, refer to the URL table below.

   Any parameter not specified in the updated configuration file reverts to the default schema value.

   On successful execution, the log-level change takes effect immediately during runtime. The other configurations (log file size and file count) are updated after the adapter is restarted.

REST URLs

Note: Replace ComponentId with the Id of your adapter component.