Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/softprops/zig-jsonlog
format zig std logs as structured JSON
https://github.com/softprops/zig-jsonlog
json logging zig zig-library zig-package zigdex-lib ziglang
Last synced: about 1 month ago
JSON representation
format zig std logs as structured JSON
- Host: GitHub
- URL: https://github.com/softprops/zig-jsonlog
- Owner: softprops
- License: mit
- Created: 2023-11-26T06:12:18.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-08T22:20:09.000Z (8 months ago)
- Last Synced: 2024-10-28T17:19:35.561Z (3 months ago)
- Topics: json, logging, zig, zig-library, zig-package, zigdex-lib, ziglang
- Language: Zig
- Homepage:
- Size: 27.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
jsonlog
A zero-allocation JSON formatting logging library for zig
---
[](https://github.com/softprops/zig-jsonlog/actions/workflows/ci.yml)   [](https://ziglang.org/documentation/0.13.0/)
## 🍬 features
- make your logs easy to query with tools like aws cloud watch insights
- zero-allocation
- append arbitrary metadata to your logs
- automatic newline insertion
Coming soon...
- configurable writers
currently jsonlog writes to stderr, as the default std log fn does. we'd like to make the writer user configurable.
## examples
```zig
const std = @import("std");
const jsonLog = @import("jsonlog");
const log = std.log.scoped(.demo);
pub const std_options: std.Options = .{
// configure the std lib log api fn to use jsonlog formatting
.logFn = jsonLog.logFn,
};
pub fn main() void {
// std log interface
log.debug("DEBUG", .{});
log.info("INFO", .{});
log.warn("WARN", .{});
log.err("ERR", .{});
// jsonLog interface for provoding arbitrary structured metadata
jsonLog.info("things are happening", .{}, .{
.endpoint = "/home",
.method = "GET",
});
// create a custom scope for doing the same
jsonLog.scoped(.demo).warn("things could be better", .{}, .{
.endpoint = "/home",
.method = "GET",
});
}
```
```json
{"ts":"2024-03-20T15:07:15.363Z","level":"debug","msg":"DEBUG","scope":"demo"}
{"ts":"2024-03-20T15:07:15.364Z","level":"info","msg":"INFO","scope":"demo"}
{"ts":"2024-03-20T15:07:15.364Z","level":"warning","msg":"WARN","scope":"demo"}
{"ts":"2024-03-20T15:07:15.364Z","level":"error","msg":"ERR","scope":"demo"}
{"ts":"2024-03-20T15:07:15.364Z","level":"info","msg":"things are happening","scope":"default","meta":{"endpoint":"/home","method":"GET"}}
{"ts":"2024-03-20T15:07:15.364Z","level":"warning","msg":"things could be better","scope":"demo","meta":{"endpoint":"/home","method":"GET"}}
```
## 📼 installing
Create a new exec project with `zig init-exe`. Copy the echo handler example above into `src/main.zig`
Create a `build.zig.zon` file to declare a dependency
> .zon short for "zig object notation" files are essentially zig structs. `build.zig.zon` is zigs native package manager convention for where to declare dependencies
Starting in zig 0.12.0, you can use and should prefer
```sh
zig fetch --save https://github.com/softprops/zig-jsonlog/archive/refs/tags/v0.2.1.tar.gz
```
otherwise, to manually add it, do so as follows
```diff
.{
.name = "my-app",
.version = "0.1.0",
.dependencies = .{
+ // 👇 declare dep properties
+ .jsonlog = .{
+ // 👇 uri to download
+ .url = "https://github.com/softprops/zig-jsonlog/archive/refs/tags/v0.2.1.tar.gz",
+ // 👇 hash verification
+ .hash = "...",
+ },
},
}
```
> the hash below may vary. you can also depend any tag with `https://github.com/softprops/zig-jsonlog/archive/refs/tags/v{version}.tar.gz` or current main with `https://github.com/softprops/zig-jsonlog/archive/refs/heads/main/main.tar.gz`. to resolve a hash omit it and let zig tell you the expected value.
Add the following in your `build.zig` file
```diff
const std = @import("std");
pub fn build(b: *std.Build) void {
const target = b.standardTargetOptions(.{});
const optimize = b.standardOptimizeOption(.{});
// 👇 de-reference jsonlog dep from build.zig.zon
+ const jsonlog = b.dependency("jsonlog", .{
+ .target = target,
+ .optimize = optimize,
+ }).module("jsonlog");
var exe = b.addExecutable(.{
.name = "your-exe",
.root_source_file = .{ .path = "src/main.zig" },
.target = target,
.optimize = optimize,
});
// 👇 add the jsonlog module to executable
+ exe.root_mode.addImport("jsonlog", jsonlog);
b.installArtifact(exe);
}
```
## 🥹 for budding ziglings
Does this look interesting but you're new to zig and feel left out? No problem, zig is young so most us of our new are as well. Here are some resources to help get you up to speed on zig
- [the official zig website](https://ziglang.org/)
- [zig's one-page language documentation](https://ziglang.org/documentation/0.13.0/)
- [ziglearn](https://ziglearn.org/)
- [ziglings exercises](https://github.com/ratfactor/ziglings)
\- softprops 2024