1 Star 0 Fork 15

yc8332 / fierysdk

forked from weiboad / fierysdk 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

RagnarSDK 埋点库

简介

  • 系统逐渐复杂后,多会依赖多个接口进行工作。但是由于网络等原因线上出现故障不能很快发现、定位、排查,依赖越多系统的调试愈发困难。
  • 支持在线调试,在线调整分级日志级别,错误发现及警报,性能统计跟踪,接口依赖关系等功能。
  • 后续项目都会使用此SDK,之前Ragnar版本将不再提交新特性仅维护

安装及植入说明

Nginx配置

拷贝 nginx/fiery_fastcgi_pararms 到 nginx的conf文件夹,并把他include到vhost配置内

    server{
        listen 80;
        charset utf-8;
        root /path/xxx/xxx/src/public;
        server_name xxx.com;
        
        location /{
            index index.php index.html index.htm;
            if (-f $request_filename) {
                break;
            }
            if (-d $request_filename) {
                break;
            }
            if ($request_filename !~ (\.css|images|index\.php.*) ) {
                rewrite ^/(.*)$ /index.php/$1 last;
                break;
            }
        }
    
        location ~ /index.php/ {
            fastcgi_index index.php;
            fastcgi_pass 127.0.0.1:9000;
            include fastcgi_params;
            include fiery_fastcgi_params; # 这里
            fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
            fastcgi_read_timeout 600;
        }
    
        location ~ \.php$ {
            fastcgi_index index.php;
            fastcgi_pass 127.0.0.1:9000;
            include fastcgi_params;
            include fiery_fastcgi_params; # 这里
            fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
            fastcgi_read_timeout 600;
        }
    }
# nginx重新加载配置
nginx -s reload

Apache 配置环境变量

<VirtualHost *:80>
    ServerAdmin webmaster@demo.com
    DocumentRoot "e:\wwwroot\demo"
    ServerName my.demo.com
    ErrorLog "logs/my.demo.com-error.log"
    CustomLog "logs/my.demo.com-access.log" common
    
    # apache可以直接在配置内设置相关变量
    SetEnv RAGNAR_LOGPATH /data1/ragnar/  # 这里
    SetEnv RAGNAR_IDC 0  # 这里
    SetEnv RAGNAR_IP 192.168.1.123  # 这里

    <Directory "e:\wwwroot\demo">
        Options Indexes FollowSymLinks
        AllowOverride All
        Require all granted
    </Directory>
</VirtualHost>

Ragnar 埋点库植入说明

