plcrashreporter

plcrashreporter

Plcrashreporter是一个可靠的开源库，可在iOS，MACOS和TVOS上使用一个内部的实时崩溃报告框架。该库检测到崩溃并生成报告，以帮助您调查和对应用程序，系统，过程，线程等以及堆栈痕迹的信息进行故障排除。

使用plcrashreporter的最简单方法是使用AppCenter。但是，如果您想直接使用plcrashreporter，请在发行页面上获取最新版本。

特征

• 仅使用支持和公共API/ABI进行崩溃报告。
• 使用矮人和Apple Compact Undind框架数据，最准确的堆栈可用。
• 首次于2008年发行，并用于数十万个应用程序。 Plcrashreporter看到了大量的用户测试。
• 不会干扰LLDB/GDB中的调试
• 提供了所有活动线程的回程。
• 为崩溃的线程提供完整的注册状态。

先决条件

• XCode 11或更高。
• 最低支持的平台：iOS 12，MACOS 11.5，TVOS 12，MAC Catalyst 13.0。

解码崩溃报告

崩溃报告是作为原始图编码的消息输出的，并且可以使用CrashReporter库或任何Google协议缓冲区解码器进行解码。

除了上图内的解码支持外，您还可以使用随附的plcrashutil二进制文件将崩溃报告转换为苹果的标准iPhone文本格式：

 plcrashutil convert -- format = iphone example_report . plcrash

您可以使用atos命令行工具来象征输出。有关此工具的更多信息，请参见在崩溃报告中添加可识别的符号名称。未来的库版本可能包括内置可重复使用的格式器，用于直接从手机输出替代格式。

将Plcrashreporter添加到您的项目中

可以通过Cocoapods，Carthage，Swift Package Manager或手动将二进制文件添加到您的项目中，可以将Plcrashreporter添加到您的应用中。

通过Cocoapods进行整合

1. 将以下行添加到您的Podfile ：

    pod 'PLCrashReporter'

2. 运行pod install以安装您的新定义的POD并打开项目的.xcworkspace 。

通过Swift Package Manager集成

1. 从Xcode菜单中，单击文件> Swift软件包>添加软件包依赖关系。
2. 在出现的对话框中，输入存储库URL：https：//github.com/microsoft/plcrashreporter.git。
3. 在版本中，选择“下一个专业” ，然后采取默认选项。

通过迦太基进行整合

1. 将以下行添加到您的Cartfile ：

    github "microsoft/plcrashreporter"

2. 运行carthage update --use-xcframeworks获取依赖关系。
3. 在XCode中，打开您的应用程序目标的常规设置选项卡。将crastreporter.xcframework从迦太基/构建文件夹中拖动到Frameworks, Libraries and Embedded Content部分中。对于iOS和TVO，将Embed Do not embed 。对于MacOS，将Embed到Embed and Sign 。

注意：迦太基集成不会在Xcode 12中正确构建依赖关系，并使用标志“ - 不使用二元组”或特定分支。要使它起作用，请参阅此指令。

通过将二进制文件复制到您的项目中来集成

1. 下载作为ZIP文件提供的Plcrashreporter框架。
2. 解压缩文件，您将看到一个称为plcrashreporter的文件夹，其中包含所有受支持平台的子文件夹。
3. 将plcrashreporter添加到Xcode中的项目：
   • 确保可见项目导航器（⌘+1）。
   • 现在，将framework （或plcrashreporter.xcframework ）从查找器拖动到Xcode的项目导航器中。
   • 将出现一个对话框，确保检查您的应用程序目标，然后单击完成。

   注意： plcrashreporter Xcframework包含用于iOS和TVOS的静态二进制文件，以及用于MacOS的动态二进制文件。在将框架添加到项目中时，请确保在Frameworks, Libraries and Embedded Content部分中Embed嵌入， Do not embed iOS和TVOS，并Embed and Sign 。 PLCrashReporter-Static-{version}.zip是一个例外 - 它包含所有平台的静态框架。

例子

以下示例显示了一种方法来初始化崩溃记者的方法。请注意，启用过程中的崩溃报告将与任何附带的辩论者冲突，因此请确保在崩溃应用程序时不会附加调试器。

Objective-C

@import CrashReporter;

...

// Uncomment and implement isDebuggerAttached to safely run this code with a debugger.
// See: https://github.com/microsoft/plcrashreporter/blob/2dd862ce049e6f43feb355308dfc710f3af54c4d/Source/Crash%20Demo/main.m#L96
// if (![self isDebuggerAttached]) {

