Version 1.1 by eMagiz on 2022/05/05 09:52

Show last authors
1 {{html wiki="true"}}
2 <div class="ez-academy">
3 <div class="ez-academy_body">
4
5
6 <li class="doc-nav__item"><a href="../../docs/microlearning/advanced-advanced-monitoring-index" class="doc-nav__link">Home</a></li>
7
8
9
10
11
12
13 <div class="doc">
14
15
16
17 = Interpreting wrapper.log on-premise =
18
19 There is a need to see runtime level logging in cases where it is unclear whether that specific runtime has started up or not. In eMagiz, you won't receive logging if the start-up fails because no established connection can send logging to eMagiz. When this particular runtime runs on-premises, you can see that specific logging on the runtime in the wrapper.log. In this microlearning, we will learn how to find the wrapper log and search within the wrapper log to find the corresponding error and subsequently analyze that error.
20
21 Should you have any questions, please get in touch with academy@emagiz.com.
22
23 * Last update: November 15st, 2021
24 * Required reading time: 5 minutes
25
26 == 1. Prerequisites ==
27 * Advanced knowledge of the eMagiz platform
28
29 == 2. Key concepts ==
30 This microlearning centers around interpreting the wrapper.log for an on-premise runtime
31 With a wrapper.log, we mean: A file that holds start-up and shut down information on a specific runtime
32
33 In a wrapper log, you see the following information:
34
35 * Start-up information on JVM level
36 * Shutdown information on JVM level
37 * Errors on start-up or shutdown
38
39
40
41
42 == 3. Interpreting wrapper.log on-premise ==
43
44 There is a need to see runtime level logging in cases where it is unclear whether that specific runtime has started up or not. In eMagiz, you won't receive logging if the start-up fails because no established connection can send logging to eMagiz. When this particular runtime runs on-premises, you can see that specific logging on the runtime in the wrapper.log. In this microlearning, we will learn how to find the wrapper log and search within the wrapper log to find the corresponding error and subsequently analyze that error.
45
46 In a wrapper log, you see the following information:
47
48 * Start-up information on JVM level
49 * Shutdown information on JVM level
50 * Errors on start-up or shutdown
51
52 === 3.1 Where to find the wrapper.log ===
53
54 Before we can interpret the wrapper.log, the first action will be to find the wrapper.log. The wrapper.log is available within the data folder of each eMagiz runtime that is running on-premises. To see it, you first need to know the location where you saved and unpacked the runtime zips. Suppose you open the runtime you want to interpret the wrapper log and open the data folder. Within the data folder, there is a folder called log. You will see a file called wrapper which can be opened with a tool such as Notepad++.
55
56 <p align="center">[[image:advanced-advanced-monitoring-interpreting-wrapper-log-on-premise--wrapper-log-location.png||]]</p>
57
58 === 3.2 Find additional information ===
59
60 When you open the wrapper.log file, you see all JVM-related logging. Here, you can also see whether things have broken down when starting the JVM or shutting it down. With the help of this information, you can quickly determine whether the start-up or shutdown process is not working as expected. Having this information will be the trigger to see, per the relevant stakeholders, what to do to fix these problems in a structured manner.
61
62 One way to do so would be to stop the runtime and delete the data folder without deleting the h2 folder. That would initiate a clean restart of the runtime to alleviate the problems. In case of structural issues, you should dive into the logging and analyze the issues in more detail.
63
64 ===== Practice =====
65
66 == 4. Assignment ==
67
68 Run your own Academy project on your laptop (on-premise), so you can experiment a bit with analyzing the karaf.log on-premise. This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
69
70 == 5. Key takeaways ==
71
72 * The karaf.log can be found within the folder called log under the folder data
73 * You can search the log with the help of tools such as Notepad++
74 * By looking at the timestamp in the eMagiz Manage Log, you can run a focused search
75
76
77
78 == 6. Suggested Additional Readings ==
79
80 No suggested additional readings for this microlearning.
81
82 == 7. Silent demonstration video ==
83
84 As this is a more theoretical microlearning, we have no video for this.
85
86
87 </div>
88 </main>
89 </div>
90 </div>
91 {{/html}}