Enabling traces and viewing log files

To troubleshoot a problem in IBM® Intelligent Operations Center, you might need to analyze log files in several systems.

If errors occur, some error messages are displayed in the messages.log file that is in the liberty.install.dir/usr/servers/liberty.instance.name/logs directory, where liberty.install.dir is the WebSphere® Application Server Liberty Profile installation directory, and liberty.instance.name is the name of the Liberty instance. For example, the /opt/IBM/WebSphere/wlp/usr/servers/iocsvr1/logs/messages.log file.

For information about administering the WebSphere Application Server Liberty Profile server, see Administering the Liberty profile in the WebSphere Application Server Liberty Profile product documentation.

If you require more detailed information for troubleshooting, use the following procedure to enable traces for the solution.
  1. Locate the server.xml file in the appropriate directory:
    • On the server in a single-server platform environment or, on the application server in a multi-platform environment, go to /opt/IBM/WebSphere/wlp/usr/servers/iocsvr1.
    • In the development edition on Linux, go to /home/ibmadmin/liberty/usr/servers/defaultServer/.
    • In the development edition on Windows, go to \home\ibmadmin\liberty\usr\servers\defaultServer.
  2. Edit the following line in the server.xml file:
    <logging consoleLogLevel="AUDIT" copySystemStreams="true" traceFormat="BASIC"
              traceSpecification="*=info"/>
    The following example shows a line in server.xml with completed values:
    <logging consoleLogLevel="AUDIT" copySystemStreams="true" traceFormat="BASIC" 
    traceSpecification="*.info:com.ibm.ioc.logger.DataReceiverRuntimeLogger=
    all:com.ibm.ioc.logger.DataReceiverConfigLogger=
    all:com.ibm.ioc.logger.DataReceiverPersistenceLogger=all"/>
  3. Save your changes. The trace starts and logger output is sent to the following directory:
    /opt/IBM/WebSphere/wlp/usr/servers/iocsvr1/logs/trace.log
    Trace strings appear similar to the following values:
    com.ibm.ioc.logger.FilterLogger=all
    com.ibm.ioc.logger.KpiLogger=all
    The following table shows all of the loggers in the solution, and indicates the components that they relate to:
