fx-crash-sig

符号化崩溃ping并生成签名。

获取崩溃ping堆栈跟踪并

1. 使用 Mozilla符号化服务 符号化崩溃ping堆栈跟踪
2. 使用 socorro-siggen 库生成崩溃签名

项目详情

• 代码： https://github.com/mozilla/fx-crash-sig
• 问题： https://github.com/mozilla/fx-crash-sig/issues
• 许可证：MPL v2
• 文档：此README

安装（从 PyPI）

pip install fx-crash-sig

使用

示例脚本:

import json

from fx_crash_sig.crash_processor import CrashProcessor

with open("crashping.json") as fp:
    crash_ping = json.load(fp)

crash_processor = CrashProcessor()

signature_result = crash_processor.get_signature(crash_ping)
print(signature_result.signature)

命令行（使用 sample.json）

cat sample.json | fx-crash-sig

运行此命令以获取更多命令行帮助

fx-crash-sig --help

最小崩溃ping结构

旧版崩溃ping（pingsender的版本--不是glean的版本）在此处文档化

https://firefox-source-docs.mozilla.ac.cn/toolkit/components/telemetry/data/crash-ping.html

这些是我们使用的旧版崩溃ping的部分

- normalized_os                (optional)
- payload:
  - metadata:
    - async_shutdown_timeout   (optional)
    - ipc_channel_error        (optional)
    - oom_allocation_size      (optional)
    - moz_crash_reason         (optional)
  - stack_traces:
    - crash_info:
      - crashing_thread
      - type
    - modules[]
      - debug_file
      - debug_id
      - filename
      - base_addr
    - threads[]
      - frames[]
         - ip
         - module_index
         - trust

API

fx_crash_sig.crash_processor

• CrashProcessor：为旧版崩溃ping符号化和生成签名
  • __init__
    • 参数： max_frames： int (40)
    • 参数： api_url： str (https://symbolication.services.mozilla.com/symbolicate/v5)
    • 参数： verbose： bool
  • get_signature：接受崩溃ping结构，使用Mozilla符号化服务对其进行符号化，生成签名，并返回签名结果。
    • 签名
      • 参数: crash_ping: 字典
      • 返回值: siggen.generator.Result
  • symbolicate: 对崩溃ping结构有效载荷中的堆栈跟踪进行符号化。
    • 签名
      • 参数: crash_ping: 字典
      • 返回值: 符号化的堆栈跟踪
  • get_signature_from_symbolicated: 接收symbolicate的输出，生成签名，并返回签名结果。
    • 签名
      • 参数: symbolicated: 字典
      • 返回值: siggen.generator.Result

fx_crash_sig.symbolicate

• Symbolicator: 符号化堆栈跟踪
  • __init__
    • 参数： max_frames： int (40)
    • 参数： api_url： str (https://symbolication.services.mozilla.com/symbolicate/v5)
    • 参数： verbose： bool
  • symbolicate: 符号化单个堆栈跟踪。
    • 参数: stack_trace: 字典
    • 返回值: 符号化的堆栈跟踪
  • symbolicate_multi: 符号化一系列堆栈跟踪。
    • 参数: stack_traces: 字典列表
    • 返回值: 符号化的跟踪列表