Memfault Compact Log Library
Project description
Memfault Compact Log Library
This library enables decoding Memfault-flavored compact logs. For background information on compact logs, see here:
Usage
Some brief usage information below. See the source for detailed usage.
Extracting compact log format strings from .elf
To extract the format strings from the symbol file:
from mflt_compact_log.log_fmt import LogFormatElfSectionParser
elf = "path to elf file"
# parse the elf file
mappings = LogFormatElfSectionParser.get_mapping_from_elf_file(elf)
# 'mappings' is a dictionary mapping log id to LogFormatInfo data
print(mappings)
>>> {8: LogFormatInfo(filename='./main/console_example_main.c', line=245, n_args=0, fmt='This is a compact log example')}
Decoding compact logs
To apply the format string to raw compact log data:
from mflt_compact_log.compact import CompactLogDecoder
# example format string; this could instead be retrieved from the elf file
fmt = "An Integer Format String: %d"
# compact log hex encoded raw data
compact_log = "820A0B"
# decode the log!
compact_log_as_bytes = bytes.fromhex(compact_log)
log = CompactLogDecoder.from_cbor_array(fmt, compact_log_as_bytes)
log.decode()
>>> 'An Integer Format String: 11'
Changes
0.0.2
- support Python 3.9 and 3.10
- update
prettytable
dependency from0.7.2
to3.4.1
- update
pyelftools
dependency from^0.28.0
to^0.29.0
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mflt_compact_log-0.0.2.tar.gz
(40.8 kB
view hashes)
Built Distribution
Close
Hashes for mflt_compact_log-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7cbe409ab4f3d35bc46b104184eb3d57264760350371b84f166067548f9bc34b |
|
MD5 | cdee1e11dab0c26cacb7e1789dd38720 |
|
BLAKE2b-256 | a49405a67222ad600a7e0bc0d2865f903e5f1e341780791b5a0f6c6917d322de |