Wiki source code of Understanding Log Entries

Last modified by Danniar Firdausy on 2024/09/18 13:21

Show last authors
1 {{container}}{{container layoutStyle="columns"}}(((
2
3 Understanding log entries is crucial for monitoring and troubleshooting issues within a system. In this microlearning, we will delve into how to effectively read and analyze log entries to monitor and troubleshoot system issues. We will guide you through navigating the monitoring overview, understanding log details, and utilizing these insights to manage your system more efficiently.
4
5 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
6
7 == 1. Prerequisites ==
8
9 * Basic knowledge of the eMagiz platform
10 * Understanding of Monitoring concept
11 * One or more log entries raised in the last two weeks within the context of your (Academy) project
12
13 == 2. Key concepts ==
14
15 This microlearning centers around understanding log entries.
16
17 * Determining what is logged, especially on the **warning** and **error** level can help you manage your model.
18 ** In the Manage phase you have an option called Monitoring. In this overview, you will see all logging that is relevant within your model.
19 * This overview allows you to filter on various elements, such as runtime, type, and timestamp. This way you can conduct a more focused search.
20 * Double-clicking on a log entry provides you additional relevant details
21 * Note that log entries are **not** shown **in full** when they **exceed** a certain size so takes this into account when logging
22 * When you know the runtime and the details you have determined the origin of the log entry
23
24 == 3. Understanding Log Entries ==
25
26 You can understand the meaning of a log entry with a two-step approach:
27
28 * Search in the Monitoring overview for log entries
29 * Select a specific log entry for further analysis
30
31 === 3.1 Monitoring overview Manage ===
32
33 To see and analyze the log entries you need to navigate to Manage -> Monitoring -> Log Entries. This overview shows all log entries within your project that have been written to the log in the last **thirty** days (assuming you did adhere to the fair use policy). Within this overview, you have the ability to search on various options such as runtime, type, and timestamp.
34
35 [[image:Main.Images.Microlearning.WebHome@intermediate-active-monitoring-determining-origin-of-log-entry--manage-monitoring-unfiltered.png]]
36
37 [[image:Main.Images.Microlearning.WebHome@intermediate-active-monitoring-determining-origin-of-log-entry--manage-monitoring-filtered.png]]
38
39 === 3.2 Select a specific log entry for further analysis ===
40
41 After you have filtered the log entries to your liking you can select a specific log entry by double-clicking on the log entry. By doing so a pop-up will be presented in which the details of the log entry are written. On this details page, the runtime, logger, message (and when available the stacktrace) are the most relevant from a user perspective.
42
43 [[image:Main.Images.Microlearning.WebHome@intermediate-active-monitoring-determining-origin-of-log-entry--manage-monitoring-log-entry-details.png]]
44
45 Note that some log entries are grouped as they appeared in short proximity after each other and have to do with the same logging.
46
47 [[image:Main.Images.Microlearning.WebHome@intermediate-active-monitoring-determining-origin-of-log-entry--manage-monitoring-log-entry-details-grouped.png]]
48
49 == 4. Key takeaways ==
50
51 * Access log entries by navigating to Manage > Monitoring > Log Entries within your project. This view displays all relevant logs from the past thirty days.
52 * Utilize filtering options such as runtime, type, and timestamp to refine your search and focus on specific log entries.
53 * Double-click on any log entry to view detailed information, including runtime, logger, message, and stack trace (if available).
54 * Some log entries may be grouped if they occur in quick succession and are related. Review these grouped entries for a comprehensive understanding.
55 * Analyze the log entry message, context, and stack trace (when available) to diagnose issues and take appropriate actions based on the insights gained.
56
57 == 5. Suggested Additional Readings ==
58
59 If you are interested in this topic and want more information on it please read the help text provided by eMagiz when executing these actions and read the following links:
60
61 * [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
62 ** [[Recovery Guide (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Recovery Guide.WebHome||target="blank"]]
63 *** [[Signal received - Recovery Needed (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Recovery Guide.expert-recovery-guide-signals-reproducable-steps||target="blank"]]
64 * [[RCA Knowledge Base (Menu)>>doc:Main.eMagiz Support.RCA Knowledge Base.WebHome||target="blank"]]
65 ** [[Runtime Issues (Navigation)>>doc:Main.eMagiz Support.RCA Knowledge Base.rca-knowledgebase-runtime-issues.WebHome||target="blank"]]
66 *** [[Missing Log Entries (Explanation)>>doc:Main.eMagiz Support.RCA Knowledge Base.rca-knowledgebase-runtime-issues.rca-knowledgebase-missing-logentries-runtime||target="blank"]]
67 * [[Log Entry (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?text=%22log%20entry%22&f_type=DOCUMENT&f_space_facet=0%2FMain.&f_locale=en&f_locale=&f_locale=en&r=1||target="blank"]]
68 )))((({{toc/}}))){{/container}}{{/container}}