Log locations to help investigate issues

When something goes wrong in your Dynamic Documentation web application, the problem may originate from various parts of the system. This is a description of the log locations and other useful places to start when investigating an issue.

There are logs in different parts of the system, and in some cases, you can increase the logging level if you are troubleshooting a specific issue, then return the logging to default levels in day-to-day use of the system.

Here is a general list of the types of issue, where in the system such an issue might occur, and the logs available for consultation:
Type of problemSystem that is affectedLogs to consult
Publish issuePublishing pipeline for Dynamic DeliveryIn Organize Space, you can check different Event Logs, specifically two logs, the Publish and Dynamic Delivery
Problem with the sourceThe publication created in Publication ManagerWhen you have a specific publication open in the Publication Manager, you can view the Error List in the Publication Manager to see if there are errors to fix. The Error List can be accessed by opening a publication in the Publication Manager, then by selecting View>Other Windows> Error List
Issues in the Content Delivery deployment, search or content servicesProblems in deployment, in the content, or in indexing or querying of your content. These are all issue in the Content Delivery environment itself.There are logs for each microservice you are using and they are all using the Logback framework. It is the same approach for each service, but the exact location for configuration and logs depends on where you have installed the microservices.

For more information on configuring logging you can consult the related topics that explain how to set a logging location for your microservices an on configuring logging for a Content Delivery Role

Issues in the Content Delivery API role (REST API/CIL) that is installed in the presentation web appThe CIL is installed as part of the Dynamic Documentation and this role behaves in a similar way to all other Content Delivery features. The REST API role is the only role that is installed in your presentation environment.The logging also occurs as part of the Logback framework.

For more information on configuring logging you can consult the related topics that explain how to set a logging location for your microservices an on configuring logging for a Content Delivery Role

Issues in the Dynamic Documentation web app itselfThe Dynamic Documentation web applicationFor more information refer to the documentation in GitHub for example the descriptions of the ISH modules and its API here: https://github.com/sdl/dd-webapp-custom-examples/tree/master/docs/customizing