在项目框架初始化入口初始化Ragnar

    require_once("ragnarsdk/src/MidTool.php");
    require_once("ragnarsdk/src/RagnarConst.php");
    require_once("ragnarsdk/src/RagnarSDK.php");
    require_once("ragnarsdk/src/Traceid.php");
    require_once("ragnarsdk/src/Util.php");
    
    use \Adinf\RagnarSDK\RagnarSDK as RagnarSDK;
    use \Adinf\RagnarSDK\RagnarConst as RagnarConst;
    
    //若需要临时禁用Ragnar可以取消下面一行代码注释
    //RagnarSDK::disable();
    
    //默认开启info日志级别,低于此级别的日志不会被记录,建议将此日志集成到框架内分级日志内
    RagnarSDK::setLogLevel(RagnarConst::LOG_TYPE_INFO); 
    
    // url自定义过滤回调函数
    //如果存在特殊url如 http://wwwei.com/usr/uid参数/fetch 
    //这类特殊url,需要再下面函数内做个过滤如过滤成 http://wwwei.com/usr/releaced/fetch
    //否则会导致api统计不准确
    RagnarSDK::setUrlFilterCallback(function ($url, $hashquery) {
        if (trim($url) == "") {
            return "";
        }
        if (stripos($url, 'http') !== 0) {
            $url = "http://" . $url;
        }

        $urlinfo = parse_url($url);

        if(!$urlinfo){
            return $url."#PARSERERROR";
        }

        if (!isset($urlinfo["scheme"])) {
            $urlinfo["scheme"] = "http";
        }

        if (!isset($urlinfo["path"])) {
            $urlinfo["path"] = "/";
        }

        if (!isset($urlinfo["query"])) {
            $urlinfo["query"] = "";
        }

        if ($hashquery) {
            return $urlinfo["scheme"] . "://" . $urlinfo["host"] . $urlinfo["path"] . "?" . $urlinfo["query"];
        } else {
            return $urlinfo["scheme"] . "://" . $urlinfo["host"] . $urlinfo["path"];
        }
     });

    //这个函数一定要在所有shutdown之后执行,否则会少记录一些内容
    //ragnar_projectname为日志输出子路径目录名称,每个项目建议设置一个独立的名称
    RagnarSDK::init("ragnar_projectname");
    
    //Ragnar 分级日志写入示范
    RagnarSDK::RecordLog(RagnarConst::LOG_TYPE_INFO, __FILE__, __LINE__, "module1_msg", array("msg"=>"i wish i can fly!");
    RagnarSDK::RecordLog(RagnarConst::LOG_TYPE_ERROR, __FILE__, __LINE__, "module2_msg", array("msg"=>"i wish i'm rich!");
    
    //Ragnar 性能日志手动性能埋点示范  ragnar_test 建议格式 curl mysql 等 (curl mysql在下面已经定义了格式,请参考如下使用)
    $digpooint = RagnarSDK::digLogStart(__FILE__,__LINE__,"ragnar_test");
    
        //run something.....
    
    RagnarSDK::digLogEnd($digpooint,array("happy"=>1));
    

Ragnar 日志功能介绍

  • 日志分级:在项目中直接使用Ragnar业务日志功能支持在线调试,可以通过密文更改本次请求接口的业务日志级别。
  • 日志索引:所有符合业务级别的日志都会被记录到系统内,通过本次接口的Traceid即可查看到所有此次接口相关调用及级别相关日志输出信息。
  • 错误警报:一些在程序运行过程中产生错误,可以通过设置日志级别发送错误信息到管理平台,平台提供“去重”后的错误信息及警报邮件短信功能。
  • 性能日志:RagnarSDK自带性能埋点函数(digstart/digend),通过埋点函数可以针对一些关键功能点的运行耗时进行监控,平台会对监控接口进行汇总统计

日志类型及级别介绍

  • LOG_TYPE_TRACE 最低级别,用来输出变量内容,仅用于调试开发或者在线调试
  • LOG_TYPE_DEBUG Debug日志,辅助debug信息
  • LOG_TYPE_NOTICE 警告通知类日志信息
  • LOG_TYPE_INFO 可阅读的一些提示信息
  • LOG_TYPE_ERROR 系统错误信息日志,此日志信息一旦产生会在平台错误统计内去重列出
  • LOG_TYPE_EMEGENCY 系统警报信息日志,此日志信息一旦产生会在平台错误统计内去重列出,并发送邮件短信通知
  • LOG_TYPE_EXCEPTION 系统异常信息日志,此日志信息一旦产生会在平台错误统计内去重列出
  • LOG_TYPE_PERFORMENCE 所有性能埋点函数产生的日志信息,使用的时候请使用示范的标准格式,否则平台渲染会出现问题

Curl 埋点建议

curl埋点建议,key请沿用否则会在ragnar展示有问题,如果按照这个方式埋点,可以记录curl请求时间,结果,以及调用链关系(如果对方api也装了这个埋点库的话能看到调用链)

    //curl字符串不要改
    $digpooint = RagnarSDK::digLogStart(__FILE__, __LINE__, "curl");
    
    //curl init 代码 省略...
    
    $nextrpcidheader = RagnarSDK::getCurlChildCallParam($digpooint);//这里很关键
    curl_setopt($this->ch, CURLOPT_HTTPHEADER, $nextrpcidheader);
    
    $result = //curl exec 代码 省略...
    
    $ext = array("errorno" => $errno, "error" => curl_error($this->ch));
    $info = curl_getinfo($this->ch);
    
    //digCurlEnd($digPoint, $url, $method, $postParam, $getParam, $curlInfo, $errCode, $errMsg, $result)

    RagnarSDK::digLogEnd($digpooint, array(
                "url" => $info['url'], "method" => self::get_method(),
                "param" => array("post" => $this->post_fields, "get" => $this->query_fields),
                "info" => $info,
                "error" => $ext,
                "result" => json_decode($result,true),//must array

    );

Mysql 埋点

Mysql埋点建议,请沿用key及常量字段,按以下方式埋点后可以记录每个sql的执行情况及性能,并且能够清晰记录异常

    //这个放在query操作上出现exception情况,用于记录异常信息
    RagnarSDK::RecordLog(\Adinf\Ragnar\Ragnar::LOG_TYPE_EXCEPTION, __FILE__, __LINE__, "mysql", array("fun" => "query", "sql" => $sql, "error" => $ex->getMessage()));
    
    //这个放在查询前,用于性能监控
    $digpooint = RagnarSDK::digLogStart(__FILE__, __LINE__, "mysql");
    
    //do some sql execute
    
    //这个放在查询后,用于性能监控
    //RagnarSDK::digMysqlEnd($digPoint, $sql, "sql的参数", "select\delete\update\...", "execute_sql");
    RagnarSDK::digLogEnd($digpooint, array("sql" => $sql, "data" => "sql的参数", "op" => "select\delete\update\...", "fun" => "execute_sql"));
    
    //如果查询后错误
    if(error){
        RagnarSDK::RecordLog(RagnarSDK::LOG_TYPE_EXCEPTION, __FILE__, __LINE__, "mysql", array("fun" => "execute", "sql" => $sql, "error" => $error));
    }

在线调试

在请求埋点RagnarSDK的接口时,Header头内带上以下Header可以产生对应的效果,于此同时,接口返回的http请求会带Header如下

    X-RAGNAR-TRACEID   此次请求的唯一标识uuid 不建议请求时带这个
    X-RAGNAR-RPCID     此次请求的调用层级计数器
    X-RAGNAR-LOGLEVEL  此次要记录的日志等级,可以实时更改此次请求输出的日志级别
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

PHP分布式跟踪系统埋点库 展开 收起
PHP
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
PHP
1
https://gitee.com/yc8332/fierysdk.git
git@gitee.com:yc8332/fierysdk.git
yc8332
fierysdk
fierysdk
master

搜索帮助

14c37bed 8189591 565d56ea 8189591