SimpleLogger.php
8.87 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
<?php
/**
* Copyright (C) Alibaba Cloud Computing
* All rights reserved
*/
/**
* Class Aliyun_Log_SimpleLogger
* a wrapper for submit log message to server, to avoid post log frequently, using a internal cache for messages
* When the count of messages reach the cache size, SimpleLogger will post the messages in bulk, and reset the cache accordingly.
*/
class Aliyun_Log_SimpleLogger{
/**
* internal cache for log messages
* @var array
*/
private $logItems = [];
/**
* max size of cached messages
* @var int
*/
private $maxCacheLog;
/**
* log topic field
* @var
*/
private $topic;
/**
* max time before logger post the cached messages
* @var int
*/
private $maxWaitTime;
/**
* previous time for posting log messages
* @var int
*/
private $previousLogTime;
/**
* max storage size for cached messages
* @var int
*/
private $maxCacheBytes;
/**
* messages storage size for cached messages
* @var int
*/
private $cacheBytes;
/**
* log client which was wrappered by this logger
* @var log
*/
private $client;
/**
* log project name
* @var the
*/
private $project;
/**
* logstore name
* @var the
*/
private $logstore;
/**
* Aliyun_Log_Models_LogBatch constructor.
* @param $client log client
* @param $project the corresponding project
* @param $logstore the logstore
* @param $topic
* @param null $maxCacheLog max log items limitation, by default it's 100
* @param null $maxWaitTime max thread waiting time, bydefault it's 5 seconds
*/
public function __construct($client, $project, $logstore, $topic, $maxCacheLog = null, $maxWaitTime = null, $maxCacheBytes = null)
{
if(NULL === $maxCacheLog || !is_integer($maxCacheLog)){
$this->maxCacheLog = 100;
}else{
$this->maxCacheLog = $maxCacheLog;
}
if(NULL === $maxCacheBytes || !is_integer($maxCacheBytes)){
$this->maxCacheBytes = 256 * 1024;
}else{
$this->maxCacheBytes = $maxCacheBytes;
}
if(NULL === $maxWaitTime || !is_integer($maxWaitTime)){
$this->maxWaitTime = 5;
}else{
$this->maxWaitTime = $maxWaitTime;
}
if($client == null || $project == null || $logstore == null){
throw new Exception('the input parameter is invalid! create SimpleLogger failed!');
}
$this->client = $client;
$this->project = $project;
$this->logstore = $logstore;
$this->topic = $topic;
$this->previousLogTime = time();
$this->cacheBytes = 0;
}
/**
* add logItem to cached array, and post the cached messages when cache reach the limitation
* @param $cur_time
* @param $logItem
*/
private function logItem($cur_time, $logItem){
array_push($this->logItems, $logItem);
if ($cur_time - $this->previousLogTime >= $this->maxWaitTime || sizeof($this->logItems) >= $this->maxCacheLog
|| $this->cacheBytes >= $this->maxCacheBytes)
{
$this->logBatch($this->logItems, $this->topic);
$this->logItems = [];
$this->previousLogTime = time();
$this->cacheBytes = 0;
}
}
/**
* log single string message
* @param Aliyun_Log_Models_LogLevel_LogLevel $logLevel
* @param $logMessage
* @throws Exception
*/
private function logSingleMessage(Aliyun_Log_Models_LogLevel_LogLevel $logLevel, $logMessage){
if(is_array($logMessage)){
throw new Exception('array is not supported in this function, please use logArrayMessage!');
}
$cur_time = time();
$contents = array( // key-value pair
'time'=>date('m/d/Y h:i:s a', $cur_time),
'loglevel'=> Aliyun_Log_Models_LogLevel_LogLevel::getLevelStr($logLevel),
'msg'=>$logMessage
);
$this->cacheBytes += strlen($logMessage) + 32;
$logItem = new Aliyun_Log_Models_LogItem();
$logItem->setTime($cur_time);
$logItem->setContents($contents);
$this->logItem($cur_time, $logItem);
}
/**
* log array message
* @param Aliyun_Log_Models_LogLevel_LogLevel $logLevel
* @param $logMessage
* @throws Exception
*/
private function logArrayMessage(Aliyun_Log_Models_LogLevel_LogLevel $logLevel, $logMessage){
if(!is_array($logMessage)){
throw new Exception('input message is not array, please use logSingleMessage!');
}
$cur_time = time();
$contents = array( // key-value pair
'time'=>date('m/d/Y h:i:s a', $cur_time)
);
$contents['logLevel'] = Aliyun_Log_Models_LogLevel_LogLevel::getLevelStr($logLevel);
foreach ($logMessage as $key => $value)
{
$contents[$key] = $value;
$this->cacheBytes += strlen($key) + strlen($value);
}
$this->cacheBytes += 32;
$logItem = new Aliyun_Log_Models_LogItem();
$logItem->setTime($cur_time);
$logItem->setContents($contents);
$this->logItem($cur_time, $logItem);
}
/**
* submit string log message with info level
* @param $logMessage
*/
public function info( $logMessage){
$logLevel = Aliyun_Log_Models_LogLevel_LogLevel::getLevelInfo();
$this->logSingleMessage($logLevel, $logMessage);
}
/**
* submit string log message with debug level
* @param $logMessage
*/
public function debug($logMessage){
$logLevel = Aliyun_Log_Models_LogLevel_LogLevel::getLevelDebug();
$this->logSingleMessage($logLevel, $logMessage);
}
/**
* submit string log message with warn level
* @param $logMessage
*/
public function warn($logMessage){
$logLevel = Aliyun_Log_Models_LogLevel_LogLevel::getLevelWarn();
$this->logSingleMessage($logLevel, $logMessage);
}
/**
* submit string log message with error level
* @param $logMessage
*/
public function error($logMessage){
$logLevel = Aliyun_Log_Models_LogLevel_LogLevel::getLevelError();
$this->logSingleMessage($logLevel, $logMessage);
}
/**
* submit array log message with info level
* @param $logMessage
*/
public function infoArray($logMessage){
$logLevel = Aliyun_Log_Models_LogLevel_LogLevel::getLevelInfo();
$this->logArrayMessage($logLevel, $logMessage);
}
/**
* submit array log message with debug level
* @param $logMessage
*/
public function debugArray($logMessage){
$logLevel = Aliyun_Log_Models_LogLevel_LogLevel::getLevelDebug();
$this->logArrayMessage($logLevel, $logMessage);
}
/**
* submit array log message with warn level
* @param $logMessage
*/
public function warnArray($logMessage){
$logLevel = Aliyun_Log_Models_LogLevel_LogLevel::getLevelWarn();
$this->logArrayMessage($logLevel, $logMessage);
}
/**
* submit array log message with error level
* @param $logMessage
*/
public function errorArray( $logMessage){
$logLevel = Aliyun_Log_Models_LogLevel_LogLevel::getLevelError();
$this->logArrayMessage($logLevel, $logMessage);
}
/**
* get current machine IP
* @return string
*/
private function getLocalIp(){
$local_ip = getHostByName(php_uname('n'));
if(strlen($local_ip) == 0){
$local_ip = getHostByName(getHostName());
}
return $local_ip;
}
/**
* submit log messages in bulk
* @param $logItems
* @param $topic
*/
private function logBatch($logItems, $topic){
$ip = $this->getLocalIp();
$request = new Aliyun_Log_Models_PutLogsRequest($this->project, $this->logstore,
$topic, $ip, $logItems);
$error_exception = NULL;
for($i = 0 ; $i < 3 ; $i++)
{
try{
$response = $this->client->putLogs($request);
return;
} catch (Aliyun_Log_Exception $ex) {
$error_exception = $ex;
} catch (Exception $ex) {
var_dump($ex);
$error_exception = $ex;
}
}
if ($error_exception != NULL)
{
var_dump($error_exception);
}
}
/**
* manually flush all cached log to log server
*/
public function logFlush(){
if(sizeof($this->logItems) > 0){
$this->logBatch($this->logItems, $this->topic);
$this->logItems = [];
$this->previousLogTime= time();
$this->cacheBytes = 0;
}
}
function __destruct() {
if(sizeof($this->logItems) > 0){
$this->logBatch($this->logItems, $this->topic);
}
}
}