A tracing layer for macOS/iOS's `oslog`

Lucy

Last update: Dec 6, 2022

Related tags

Utilities tracing-oslog

Overview

tracing_oslog

This is a tracing layer for the Apple OS logging framework.

Activities are used to handle spans,

Example

use tracing_oslog::OsLogger;

let collector = tracing_subscriber::registry()
	.with(OsLogger::new("moe.absolucy.test", "default"));
tracing::subscriber::set_global_default(collector).expect("failed to set global subscriber");

let number_of_yaks = 3;
// this creates a new event, outside of any spans.
info!(number_of_yaks, "preparing to shave yaks");

let number_shaved = yak_shave::shave_all(number_of_yaks);
info!(
	all_yaks_shaved = number_shaved == number_of_yaks,
	"yak shaving completed."
);

License

This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
This notice may not be removed or altered from any source distribution.

tracing - a framework for instrumenting Rust programs to collect structured, event-based diagnostic information

tracing-appender Writers for logging events and spans Documentation | Chat Overview tracing is a framework for instrumenting Rust programs to collect

1 Mar 9, 2022

Middlewares and tools to integrate axum + tracing + opentelemetry

axum-tracing-opentelemetry Middlewares and tools to integrate axum + tracing + opentelemetry. Read OpenTelemetry header from incoming request Start a

31 Jan 4, 2023

A rust `tracing` compatible framework inspired by log4rs.

trace4rs This crate allows users to configure output from tracing in the same way as you would configure the output of log4rs. Overview For a usage ex

5 Oct 24, 2022

A convenient tracing config and init lib, with symlinking and local timezone.

clia-tracing-config A convenient tracing config and init lib, with symlinking and local timezone. Use these formats default, and can be configured: pr

5 Jan 3, 2023

High-performance QEMU memory and instruction tracing

Cannoli Cannoli is a high-performance tracing engine for qemu-user. It can record a trace of both PCs executed, as well as memory operations. It consi

412 Oct 18, 2023

Utilities for integrating Datadog with opentelemetry + tracing in rust

Non-official datadog tracing and log correlation for Rust services. This crate contains the necessary glue to bridge the gap between OpenTelemetry, tr

5 Oct 31, 2023

mach-dump can parse Mach-O core dumps taken with lldb from macOS and iOS devices.

mach-dump mach-dump can parse Mach-O core dumps taken with lldb from macOS and iOS devices. It has no external dependencies. Example use std::path::Pa

8 Sep 16, 2022

Web-wrapped Supabase desktop app for macOS, Windows & Linux powered by Tauri

Supabase Desktop App What is it? It's a cross-platform web-wrapped Supabase desktop app powered by Tauri. You can install it on your macOS, Windows (u

12 Jan 25, 2023

OpenAI chat client desktop app (Windows, MacOS, Linux)

ChatWizard OpenAI chat client Desktop Application (Windows, MacOS, Linux) Declaration This project is currently undergoing active development and has

8 Apr 5, 2023

Comments

Do not panic on bad messages logged
The code has the following logic here:

let message = CString::new(message).expect("failed to convert formatted message to a C string"); unsafe { wrapped_os_log_with_type(self.logger, level, message.as_ptr()) };

Rust and C store strings differently. Rust stores the string length separately instead of having trailing \0 in the end. As a result, rust allows having unprintable \0 inside the strings. However such strings can't be converted to C string unless 0 is stripped out.

If you try doing something like error!("Hello\0World"), the IOS application crashes. This is especially critical when logging the data received over network or entered by user.
opened by kgrech 1
Update dependencies

This pull requests updates versions of bindgen and parking_lot to newer version. Bingen update is crucial as in PR#2284 they have updated crate structure to remove a lot of unused dependencies.

I also remove the the patch version from the crates. The reason it is better not to keep patch versions is that tracing-oslog is a library create. It would be always a dependency of some other (let's call it main) crate. If this main crate depends on, say, on tracing-core = "0.1.20", then having tracing-core = "0.1.21" in this crate might create a problem. Assuming all dependencies follow semver, tracing-oslog should work fine with any patch version

See more here and here

P.S. Any plans to make tracing-oslog v0.2.0 soon?

opened by kgrech 0