Skip to content

Latest commit

 

History

History
200 lines (125 loc) · 6.62 KB

README_ZH.md

File metadata and controls

200 lines (125 loc) · 6.62 KB

molten

Build Status

molten是应用透明链路追踪工具。

molten追踪php核心调用库运行时信息并且按照zipkin/optracing格式输出信息。

molten提供多种sapi, 多种采样类型, 上报追踪状态, 模块控制和多种数据落地 类型等功能。

依赖于molten很容易构建基于php语言的分布式全链路追踪系统 目前已经运行在生产环境上千台机器上。

目录


  1. 安装
  2. 快速开始
  3. 配置
  4. 函数
  5. 验证
  6. 功能
  7. 贡献
  8. 许可

安装

以下是你需要做的安装molten在你的系统上。

phpize
./configure
make && make install

make install 复制 molten.so 到确切的位置, 但是你还需要开启模块在php配置中,编辑你自己的php.ini或者添加molten.ini在/etc/php5/conf.d, 并且添加如下内容:extension=molten.so

./configure 阶段, 你也可以添加 --enable-zipkin-header=yes 支持zipkin B3 header。

快速开始

cd example
sh run.sh

在浏览器中打开 http://127.0.0.1:9411/zipkin/, 能够看见链路信息。

如果你认为上述太简单,你可以做下面的操作。

cd example
sh complex.sh

怎么样,是不是很酷。

注意 如果没有看到详细信息,那么EndTime选项中添加1小时。

示例详细介绍

配置

基础配置

molten.enable 1开启0关闭, 默认 1

molten.service_name 设置应用服务名, 默认default。 现在支持添加 ini_set('molten.service_name', 'YOUR_PROJECT_NAME'); 到代码中来在同一套 PHP 环境中区分不同项目。

molten.tracing_cli 1追踪cli模式下信息, 0关闭, 默认0

采样配置

molten.sampling_type 类型类型, 1采样率控制, 2通过每分钟request数, 默认是1

molten.sampling_request 采样类型是请求数采样,每分钟的采样请求数, 默认是10

molten.sampling_rate_base 采样类型是采样率时,每个请求的采样几率, 默认是256

控制模块配置

molten.notify_uri 通知管理中心的uri。

上报模块配置

上报模块使用和数据模块相同的输出类型。

molten.report_interval 数据模块调用间隔, 默认 60

molten.report_limit 数据上报请求上限, 默认 100

数据模块

molten.sink_type 数据落地类型, 1 写入文件, 文件地址依赖molten.sink_log_path, 2 写入到标准输出, 3 写入到syslog中, 4 通过curl发送, 发送地址依赖 molten.sink_http_uri.

molten.output_type 输出全部追踪块(span)(1) 或者一行输出一个块(2)。

molten.sink_log_path 写入文件地址。

molten.sink_http_uri 发送http地址。

molten.sink_syslog_unix_socket 发送日志到syslog udp unixdomain日志收集源中。

追踪块配置

molten.span_format 追踪块格式(span), 不同的追踪系统选择zipkin 或者 zipkin_v2或者 opentracing

函数

molten_span_format() 获取当前追踪系统span格式, 返回zipkin或者opentracing字符串。

molten_get_traceid() 获取当前上下文的traceiid,返回16进制的字符串。

molten_set_traceid($trace_id) 设置当前上下文的额traceiid, 无返回。

验证

php -d extension=molten.so -d molten.enable=1 -d molten.sink_type=2 -d molten.tracing_cli=1 -d molten.sampling_rate=1 -r '$c=curl_init("http://localhost:12345");curl_exec($c);'

可以看到如下输出:

[{"traceId":"%s","name":"php_curl","version":"php-4","id":"1.1","parentId":"1","timestamp":%d,"duration":%d,"annotations":[{"value":"cs","timestamp":%d,"endpoint":{"serviceName":"%s","ipv4":"%s"}},{"value":"cr","timestamp":%d,"endpoint":{"serviceName":"%s","ipv4":"%s"}}],"binaryAnnotations":[{"key":"http.url","value":"http:\/\/localhost:12345\/","endpoint":{"serviceName":"%s","ipv4":"%s"}},{"key":"error","value":"Failed
connect to localhost:12345; Connection
refused","endpoint":{"serviceName":"%s","ipv4":"%s"}}]},{"traceId":"%s","name":"cli","version":"php-4","id":"1","timestamp":%d,"duration":%d,"annotations":[{"value":"sr","timestamp":%d,"endpoint":{"serviceName":"%s","ipv4":"%s"}},{"value":"ss","timestamp":%d,"endpoint":{"serviceName":"%s","ipv4":"%s"}}],"binaryAnnotations":[{"key":"path","value":"-","endpoint":{"serviceName":"%s","ipv4":"%s"}}]}]

功能

从上述配置中,你可以看到我们提供的功能。

拦截器

molten 拦截 curl,pdo,mysqli,redis,mongodb,memcached扩展,构建运行时追踪信息. 支持全链路追踪功能, molten 替换了curl_exec,curl_setopt,curl_setopt_array函数, 并且在请求中添加了链路头(x-w-traceid, x-w-spanid and so on)。

定制化的链路格式, 支持两个流行格式(zipkinopentracing)。

采样

两种不同的采样方式并且能够通过控制模块进行修改。

数据落地

molten当前支持3种数据落地方式,标准输出,文件,http。并且能够选择输出的位置。

控制

使用http协议控制探针的行为。

查看molten的状态, 通过GET方法请求http://domain/molten/status

输出内容如下,已经适配了prometheus格式。

# HELP molten_request_all Number of all request.
# TYPE molten_request_all counter
molten_request_all %d
# HELP molten_request_capture Number of request be capture.
# TYPE molten_request_capture counter
molten_request_capture %d
# HELP molten_sampling_type the type of sampling.
# TYPE molten_sampling_type gauge
molten_sampling_type %d
# HELP molten_sampling_rate the rate of sampling.
# TYPE molten_sampling_rate gauge
molten_sampling_rate %d
# HELP molten_sampling_request the request be capture one min.
# TYPE molten_sampling_request gauge
molten_sampling_request %d

修改molten采样方式, 使用POST方法请求http://domain/molten/status

数据是json格式,字段和配置项中的含义是一致的。

{"enable":1,"samplingType":2,"samplingRate":20,"samplingRequest":100}

上报

上报模块能够记录,molten并没有采样样到的关键数据信息。

Contributing

欢迎开发者们使molten变得更好。

您可以联系如下邮件列表来讨论。

[email protected]

[email protected]

你还可以通过以下方式贡献。

  • 提交issue
  • 通过pull request提交修改和功能。

协议

Apache License Version 2.0 see http://www.apache.org/licenses/LICENSE-2.0.html