AIMMS Applications deployed on AIMMS Cloud are designed to be End-User friendly. Still incidents may occur, and then it is useful to have logging information available such that post mortem analysis can go quickly to the cause of the incident at hand.
Suggested project option settings:
Option 1: communicate_warnings_to_end_users
Warnings can provide useful information, typically to developers of the application and to maintainers of the data sources (warnings on inconsistency of the data).
However, not all end-users are familiar with the design of the application at hand, and may therefor be unnecessarily rattled by these messages.
For the above reasons, the default of the option communicate_warnings_to_end_users is off.
However, best practice is to turn these warnings on, provided there is error handling in the application, such that warnings are logged and handled, but not shown to end-users.
Option 2: major_messages and time_messages:
A typical item in log files people look for first is information about the size of mathematical programs generated, and the time it took a solution algorithm such as CPLEX or GUROBI to solve these mathematical programs.
By setting the options major_messages to show_major_messages, and time_messages to show_time_messages; this information will be passed in AIMMS Developer in the message window, and on AIMMS Cloud, in the session logs.
Option 3: solver_listing_messages and solver_window_messages
When the time needed to solve the mathematical programs proves to be unexpectedly long or short; it may be worthwhile to take a look at the logging provided by the solution algorithms used.
There are various settings of the individual solution algorithms to increase their logging level; and is beyond the scope of this article to enumerate them all; but please check https://how-to.aimms.com/Articles/13/13-Solver-Logging-IDE.html if you want to get started on logging information from the individual solvers.
There are a few settings, however, to make the logging information from these algorithms more easily accessible.
-
solver_listing_messages - this is a filter on the severity level of the messages written to the solver listing file.
To retrieve the generated information: https://how-to.aimms.com/Articles/13/13-Solver-Logging-PRO.html -
solver_window_messages - this is a filter on the severity level of the messages that are sent to the AIMMS IDE messages window and to the AIMMS Cloud session log file. By setting it to all, all messages are passed on.
To retrieve the generated information:-
For AIMMS Cloud: For sessions ran, nowadays you can right click in the AIMMS PRO portal and retrieve the log file, see https://documentation.aimms.com/cloud/newportal-sessions.html
In addition, there is an endpoint defined for obtaining logs, see for instance: GET /pro-api/v2/tasks/{id}/logs in https://documentation.aimms.com/cloud/tasks.html -
For AIMMS PRO on Prem:
See also https://how-to.aimms.com/Articles/497/497-download-solver-session-log.html
-