// It is strongly recommended that local symbolication only be enabled for non-release builds.
// Use PLCrashReporterSymbolicationStrategyNone for release versions.
PLCrashReporterConfig *config = [[PLCrashReporterConfig alloc ] initWithSignalHandlerType: PLCrashReporterSignalHandlerTypeMach
                                                                   symbolicationStrategy: PLCrashReporterSymbolicationStrategyAll];
PLCrashReporter *crashReporter = [[PLCrashReporter alloc ] initWithConfiguration: config];

// Enable the Crash Reporter.
NSError *error;
if (![crashReporter enableCrashReporterAndReturnError: &error]) {
    NSLog ( @" Warning: Could not enable crash reporter: %@ " , error);
}
// }

检查收集的崩溃报告可以通过以下方式完成：

 if ([crashReporter hasPendingCrashReport ]) {
    NSError *error;

    // Try loading the crash report.
    NSData *data = [crashReporter loadPendingCrashReportDataAndReturnError: &error];
    if (data == nil ) {
        NSLog ( @" Failed to load crash report data: %@ " , error);
        return ;
    }

    // Retrieving crash reporter data.
    PLCrashReport *report = [[PLCrashReport alloc ] initWithData: data error: &error];
    if (report == nil ) {
        NSLog ( @" Failed to parse crash report: %@ " , error);
        return ;
    }

    // We could send the report from here, but we'll just print out some debugging info instead.
    NSString *text = [PLCrashReportTextFormatter stringValueForCrashReport: report withTextFormat: PLCrashReportTextFormatiOS];
    NSLog ( @" %@ " , text);

    // Purge the report.
    [crashReporter purgePendingCrashReport ];
}

迅速

import CrashReporter

...
// Uncomment and implement isDebuggerAttached to safely run this code with a debugger.
// See: https://github.com/microsoft/plcrashreporter/blob/2dd862ce049e6f43feb355308dfc710f3af54c4d/Source/Crash%20Demo/main.m#L96
// if (!isDebuggerAttached()) {

  // It is strongly recommended that local symbolication only be enabled for non-release builds.
  // Use [] for release versions.
  let config = PLCrashReporterConfig ( signalHandlerType : . mach , symbolicationStrategy : . all )
  guard let crashReporter = PLCrashReporter ( configuration : config ) else {
    print ( " Could not create an instance of PLCrashReporter " )
    return
  }

  // Enable the Crash Reporter.
  do {
    try crashReporter . enableAndReturnError ( )
  } catch let error {
    print ( " Warning: Could not enable crash reporter: ( error ) " )
  }
// }

检查收集的崩溃报告可以通过以下方式完成：

  // Try loading the crash report.
  if crashReporter . hasPendingCrashReport ( ) {
    do {
      let data = try crashReporter . loadPendingCrashReportDataAndReturnError ( )

      // Retrieving crash reporter data.
      let report = try PLCrashReport ( data : data )

      // We could send the report from here, but we'll just print out some debugging info instead.
      if let text = PLCrashReportTextFormatter . stringValue ( for : report , with : PLCrashReportTextFormatiOS ) { 
        print ( text )
      } else {
        print ( " CrashReporter: can't convert report to text " )
      }
    } catch let error {
      print ( " CrashReporter failed to load and parse with error: ( error ) " )
    }
  }

  // Purge the report.
  crashReporter . purgePendingCrashReport ( ) 

建筑

先决条件

• MAC运行MACOS，符合XCode要求。
• XCode 11或更高。

此外，下一个可选工具用于构建其他资源：

• doxygen生成文档。有关更多信息，请参见官方的Doxygen存储库，或使用自制酿制来安装它。
• GraphViz生成文档。有关更多信息，请参见官方Graphviz网站，或使用自制的网站进行安装。
• protobuf-c将协议缓冲器.proto文件转换为C描述符代码。有关更多信息，请参见官方的Protobuf-C-C存储库或使用自制的安装。

建筑

• 为您的终端打开一个新窗口。

• 转到Plcrashreporter的根文件夹并运行

  xcodebuild -configuration Release -target ' CrashReporter '

  为所有平台创建二进制文件。

更新Protobuf-C

更新protobuf-c依赖性：

1. 从Protobuf-C Github存储库下载最新的protobuf-ch和protobuf-cc文件。
2. 用下载的文件替换Dependencies/protobuf-c中的现有文件。
3. 运行脚本：

./Dependencies/protobuf-c/generate-pb-c.sh

贡献

我们期待您通过拉动请求的贡献。

为了为Plcrashreporter做出贡献，您需要上面提到的工具来为所有架构和protobuf-c构建Plcrashreporter，以将协议缓冲器.proto文件转换为C描述符代码。

行为守则

该项目采用了Microsoft开源的行为代码。有关更多信息，请参见《行为守则常见问题守则》或与其他问题或评论联系[email protected]。