Configure logging for troubleshooting

The AVEVA Adapter for Structured Data Files can be configured to perform data logging. Each message in the log displays the message severity level, timestamp, and the message itself.

For a list of severity levels and their descriptions, see Log levels.

Note: 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.

Postman

To configure logging using Postman:

1. To initialize the configuration, use the PUT method in conjunction with the following REST endpoints.

   • To update the log levels for the system logs, use the http://localhost:5590/api/v1/configuration/system/Logging REST endpoint.

   • To update the egress log level, use the http://localhost:5590/api/v1/configuration/omfegress/Logging REST endpoint.

   • To update specific adapter components, use the http://localhost:5590/api/v1/configuration/<componentId>/Logging REST endpoint.

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

2. Copy and paste an example configuration for logging into the Body section.

   For sample JSONs, see the Examples section.

3. Update the example JSON parameters for your environment.

4. Select Send to push the configuration to the adapter.

EdgeCmd

To configure logging using EdgeCmd:

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

6. Copy and paste an example configuration for logging into the file.

7. Update the example JSON parameters for your environment.

   For sample JSONs, see the Examples section.

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

9. Open a command line session. Change directory to the location of your saved file.

10. Use one of the following edgecmd commands with the name of your JSON file.

    edgecmd -port <port number> -cid <componentId> set Logging -file /.ConfigureComponentLogging.json

    edgecmd -port <port number> -cid OmfEgress set Logging -file /.ConfigureEgressLogging.json

    edgecmd -port <port number> -cid System set Logging -file /.ConfigureAdapterLogging.json