Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
I
Imldeployment
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
IML Open Source
Imldeployment
Commits
888cdede
Commit
888cdede
authored
2 years ago
by
hahn
Browse files
Options
Downloads
Patches
Plain Diff
update ahlogger
parent
071c49ae
No related branches found
No related tags found
1 merge request
!42
6295 commits with ampersand
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
public_html/deployment/classes/logger.class.php
+263
-107
263 additions, 107 deletions
public_html/deployment/classes/logger.class.php
with
263 additions
and
107 deletions
public_html/deployment/classes/logger.class.php
+
263
−
107
View file @
888cdede
<?php
/**
* ----------------------------------------------------------------------
*
* Debug logging during a client request.
* So you can measure any action find bottlenecks in your code.
*
* Licence: GNU GPL 3.0
* Source: https://github.com/axelhahn/ahlogger
* Docs: https://www.axel-hahn.de/docs/ahlogger/
*
* USAGE:<br>
* (1) Trigger a message with add() to add a marker<br>
* (2) The render() method lists all items in a table with time since start
* and the delta to the last message. <br>
*
* @author www.axel-hahn.de
*
* @author hahn
* ----------------------------------------------------------------------
* 2016-02-26 init
* 2016-11-19 add memory usage
* (...)
* 2022-09-25 add memory tracking, add cli renderer
* 2022-09-27 css updates
* 2022-10-02 add emoji chars
* 2022-10-16 mark longest action with an icon
* 2022-12-15 make it compatible to PHP 8.2; add doc + comments
* ----------------------------------------------------------------------
*/
class
logger
{
protected
$aMessages
=
array
();
protected
$bShowDebug
=
true
;
/**
* @var {array} array of added messages
*/
protected
$aMessages
=
[];
/**
* @var {bool} flag: show debug infos? default: false
*/
protected
$bShowDebug
=
false
;
/**
* @var {int} memory usage on start
*/
protected
$_iMemStart
=
false
;
/**
* @var {string} dynamic prefix for used css - it is set in the cronstructor
*/
protected
$sCssPrefix
=
''
;
// ----------------------------------------------------------------------
// CONSTRUCTOR
// ----------------------------------------------------------------------
/**
* constuctor
...
...
@@ -18,33 +61,15 @@ class logger {
*/
public
function
__construct
(
$sInitMessage
=
"Logger was initialized."
)
{
$this
->
_iMemStart
=
memory_get_usage
();
$this
->
enableDebug
(
true
);
$this
->
add
(
$sInitMessage
);
$this
->
sCssPrefix
=
'debug-'
.
md5
(
microtime
(
true
));
return
true
;
}
/**
* enable / disable debugging
* @param type $bEnable
* @return type
*/
public
function
enableDebug
(
$bEnable
=
false
){
return
$this
->
bShowDebug
=
$bEnable
;
}
/**
* enable client debugging by a given array of allowed ip addresses
* @param array $aIpArray
* @return boolean
*/
public
function
enableDebugByIp
(
$aIpArray
){
$this
->
enableDebug
(
false
);
if
(
!
$_SERVER
||
!
is_array
(
$_SERVER
)
||
!
array_key_exists
(
"REMOTE_ADDR"
,
$_SERVER
)){
return
false
;
}
if
(
array_search
(
$_SERVER
[
'REMOTE_ADDR'
],
$aIpArray
)
!==
false
){
$this
->
enableDebug
(
true
);
}
}
// ----------------------------------------------------------------------
// PUBLIC METHODS
// ----------------------------------------------------------------------
/**
* add a logging message
...
...
@@ -56,94 +81,238 @@ class logger {
if
(
!
$this
->
bShowDebug
){
return
false
;
}
global
$aCfg
;
$this
->
aMessages
[]
=
array
(
'time'
=>
microtime
(
true
),
'message'
=>
$sMessage
,
'level'
=>
$sLevel
'level'
=>
preg_replace
(
'/[^a-z0-9\-\_]/'
,
''
,
$sLevel
),
'memory'
=>
memory_get_usage
()
);
if
(
$sLevel
==
"MAIL"
){
mail
(
$aCfg
[
"emailDeveloper"
],
"studmed - booking tool - Logmessage"
,
$sMessage
);
}
return
true
;
}
/**
* render output of all logging messages
* enable / disable debugging
* @param type $bEnable
* @return type
*/
public
function
render
(){
if
(
!
$this
->
bShowDebug
){
public
function
enableDebug
(
$bEnable
=
true
){
return
$this
->
bShowDebug
=!!
$bEnable
;
}
/**
* enable client debugging by a given array of allowed ip addresses
* @param array $aIpArray list of ip addresses in a flat array
* @return boolean
*/
public
function
enableDebugByIp
(
$aIpArray
){
$this
->
enableDebug
(
false
);
if
(
!
$_SERVER
||
!
is_array
(
$_SERVER
)
||
!
array_key_exists
(
"REMOTE_ADDR"
,
$_SERVER
)){
return
false
;
}
$sOut
=
''
;
if
(
array_search
(
$_SERVER
[
'REMOTE_ADDR'
],
$aIpArray
)
!==
false
){
$this
->
enableDebug
(
true
);
}
}
/**
* helper function: prepare array of added massages before output
* - detect warnings and errors
* - detect needed time for each action
* - detect longest action
* - detect maximum of memory usage
* - calculate total time
*
* @return array
*/
protected
function
_prepareRendering
(){
$iMem
=
memory_get_usage
();
$this
->
add
(
'<hr>'
);
$this
->
add
(
'Memory on start: '
.
number_format
(
$this
->
_iMemStart
,
0
,
'.'
,
','
)
.
" bytes"
);
$this
->
add
(
'Memory on end: '
.
number_format
(
$iMem
,
0
,
'.'
,
','
)
.
" bytes"
);
$this
->
add
(
'Memory peak: '
.
number_format
(
memory_get_peak_usage
(),
0
,
'.'
,
','
)
.
" bytes"
);
$aReturn
=
[
'totaltime'
=>
false
,
'level'
=>
false
,
'warnings'
=>
''
,
'errors'
=>
''
,
'maxrowid'
=>
false
,
'maxtime'
=>
false
,
'result'
=>
[]
];
$sStarttime
=
$this
->
aMessages
[
0
][
"time"
];
$iLasttime
=
$sStarttime
;
$iCounter
=
0
;
$sMaxRowId
=
false
;
$iMaxtime
=
-
1
;
$
sWarnings
=
false
;
$
iLasttime
=
$sStarttim
e
;
$
iMaxmem
=
-
1
;
$bHasWarning
=
false
;
$
bHasError
=
fals
e
;
foreach
(
$this
->
aMessages
as
$aLogentry
)
{
$iCounter
++
;
$sTrId
=
'debugTableRow'
.
$iCounter
;
if
(
$aLogentry
[
"level"
]
==
"warning"
){
$bHasWarning
=
true
;
}
if
(
$aLogentry
[
"level"
]
==
"error"
){
$bHasError
=
true
;
}
$sTrId
=
$this
->
sCssPrefix
.
'debugTableRow'
.
$iCounter
;
$iDelta
=
$aLogentry
[
"time"
]
-
$iLasttime
;
if
(
$iDelta
>
$iMaxtime
)
{
$iMaxtime
=
$iDelta
;
$sMaxRowId
=
$sTrId
;
}
$iMaxmem
=
max
(
$aLogentry
[
"memory"
],
$iMaxmem
);
$sStyle
=
(
$iDelta
>
1
)
?
'color: #f82;'
:
''
;
if
((
$iDelta
>
1
)){
$sWarnings
.
=
'<a href="#'
.
$sTrId
.
'" title="'
.
sprintf
(
"%01.4f"
,
$iDelta
)
.
' s">'
.
$iCounter
.
'</a> '
;
if
((
$iDelta
>
1
)
||
$aLogentry
[
"level"
]
==
"warning"
)
{
$aReturn
[
'warnings'
]
.
=
'<a href="#'
.
$sTrId
.
'" title="'
.
sprintf
(
"%01.4f"
,
$iDelta
)
.
' s">'
.
$iCounter
.
'</a> '
;
}
$sOut
.
=
'<tr class="'
.
$aLogentry
[
"level"
]
.
'" id="'
.
$sTrId
.
'" style="'
.
$sStyle
.
'">'
.
'<td>'
.
$iCounter
.
'</td>'
.
'<td>'
.
sprintf
(
"%01.3f"
,
$aLogentry
[
"time"
]
-
$sStarttime
)
.
'</td>'
.
'<td>'
.
sprintf
(
"%01.3f"
,
$iDelta
)
.
'</td>'
.
'<td>'
.
$aLogentry
[
"level"
]
.
'</td>'
.
'<td>'
.
$aLogentry
[
"message"
]
.
'</td>'
.
'</tr>'
;
if
(
$aLogentry
[
"level"
]
==
"error"
)
{
$aReturn
[
'errors'
]
.
=
'<a href="#'
.
$sTrId
.
'" title="'
.
sprintf
(
"%01.4f"
,
$iDelta
)
.
' s">'
.
$iCounter
.
'</a> '
;
}
$aReturn
[
'entries'
][]
=
[
'time'
=>
$aLogentry
[
"time"
],
'level'
=>
$aLogentry
[
"level"
],
'message'
=>
$aLogentry
[
"message"
],
'memory'
=>
sprintf
(
"%01.2f"
,
$aLogentry
[
"memory"
]
/
1024
/
1024
),
// MB
'trid'
=>
$sTrId
,
'trclass'
=>
$aLogentry
[
"level"
],
'counter'
=>
$iCounter
,
'timer'
=>
sprintf
(
"%01.3f"
,
$aLogentry
[
"time"
]
-
$sStarttime
),
'delta'
=>
sprintf
(
"%01.0f"
,
$iDelta
*
1000
),
];
$iLasttime
=
$aLogentry
[
"time"
];
}
$aReturn
[
'level'
]
=
(
$bHasWarning
?
(
$bHasError
?
'error'
:
'warning'
)
:
''
);
$aReturn
[
'maxrowid'
]
=
$sMaxRowId
;
$aReturn
[
'maxtime'
]
=
sprintf
(
"%01.3f"
,
$iMaxtime
);
$aReturn
[
'maxmem'
]
=
sprintf
(
"%01.2f"
,
$iMaxmem
/
1024
/
1024
);
$aReturn
[
'totaltime'
]
=
sprintf
(
"%01.3f"
,
$aLogentry
[
'time'
]
-
$aReturn
[
'entries'
][
0
][
'time'
]);
return
$aReturn
;
}
/**
* get html code for a progressbar with divs
* @param {int|float} $iVal value between 0..max value
* @param {int|float} $iMax max value
* @return {string}
*/
protected
function
_getBar
(
$iVal
,
$iMax
){
$iWidth
=
$iVal
/
$iMax
*
100
;
return
'<div class="bar"><div class="progress" style="width: '
.
$iWidth
.
'%;"> </div></div>'
;
}
/**
* render output of all logging messages
*/
public
function
render
()
{
if
(
!
$this
->
bShowDebug
){
return
false
;
}
$iTotal
=
$iLasttime
-
$sStarttime
;
if
(
$sWarnings
){
$sWarnings
=
'<br>warnings: '
.
$sWarnings
;
$aData
=
$this
->
_prepareRendering
();
/*
Array
(
[totaltime] => 0.006
[errors] =>
[warnings] => 3
[maxrowid] => debugTableRow3
[maxtime] => 0.005
[result] => Array
(
)
[entries] => Array
mit Elementen
Array
(
[time] => 1663959608.2566
[level] => info
[message] => Logger was initialized.
[memory] => 538056
[trid] => debugTableRow1
[trclass] => info
[trstyle] =>
[counter] => 1
[timer] => 0.000
[delta] => 0.000
)
*/
$sOut
=
''
;
// echo '<pre>'; print_r($aData); die();
foreach
(
$aData
[
'entries'
]
as
$aLogentry
){
$sOut
.
=
'<tr class="'
.
$this
->
sCssPrefix
.
'-level-'
.
$aLogentry
[
"level"
]
.
''
.
(
$aLogentry
[
"trid"
]
==
$aData
[
"maxrowid"
]
?
' '
.
$this
->
sCssPrefix
.
'-maxrow'
:
''
)
.
'" '
.
'id="'
.
$aLogentry
[
"trid"
]
.
'">'
.
'<td>'
.
$aLogentry
[
"counter"
]
.
'</td>'
.
'<td>'
.
$aLogentry
[
"level"
]
.
'</td>'
.
'<td>'
.
$aLogentry
[
"timer"
]
.
'</td>'
.
'<td>'
.
$this
->
_getBar
(
$aLogentry
[
"delta"
],
$aData
[
"maxtime"
]
*
1000
)
.
$aLogentry
[
"delta"
]
.
' ms'
.
(
$aLogentry
[
"delta"
]
==
$aData
[
'maxtime'
]
*
1000
?
' ⏱️'
:
''
)
.
'</td>'
.
'<td>'
.
$this
->
_getBar
(
$aLogentry
[
"memory"
],
$aData
[
"maxmem"
])
.
$aLogentry
[
"memory"
]
.
' MB'
.
'</td>'
.
'<td>'
.
$aLogentry
[
"message"
]
.
'</td>'
.
'</tr>'
;
}
if
(
$sOut
){
$sOut
=
'
<style>
.'
.
$this
->
sCssPrefix
.
'-info {position: fixed; top: 6em; right: 1em; background: rgba(200,228,255, 0.8); border: 1px solid; z-index: 99999;}
.'
.
$this
->
sCssPrefix
.
'-info .head {background: rgba(0,0,0,0.4); color: #fff;padding: 0em 0.5em 0.2em; }
.'
.
$this
->
sCssPrefix
.
'-info .content {padding: 0.5em; }
.'
.
$this
->
sCssPrefix
.
'-info .content .total {font-size: 160%; color: rgba(0,0,0,0.5); margin: 0.3em 0; display: inline-block;}
.'
.
$this
->
sCssPrefix
.
'-messages {margin: 5em 2em 2em;}
.'
.
$this
->
sCssPrefix
.
'-messages .bar {background: rgba(0,0,0,0.03); height: 1.4em; position: absolute; width: 6em; border-right: 1px solid rgba(0,0,0,0.2);}
.'
.
$this
->
sCssPrefix
.
'-messages .progress {background: rgba(100,140,180,0.2); height: 1.4em; padding: 0;}
.'
.
$this
->
sCssPrefix
.
'-messages table{background: #fff; color: #222;table-layout:fixed; }
.'
.
$this
->
sCssPrefix
.
'-messages table th{background: none;}
.'
.
$this
->
sCssPrefix
.
'-messages table th.barcol{min-width: 7em; position: relative;}
.'
.
$this
->
sCssPrefix
.
'-messages table td{padding: 3px; vertical-align: top;}
.'
.
$this
->
sCssPrefix
.
'-messages table th:hover{background:#aaa !important;}
if
(
$sOut
)
$sOut
=
'
<div style="position: fixed; right: 1em; top: 6em; background: rgba(255,80,80, 0.1); padding: 0.5em;">
<span style="font-size: 130%;">total: '
.
sprintf
(
"%01.3f"
,
$iTotal
)
.
' s</span><br>
<span>longest action: <a href="#'
.
$sMaxRowId
.
'">'
.
sprintf
(
"%01.3f"
,
$iMaxtime
)
.
' s</a></span>
<span>'
.
$sWarnings
.
'</span>
.'
.
$this
->
sCssPrefix
.
'-level-info{background: #e0e8f8; color:#124}
.'
.
$this
->
sCssPrefix
.
'-level-warning{background: #fcf8e3; color: #980;}
.'
.
$this
->
sCssPrefix
.
'-level-error{background: #fce0e0; color: #944;}
.'
.
$this
->
sCssPrefix
.
'-maxrow{color:#f33; font-weight: bold;}
</style>
<div class="'
.
$this
->
sCssPrefix
.
' '
.
$this
->
sCssPrefix
.
'-info '
.
$this
->
sCssPrefix
.
'-level-'
.
$aData
[
'level'
]
.
'">
<div class="head">ahLogger</div>
<div class="content">
<span class="total">⏱️ '
.
$aData
[
'totaltime'
]
.
' s</span><br>
🪲 <a href="#'
.
$this
->
sCssPrefix
.
'-messages">Debug infos</a> | 🔺 <a href="#">top</a><br>
<span>longest action: ⏱️ <a href="#'
.
$aData
[
'maxrowid'
]
.
'">'
.
(
$aData
[
'maxtime'
]
*
1000
)
.
' ms</a></span>
'
.
(
$aData
[
'errors'
]
?
'<br><span>‼️ Errors: '
.
$aData
[
'errors'
]
.
'</span>'
:
''
)
.
'
'
.
(
$aData
[
'warnings'
]
?
'<br><span>⚠️ Warnings: '
.
$aData
[
'warnings'
]
.
'</span>'
:
''
)
.
'
</div>
<br>
<br>
<br>
<br>
<br>
<h3>DEBUG</h3><br>
<table class="datatable table table-striped debugtable">
</div>
<div id="'
.
$this
->
sCssPrefix
.
'-messages" class="'
.
$this
->
sCssPrefix
.
' '
.
$this
->
sCssPrefix
.
'-messages">
DEBUG :: LOG MESSAGES<br>'
.
(
$aData
[
'errors'
]
?
'<span>Errors: '
.
$aData
[
'errors'
]
.
'</span><br>'
:
''
)
.
(
$aData
[
'warnings'
]
?
'<span>Warnings: '
.
$aData
[
'warnings'
]
.
'</span><br>'
:
''
)
.
'<br>
<table >
<thead>
<tr>
<th>#</th>
<th>delta to start time</th>
<th>delta to previuos</th>
<th>level</th>
<th>time [s]</th>
<th class="barcol">delta</th>
<th class="barcol">memory</th>
<th>message</th>
</tr></thead><tbody>
'
.
$sOut
.
'</tbody></table>'
.
'<script>$(\'#'
.
$sMaxRowId
.
'\').css(\'color\', \'#f00\');</script>'
;
;
}
return
$sOut
;
}
/**
...
...
@@ -154,32 +323,19 @@ class logger {
if
(
!
$this
->
bShowDebug
){
return
false
;
}
$sOut
=
''
;
$sStarttime
=
$this
->
aMessages
[
0
][
"time"
];
$iCounter
=
0
;
$sMaxRowId
=
false
;
$iMaxtime
=-
1
;
$sWarnings
=
false
;
$iLasttime
=
$sStarttime
;
$aData
=
$this
->
_prepareRendering
();
foreach
(
$this
->
aMessages
as
$aLogentry
){
$iCounter
++
;
$iDelta
=
$aLogentry
[
"time"
]
-
$iLasttime
;
$sOut
.
=
$aLogentry
[
"level"
]
.
' '
.
$iCounter
.
' '
.
sprintf
(
"%01.3f"
,
$aLogentry
[
"time"
]
-
$sStarttime
)
.
' '
.
sprintf
(
"%01.3f"
,
$iDelta
)
.
' '
.
$aLogentry
[
"level"
]
.
' '
$sOut
=
''
;
foreach
(
$aData
[
'entries'
]
as
$aLogentry
){
$sOut
.
=
$aLogentry
[
"timer"
]
.
' | '
.
$aLogentry
[
"delta"
]
.
' ms | '
.
$aLogentry
[
"level"
]
.
' | '
.
(
sprintf
(
"%01.3f"
,
$aLogentry
[
"memory"
]
/
1024
/
1024
))
.
' MB | '
.
$aLogentry
[
"message"
]
.
' '
.
"
\n
"
;
$iLasttime
=
$aLogentry
[
"time"
];
}
// $iTotal=$iLasttime-$sStarttime
;
$sOut
.
=
"
\n
Total time: "
.
$aData
[
'totaltime'
]
.
"
\n
"
;
return
$sOut
;
}
}
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment