Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ChimeHQ/Meter

Library for interacting with MetricKit
https://github.com/ChimeHQ/Meter

analytics crash-reporting ios macos swift

Last synced: 13 days ago
JSON representation

Library for interacting with MetricKit

Awesome Lists containing this project

README 

        



[![Build Status][build status badge]][build status]

[![Platforms][platforms badge]][platforms]

[![Documentation][documentation badge]][documentation]

[![Matrix][matrix badge]][matrix]






# Meter



Meter is a companion library to [MetricKit](https://developer.apple.com/documentation/metrickit). It aims to provide the following capabilities:



- API for `MXCallStackTree`

- Types for `MXDiagnostic` emulation and coding

- `MXMetricManager`-like interface for unsupported platforms

- On-device symbolication

- Account for MetricKit inconsistencies across platforms and types

- Support for custom exception reporting



If you're also looking for a way to transmit MetricKit data to your server, have a look at [MeterReporter](https://github.com/ChimeHQ/MeterReporter). It uses Meter under the hood, and takes care of the details.



## Integration



```swift

dependencies: [

    .package(url: "https://github.com/ChimeHQ/Meter")

]

```



## Expanded API



The MetricKit API for crash reporting is unwieldy. In particular, `MXCallStackTree` lacks any kind of interface for interacting with its structure. Meter includes some classes that make it easier to work with. In addition to providing an API for `MXCallStackTree`, Meter includes types to emulate and parse MetricKit diagnostics.



```swift

let data = mxTree.jsonRepresentation()

let tree = try CallStackTree.from(data: data)



for frame in tree.callStacks[0].frames {

    print("\(frame.address) \(frame.binaryName) \(frame.binaryUUID)")

}

```



## Custom Exceptions



As of iOS 17, macOS 14, visionOS 1.0, MetricKit does capture uncaught [NSExceptions](https://developer.apple.com/documentation/metrickit/mxcrashdiagnostic/4172947-exceptionreason). To help support older OSes, and exceptions that do not originate from places that are covered by this feature, custom exceptions are also supported. These can be created from an `NSException` object, which will capture all the needed runtime information to emulate a standard `CallStack`.



How you actually get access to the `NSException` is not defined by Meter. But, if you have one, the `CrashDiagnostic` type also includes an `exceptionInfo` property that can accept one of these for easy encoding.



## On-Device Symbolication



The stack traces provided by MetricKit, like other types of crash logs, are not symbolicated. There are a bunch of different ways to tackle this problem, but one very convenient option is just to do it as a post-processing step on the device where the crash occurred. This does come, however, with one major drawback. It only works when you still have access to the same binaries. OS updates will almost certainly change all the OS binaries. The same is true for an app update, though in that case, an off-line symbolication step using a dSYM is still doable.



Meter provides an API for performing symbolication, via the `Symbolicator` protocol. The core of this protocol should be usable to symbolicate any address, and is not tied to MetricKit. But, the protocol also does include a number of convenience methods that can operate on the various MetricKit classes. The result uses the Meter's wrapper classes to return `Frame` instances which include a `symbolInfo` property. This property can be accessed directly or just re-encoded for transport.



```swift

let symbolicator = DlfcnSymbolicator()

let symPayload = symbolicator.symbolicate(payload: diagnosticPayload)

```



### DlfcnSymbolicator



This class implements the `Symbolicator` protocol, and uses the functions with `dlfcn.h` to determine symbol/offset. This works, but does have some limitations. First, it relies on looking up symbols in the **currently executing** process, so it will only work if the needed binary is currently loaded.



Second, these functions return `` for some binary's symbols on iOS. I know the symbol information is still accessible from the binary, so it's unclear why this is done.



This is a relatively inexpensive symbolication pass, and is a first effort. Further work here is definitely necessary.



## Contributing and Collaboration



I would love to hear from you! Issues or pull requests work great. Both a [Matrix space][matrix] and [Discord][discord] are available for live help, but I have a strong bias towards answering in the form of documentation. You can also find me on [mastodon](https://mastodon.social/@mattiem).



I prefer collaboration, and would love to find ways to work together if you have a similar project.



I prefer indentation with tabs for improved accessibility. But, I'd rather you use the system you want and make a PR than hesitate because of whitespace.



By participating in this project you agree to abide by the [Contributor Code of Conduct](CODE_OF_CONDUCT.md).



[build status]: https://github.com/ChimeHQ/Meter/actions

[build status badge]: https://github.com/ChimeHQ/Meter/workflows/CI/badge.svg

[platforms]: https://swiftpackageindex.com/ChimeHQ/Meter

[platforms badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FChimeHQ%2FMeter%2Fbadge%3Ftype%3Dplatforms

[documentation]: https://swiftpackageindex.com/ChimeHQ/Meter/main/documentation

[documentation badge]: https://img.shields.io/badge/Documentation-DocC-blue

[matrix]: https://matrix.to/#/%23chimehq%3Amatrix.org

[matrix badge]: https://img.shields.io/matrix/chimehq%3Amatrix.org?label=Matrix

[discord]: https://discord.gg/esFpX6sErJ