Table 1. Loggers and related components and issues
Logger Components and issues that you can use the logger to analyze
com.ibm.ioc.logger.AboutLogger Display of the administrative About page; for example, if the software and fix inventory tags are listed incorrectly.
com.ibm.ioc.logger.AnalyticsLogger Analytics framework, creating and running analytics, and the analytics taskbar button.
com.ibm.ioc.logger.AssociationLogger Defining data source associations, querying for associated items, and the administrative data source association configuration tool.
com.ibm.ioc.logger.AuditLogger Audit REST service.
com.ibm.ioc.logger.AuthorizationLogger Taskbar buttons, pages, data sources, and so on.
com.ibm.ioc.logger.CapLogger CAP data receiver, when converting CAP XML to objects and converting objects to CAP XML.
com.ibm.ioc.logger.CognosServiceLogger Issues related to Cognos®.
com.ibm.ioc.logger.CommentLogger Comments REST service, that allows for comments to be left on individual data items.
com.ibm.ioc.logger.CommonLogger Twitter and ColorPalette service.
com.ibm.ioc.logger.ConnectionLogger Services that connect to external services, such as Cognos, IBM Business Monitor, and standard operating procedure REST activities.
com.ibm.ioc.logger.CorrelationLogger Data sources that are configured to route to correlation, where correlations are based on time and distance, and correlations are not being generated correctly.
com.ibm.ioc.logger.CSRFFilterLogger Cross-site request forgery (CSRF) filter, where services are not connecting because of CSRF.
com.ibm.ioc.logger.DataImportResourceLogger Data receiver and importing data into IBM Intelligent Operations Center.
com.ibm.ioc.logger.DataImportStatisticsLogger Creating data import statistics, when importing data into IBM Intelligent Operations Center.
com.ibm.ioc.logger.DataInjectionLogger Data injection service, New Item and Update windows.
com.ibm.ioc.logger.DataMigrationInfoLogger Data migration resource, records information about data migration status and progress.
com.ibm.ioc.logger.DataMigrationLogger Data migration resource, records details about data migration.
com.ibm.ioc.logger.DataReceiverConfigLogger Data receiver manager information.
com.ibm.ioc.logger.DataReceiverLogger Data receiver code, and populating source data into IBM Intelligent Operations Center.
com.ibm.ioc.logger.DataReceiverPersistenceLogger Data receiver, persisting data into IBM Intelligent Operations Center.
com.ibm.ioc.logger.DataReceiverRuntimeLogger Data receiver, importing data and geocoding data
com.ibm.ioc.logger.DataSourceLogger Data source service, data receiver, and administrative data source configuration tool.
com.ibm.ioc.logger.ESRILogger Data receiver column parser for Esri data sources.
com.ibm.ioc.logger.ExportPDFLogger PDF export, and print taskbar button.
com.ibm.ioc.logger.ExtensionLogger Administrative component customization tool.
com.ibm.ioc.logger.FilterLogger Filter, including Filter and Saved Filters taskbar widgets, and administrative filter configuration tool.
com.ibm.ioc.logger.GeocoderLogger Geocoding service, if geocoding is enabled.
com.ibm.ioc.logger.HotspotsLogger Hotspot analytics.
com.ibm.ioc.logger.HttpLogger JUnit sample projects, setting up HTTP connection for REST services.
com.ibm.ioc.logger.I18nLogger Translated strings in I18n SQL file.
com.ibm.ioc.logger.ImageLogger Associating images with individual data items.
com.ibm.ioc.logger.ISSBaseLogger Base logger; all other loggers inherit this logger.
com.ibm.ioc.logger.JdbcLogger JDBC utilities interface.
com.ibm.ioc.logger.JournalLogger Journal REST service.
com.ibm.ioc.logger.KpiLogger KPI service and KPI issues.
com.ibm.ioc.logger.L10nLogger Localization service, calendar and date conversion to local times, and determination of locales to be applied.
com.ibm.ioc.logger.LocationMapLogger Location map service, population of the location map in the user interface.
com.ibm.ioc.logger.LocationMapManagerLogger Administrative location map configuration tool.
com.ibm.ioc.logger.LoginLogger Logging on and associated issues.
com.ibm.ioc.logger.MapDefinitionsLogger Map definitions service; creating, updating and deleting geospatial maps; administrative geospatial maps configuration tool.
com.ibm.ioc.logger.MoreFilterCriteriaLogger Filter More option, for specifying extra filter criteria.
com.ibm.ioc.logger.NotificationLogger Notifications and alerts taskbar button. Does not include notification settings in the administrative user profile page.
com.ibm.ioc.logger.PublisherLogger Messages published to JMS topics such as distributed map synchronization, integration topics, correlation topics, KPI events, and so on.
com.ibm.ioc.logger.RoutingLogger Data source routing functionality, and issues related to data items not being routed correctly.
com.ibm.ioc.logger.SchedulerLogger Scheduled services in IBM Intelligent Operations Center, for example, polling data sources, analytics, Integrated Crime Analytics models, and KPI History.
com.ibm.ioc.logger.SecurityLogger User and group security services.
com.ibm.ioc.logger.ServerSideRenderingProcessingLogger Stat service and the server-rendered map features REST service, server-side rendering processes.
com.ibm.ioc.logger.ServerSideRenderingTimingLogger Stat service and the server-rendered map features REST service, time taken for the server-side rendering processes.
com.ibm.ioc.logger.SessionLogger Session-related issues and user interface configuration persistence.
com.ibm.ioc.logger.SlmLogger Software License Metric (SLM) service.
com.ibm.ioc.logger.SopbaLogger Standard operating procedure service and issues related to standard operating procedures.
com.ibm.ioc.logger.StatLogger Spatial service, queries that display items on the map, and general queries for data items.
com.ibm.ioc.logger.SyspropLogger Administrative system properties tool, and system properties service.
com.ibm.ioc.logger.TaskbarLogger Taskbar, administrative taskbar access configuration tool, and related issues, such as taskbar buttons that are visible to each user in each view.
com.ibm.ioc.logger.ThemeBootstrapLogger Moving between pages and related issues.
com.ibm.ioc.logger.ThemeLogger Theme service, including the Banner menu, custom CSS includes, custom JavaScript file and library includes, and modules displayed on the page. Does not include the taskbar.
com.ibm.ioc.logger.TwitterLogger Details of requests from all Twitter data sources to the Twitter service, and handling of all responses from the Twitter service.
com.ibm.ioc.logger.UploadLogger Upload service for CSV files, image files, and shape files.
com.ibm.ioc.logger.UserAttributeLogger User attribute service that adds default and custom attributes to the user object that is used to control access to IBM Intelligent Operations Center.
com.ibm.ioc.logger.VoteLogger Voting REST service that processes data item votes in a data source that has voting set to enabled.
com.ibm.ioc.logger.WeatherAlertLogger Weather REST services, including storm path, National Weather Service and The Weather Company© weather alerts, and weather filtering through The Weather Company© REST service.
com.ibm.ioc.logger.WorkerPoolLogger Data receiver worker manager activity.
com.ibm.iss.cros.logger.CrosLogger Issues related to integrated crime analytics and analyzing incident data.
Table 2. Loggers and related components and issues for Device Management Enablement
Logger Components and issues that you can use the logger to analyze
com.ibm.water.eam.logger.EAMServiceLogger REST services for managing EAM.
com.ibm.water.logger.AssetServiceLogger REST services for managing assets.
com.ibm.water.logger.ArcGisLogger Adding MapServer content that is provided by ArcGIS to a Filter window. Extending the base map by selecting map entries in the Filter window to overlay ArcGIS map content on the base map.
com.ibm.water.logger.ClientLogger REST service requests that are made from Device Management Enablement.
com.ibm.water.logger.DBUtilLogger Database interactions.
com.ibm.water.logger.I18NLogger Issues relating to I18N.
com.ibm.water.logger.ModelServiceLogger REST service for managing models in the solution.
com.ibm.water.logger.PageConfigurationLogger Page configuration issues.
com.ibm.water.logger.RenderServiceLogger REST service for rendering data items. Issues relating to server-side rendering of assets.
com.ibm.water.logger.SchedulerLogger Scheduled services in Device Management Enablement. For example, includes tasks for creating solutions and creating models.
com.ibm.water.logger.ServiceLogger For all Device Management Enablement REST services.
com.ibm.water.logger.SyncModelToDBLogger REST service to synchronize models in a solution application.
com.ibm.water.logger.TenantLogger Tenant management REST services.