Wiki source code of Management of log entries

Last modified by Erik Bakker on 2023/09/28 21:03
Show last authors
1 {{container}}{{container layoutStyle="columns"}}(((
2 {{error}}
3 Note that the functionality mentioned in this microlearning will become obsolete when migrating to the 3rd generation runtime.
4 {{/error}}
5
6 In this microlearning, we will focus on how you can quickly and easily determine the origin of log entries. In other words, what caused the logging.
7
8 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
9
10 == 1. Prerequisites ==
11
12 * Basic knowledge of the eMagiz platform
13 * Understanding of Monitoring concept
14 * One or more log entries raised in the last two weeks within the context of your (Academy) project
15
16 == 2. Key concepts ==
17
18 This microlearning centers around determining the origin of log entries.
19 By origin, in this context, we mean: Identifying which flow wrote an entry to the log that might be in need of analysis.
20
21 * Determining in which flow a log entry is raised can be done with the help of the Manage phase in eMagiz.
22 ** In the Manage phase you have an option called Monitoring. In this overview, you will see all logging that is relevant within your project.
23 * This overview allows you to filter on various elements, such as runtime, type, and timestamp. This way you can conduct a more focused search.
24 * Double-clicking on a log entry provides you with the relevant details
25 * Note that log entries are not shown in full when they exceed a certain size so takes this into account when logging
26 * When you know the flow and the details you have determined the origin of the log entry
27
28 == 3. Determining the origin of log entries ==
29
30 You can determine the origin of a log entry with a two-step approach:
31
32 * Search in the Monitoring overview for log entries
33 * Select a specific log entry for further analysis
34
35 === 3.1 Monitoring overview Manage ===
36
37 To see and analyze the log entries you need to navigate to Manage -> Monitoring. This overview shows all log entries within your project that have been written to the log in the last fourteen 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.
38
39 [[image:Main.Images.Microlearning.WebHome@intermediate-active-monitoring-determining-origin-of-log-entry--manage-monitoring-unfiltered.png]]
40
41 [[image:Main.Images.Microlearning.WebHome@intermediate-active-monitoring-determining-origin-of-log-entry--manage-monitoring-filtered.png]]
42
43 === 3.2 Select a specific log entry for further analysis ===
44
45 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 flow and message are the most relevant from a user perspective.
46
47 [[image:Main.Images.Microlearning.WebHome@intermediate-active-monitoring-determining-origin-of-log-entry--manage-monitoring-log-entry-details.png]]
48
49 Note that some log entries are grouped as they appeared in short proximity after each other and have to do with the same logging.
50
51 [[image:Main.Images.Microlearning.WebHome@intermediate-active-monitoring-determining-origin-of-log-entry--manage-monitoring-log-entry-details-grouped.png]]
52
53 == 4. Key takeaways ==
54
55 * Determining in which flow a log entry is raised can be done with the help of the Manage phase in eMagiz.
56 ** In the Manage phase you have an option called Monitoring. In this overview, you will see all logging that is relevant within your project.
57 * This overview allows you to filter on various elements, such as runtime, type, and timestamp. This way you can conduct a more focused search.
58 * Double-clicking on a log entry provides you with the relevant details
59 * Note that log entries are not shown in full when they exceed a certain size so takes this into account when logging
60 * When you know the flow and the details you have determined the origin of the log entry
61
62 == 5. Suggested Additional Readings ==
63
64 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.)))((({{toc/}}))){{/container}}{{/container}}