├── .gitignore ├── LICENSE ├── README.md ├── composer.json └── src └── Seaslog.php /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # think-seaslog 2 | 3 | ThinkPHP 5.0 SeasLog 日志扩展 4 | 5 | ## 安装 6 | 7 | ~~~ 8 | composer require topthink/think-seaslog 9 | ~~~ 10 | 11 | ## 配置 12 | 13 | 日志配置文件的type参数设置为 seaslog 14 | 15 | 目前仅支持的配置参数 16 | 17 | |参数|描述| 18 | |---|---| 19 | | path |基础目录| 20 | | logger |设置logger名称| 21 | | json |是否使用JSON格式| 22 | 23 | 由于目前seaslog不支持动态配置,因此其它配置请在php.ini 中配置。 24 | 25 | 注意:如果开启JSON格式记录,请务必设置default_template参数 仅记录日志内容 26 | 27 | ~~~ 28 | seaslog.default_template = "%M" 29 | ~~~ 30 | 31 | 关于SeasLog的更多使用参考php手册中的SeasLog章节 -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "topthink/think-seaslog", 3 | "description": "SeasLog extend for thinkphp5.0", 4 | "license": "Apache-2.0", 5 | "type": "think-extend", 6 | "authors": [ 7 | { 8 | "name": "liu21st", 9 | "email": "liu21st@gmail.com" 10 | } 11 | ], 12 | "require": { 13 | "topthink/framework": "^5.0" 14 | }, 15 | "autoload": { 16 | "psr-4": { 17 | "think\\log\\driver\\": "src" 18 | }, 19 | "files": [ 20 | ] 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /src/Seaslog.php: -------------------------------------------------------------------------------- 1 | 10 | // +---------------------------------------------------------------------- 11 | 12 | namespace think\log\driver; 13 | 14 | use think\App; 15 | use think\Request; 16 | 17 | /** 18 | * 本地化调试输出到文件 19 | */ 20 | class Seaslog 21 | { 22 | protected $config = [ 23 | 'time_format' => ' c ', 24 | 'path' => LOG_PATH, 25 | 'logger' => '', 26 | 'json' => false, 27 | ]; 28 | 29 | // 实例化并传入参数 30 | public function __construct($config = []) 31 | { 32 | if (is_array($config)) { 33 | $this->config = array_merge($this->config, $config); 34 | } 35 | 36 | \SeasLog::setBasePath($this->config['path']); 37 | 38 | if ($this->config['logger']) { 39 | \SeasLog::setLogger($this->config['logger']); 40 | } 41 | } 42 | 43 | /** 44 | * 日志写入接口 45 | * @access public 46 | * @param array $log 日志信息 47 | * @param bool $append 是否追加请求信息 48 | * @return bool 49 | */ 50 | public function save(array $log = [], $append = false) 51 | { 52 | if (PHP_SAPI != 'cli') { 53 | if (!$this->config['json']) { 54 | \SeasLog::log('info', $this->parseLog()); 55 | } 56 | // 添加调试日志 57 | if (App::$debug && $append && !$this->config['json']) { 58 | \SeasLog::log('debug', $this->getDebugLog()); 59 | } 60 | } 61 | 62 | foreach ($log as $type => $val) { 63 | if ($this->config['json']) { 64 | $info[$type] = $val; 65 | } else { 66 | \SeasLog::log($type, implode("\n\r", $val)); 67 | } 68 | } 69 | 70 | if (!empty($info)) { 71 | if (isset($info['info'])) { 72 | array_unshift($info['info'], $this->parseLog(true)); 73 | } else { 74 | $info['info'][] = $this->parseLog(true); 75 | } 76 | 77 | if (App::$debug && $append) { 78 | if (isset($info['debug'])) { 79 | array_unshift($info['debug'], $this->getDebugLog(true)); 80 | } else { 81 | $info['debug'][] = $this->getDebugLog(true); 82 | } 83 | } 84 | 85 | \SeasLog::log('info', json_encode($info, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES)); 86 | } 87 | 88 | return \SeasLog::flushBuffer(); 89 | } 90 | 91 | /** 92 | * 追加请求日志 93 | * @access protected 94 | * @param bool $json 是否JSON格式 95 | * @return string 96 | */ 97 | protected function parseLog($json = false) 98 | { 99 | $request = Request::instance(); 100 | $info = [ 101 | 'timestamp' => date($this->config['time_format']), 102 | 'ip' => $request->ip(), 103 | 'method' => $request->method(), 104 | 'host' => $request->host(), 105 | 'uri' => $request->url(), 106 | ]; 107 | 108 | if ($json) { 109 | return json_encode($info, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES); 110 | } 111 | 112 | return "---------------------------------------------------------------\r\n[{$info['timestamp']}] {$info['ip']} {$info['method']} {$info['host']}{$info['uri']}"; 113 | } 114 | 115 | /** 116 | * 追加调试日志 117 | * @access protected 118 | * @param bool $json 是否JSON格式 119 | * @return string 120 | */ 121 | protected function getDebugLog($json = false) 122 | { 123 | if ($json) { 124 | // 获取基本信息 125 | $runtime = round(microtime(true) - THINK_START_TIME, 10); 126 | $reqs = $runtime > 0 ? number_format(1 / $runtime, 2) : '∞'; 127 | 128 | $memory_use = number_format((memory_get_usage() - THINK_START_MEM) / 1024, 2); 129 | 130 | $info = [ 131 | 'runtime' => number_format($runtime, 6) . 's', 132 | 'reqs' => $reqs . 'req/s', 133 | 'memory' => $memory_use . 'kb', 134 | 'file' => count(get_included_files()), 135 | ]; 136 | return json_encode($info, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES); 137 | } 138 | // 增加额外的调试信息 139 | $runtime = round(microtime(true) - THINK_START_TIME, 10); 140 | $reqs = $runtime > 0 ? number_format(1 / $runtime, 2) : '∞'; 141 | 142 | $memory_use = number_format((memory_get_usage() - THINK_START_MEM) / 1024, 2); 143 | 144 | $time_str = '[运行时间:' . number_format($runtime, 6) . 's] [吞吐率:' . $reqs . 'req/s]'; 145 | $memory_str = ' [内存消耗:' . $memory_use . 'kb]'; 146 | $file_load = ' [文件加载:' . count(get_included_files()) . ']'; 147 | 148 | return $time_str . $memory_str . $file_load; 149 | 150 | } 151 | } 152 | --------------------------------------------------------------------------------