php做定位跟踪系统,fierysdk

RagnarSDK 埋点库

简介

系统逐渐复杂后，多会依赖多个接口进行工作。但是由于网络等原因线上出现故障不能很快发现、定位、排查，依赖越多系统的调试愈发困难。

支持在线调试，在线调整分级日志级别，错误发现及警报，性能统计跟踪，接口依赖关系等功能。

后续项目都会使用此SDK，之前Ragnar版本将不再提交新特性仅维护

安装及植入说明

PHP5.3以上版本方可使用，并安装bcmath扩展

仅限编码utf-8项目使用

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 配置环境变量

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 # 这里

Options Indexes FollowSymLinks

AllowOverride All

Require all granted

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 此次要记录的日志等级，可以实时更改此次请求输出的日志级别