httplog 技术文档
2024-12-26 02:35:33作者:蔡丛锟
1. 安装指南
httplog
是一个用于记录应用程序发出的 HTTP 请求的 Ruby gem。它可以帮助调试 API 错误响应,或者简单地了解应用程序底层的 HTTP 请求情况。
安装步骤
要安装 httplog
,请使用以下命令:
gem install httplog
环境要求
httplog
需要 Ruby 2.6 或更高版本。
2. 项目的使用说明
基本使用
在项目中引入 httplog
,并确保在引入 HTTP 库之后引入 httplog
:
require 'httplog'
默认情况下,httplog
会将所有发出的 HTTP 请求及其响应记录到 $stdout
,日志级别为 DEBUG
。
内容类型注意事项
- 二进制数据(由
Content-Type
头指示)不会被记录。 - 文本数据(如
text/*
和大多数application/*
类型)会被编码为 UTF-8,无效字符会被替换。
3. 项目 API 使用文档
配置选项
httplog
提供了丰富的配置选项,可以通过以下方式进行配置:
HttpLog.configure do |config|
# 启用或禁用所有日志记录
config.enabled = true
# 指定日志记录器或日志记录方法
config.logger = Logger.new($stdout)
config.logger_method = :log
# 日志级别
config.severity = Logger::Severity::DEBUG
# 配置记录哪些 HTTP 请求部分
config.log_connect = true
config.log_request = true
config.log_headers = false
config.log_data = true
config.log_status = true
config.log_response = true
config.log_benchmark = true
# 将所有请求记录为单行
config.compact_log = false
# 以 JSON 格式记录日志
config.json_log = false
# 美化输出
config.color = false
# 根据 URL 模式限制日志记录
config.url_whitelist_pattern = nil
config.url_blacklist_pattern = nil
# 屏蔽请求和响应 JSON 数据中的敏感信息
config.url_masked_body_pattern = nil
# 指定自定义的 JSON 解析器
config.json_parser = JSON
# Graylog 日志格式配置
config.graylog_formatter = nil
# 屏蔽敏感请求参数
config.filter_parameters = %w[password]
# 自定义日志前缀
config.prefix = ->{ "[httplog] #{Time.now} " }
end
Rails 应用中的配置
在 Rails 应用中,建议根据环境进行配置。不要在全局初始化器中配置 httplog
,因为在生产环境中 HttpLog
可能未定义。
# config/environments/development.rb
HttpLog.configure do |config|
config.logger = Rails.logger
end
颜色化输出
你可以通过以下方式为日志输出添加颜色:
HttpLog.configure do |config|
config.color = :red
end
或者为文本和背景指定颜色:
HttpLog.configure do |config|
config.color = {color: :black, background: :yellow}
end
Graylog 日志记录
如果你使用 Graylog,可以通过以下配置使用其搜索功能:
FORMATTER = Lograge::Formatters::KeyValue.new
HttpLog.configure do |config|
config.logger = <your GELF::Logger>
config.logger_method = :add
config.severity = GELF::Levels::DEBUG
config.graylog_formatter = FORMATTER
end
紧凑日志记录
如果你觉得日志过于冗长,可以启用紧凑日志记录:
HttpLog.configure do |config|
config.compact_log = true
end
JSON 日志记录
如果你希望以 JSON 格式记录日志,可以启用 JSON 日志记录:
HttpLog.configure do |config|
config.json_log = true
end
参数过滤
你可以通过以下方式过滤敏感参数:
HttpLog.configure do |config|
config.filter_parameters = %w[password]
end
4. 项目安装方式
通过 Gemfile 安装
如果你使用 Bundler 管理依赖,可以在 Gemfile
中添加以下内容:
gem 'httplog'
然后运行 bundle install
安装 gem。
直接安装
你也可以通过以下命令直接安装 httplog
:
gem install httplog
5. 示例
以下是一个使用默认配置的日志输出示例:
[httplog] Connecting: localhost:80
[httplog] Sending: GET http://localhost:9292/index.html
[httplog] Status: 200
[httplog] Benchmark: 0.00057 seconds
[httplog] Response:
<html>
<head>
<title>Test Page</title>
</head>
<body>
<h1>This is the test page.</h1>
</body>
</html>
6. 已知问题
- 除了 GET 和 POST 请求,其他类型的请求可能不会被记录。
- 使用 OpenURI 时,HTTP 响应体的读取是延迟的,因此无法立即记录。
- 使用 HTTPClient 时,TCP 连接的建立会在 HTTP 请求和头信息之后记录。
7. 总结
httplog
是一个强大的开发调试工具,能够帮助你记录和分析应用程序发出的 HTTP 请求。通过灵活的配置选项,你可以根据需要定制日志记录的方式。请注意,httplog
不推荐在生产环境中使用。
登录后查看全文
热门项目推荐
- DDeepSeek-V3.1-BaseDeepSeek-V3.1 是一款支持思考模式与非思考模式的混合模型Python00
- QQwen-Image-Edit基于200亿参数Qwen-Image构建,Qwen-Image-Edit实现精准文本渲染与图像编辑,融合语义与外观控制能力Jinja00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~042CommonUtilLibrary
快速开发工具类收集,史上最全的开发工具类,欢迎Follow、Fork、StarJava04GitCode百大开源项目
GitCode百大计划旨在表彰GitCode平台上积极推动项目社区化,拥有广泛影响力的G-Star项目,入选项目不仅代表了GitCode开源生态的蓬勃发展,也反映了当下开源行业的发展趋势。06GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!C0298- WWan2.2-S2V-14B【Wan2.2 全新发布|更强画质,更快生成】新一代视频生成模型 Wan2.2,创新采用MoE架构,实现电影级美学与复杂运动控制,支持720P高清文本/图像生成视频,消费级显卡即可流畅运行,性能达业界领先水平Python00
- GGLM-4.5-AirGLM-4.5 系列模型是专为智能体设计的基础模型。GLM-4.5拥有 3550 亿总参数量,其中 320 亿活跃参数;GLM-4.5-Air采用更紧凑的设计,拥有 1060 亿总参数量,其中 120 亿活跃参数。GLM-4.5模型统一了推理、编码和智能体能力,以满足智能体应用的复杂需求Jinja00
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手HTML013
热门内容推荐
最新内容推荐
项目优选
收起

React Native鸿蒙化仓库
C++
176
261

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
858
511

openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
258
298

🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K

本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371

一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4

为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0

deepin linux kernel
C
22
5