Skip to content

Commit 4a98d9e

Browse files
committed
tweak wording of the "if you need help section"
1 parent a72838d commit 4a98d9e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

apamax/log_analyzer.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2052,15 +2052,15 @@ def writeOverviewHTMLForAllFiles(self, overviewHTML, **extra):
20522052
<p>Generated by Log Analyzer {version}. <a href="." title="NB: local links don't work in IE; use another browser or copy link to clipboard">Click here</a> to see all generated files. For more information about the latest version of the analyzer <a href='https://github.com/ApamaCommunity/apama-log-analyzer'>see here</a>.</p>
20532053
20542054
<h2>If you need help</h2>
2055-
<p>If you need help analyzing a log file, here's the essential information you need to include: </p>
2055+
<p>If you need help analyzing a log file, here's the essential information you need to include (along with attachment/links to the original correlator logs!): </p>
20562056
<p class="copytofrom">----- (copy from here) -----</p>
20572057
<ol class="ifyouneedhelp">
20582058
<li><span class="key">Apama version: </span>(TODO: 5-digit Apama version here)</li>
20592059
<li><span class="key">Date/time(s) when problem occurred: </span>(TODO: START to END; include date, time, and TIMEZONE)</li>
2060-
<li><span class="key">Nature of the problem: </span>(TODO: e.g. reduced performance, out of memory, correlator terminated unexpectedly, logic error in EPL monitor, confusing log message, etc)</li>
2060+
<li><span class="key">Original correlator logs: </span>(TODO: Links/attachment containing original correlator log files - must cover both the time when the problem occurred AND also the time the correlator was started, as the startup messages contain vital information)</li>
2061+
<li><span class="key">Nature of the problem: </span>(TODO: e.g. reduced latency or throughput performance, out of memory, correlator terminated unexpectedly, logic error or ERROR logged by EPL monitor, confusing log message, etc; put the problem type and customer name into the subject line)</li>
20612062
<li><span class="key">Reproducibility: </span>(TODO: How many times has the problem occurred and how frequently? Can it be reproduced in a test environment?)</li>
20622063
<li><span class="key">Application experts: </span>(TODO: What contacts/departments within Software AG and/or customer knows the codebase of the EPL application?)</li>
2063-
<li><span class="key">Original correlator logs: </span>(TODO: Links to original correlator log files covering the time when the problem occurred, AND also the log files covering the time the correlator was started, as the startup messages contain vital information)</li>
20642064
<li><span class="key">Log analyzer overview: </span>(see overview below)</li>
20652065
</ol></p>
20662066
"""

0 commit comments

Comments
 (0)