Crate ezlog

import EZLog

init() {
    pthread_setname_np("main")
    #if DEBUG
    ezlogInitWithTrace()
    #else
    ezlogInit()
    #endif
    
    let dirPath = URL.documents.appendingPathComponent("ezlog").relativePath
    let config = EZLogConfig(level: Level.trace,
                                dirPath: dirPath,
                                name: "demo",
                                keepDays: 7,
                                maxSize: 150*1024,
                                compress: CompressKind.ZLIB,
                                compressLevel: CompressLevel.DEFAULT,
                                cipher: Cipher.AES128GCM,
                                cipherKey: [UInt8]("a secret key!!!!".utf8),
                                cipherNonce: [UInt8]("unique nonce".utf8))
    let logger = EZLogger(config: config)

    ezlogRegisterCallback(success: {name, date, logs in
        if !logs.isEmpty {
            for log in logs {
                print("name:" + name + " date:" + date + " log:" + log);
            }
        } else {
            print("no log found at that time")
        }
        
    }, fail: {name, date, err in
        print("name:" + name + " date:" + date + " err:" + err);
    })
    
    logger.debug("first blood")
}

click run and see console ouput.

Android

Add ezlog to dependencies

open top-level build.gradle, add mavenCentral to repositories.

buildscript {
    repositories {
        ...
        mavenCentral()
        ...
    }
}

allprojects {
    repositories {
        ...
        mavenCentral()
        ...
    }
}

open app level build.gradle, add ezlog

dependencies {
    implementation "wtf.s1.ezlog:ezlog:0.1.7"
}

sync gradle

Setup in application. For example

override fun onCreate() {
    super.onCreate()

    val path = File(filesDir, "ezlog").absolutePath
    val config = EZLogConfig.Builder("demo", path)
        .compress(EZLog.CompressZlib)
        .compressLevel(EZLog.CompressFast)
        .cipher(EZLog.Aes128Gcm)
        .cipherKey("a secret key!!!!".toByteArray())
        .cipherNonce("unique nonce".toByteArray())
        .enableTrace(BuildConfig.DEBUG)
        .build()
    EZLog.initWith(config)

    EZLog.v("ezlog", "first blood")

    EZLog._registerCallback(object : Callback {
        override fun onLogsFetchSuccess(
            logName: String?,
            date: String?,
            logs: Array<out String>?
        ) {
            Log.i("ezlog", "$logName $date ${logs.contentToString()}")
            logs?.let {
                logs.getOrNull(0)?.let { log ->
                    Log.i("ezlog", "check file exists ${File(log).exists()}")
                }
            }
        }

        override fun onLogsFetchFail(logName: String?, date: String?, err: String?) {
            Log.i("ezlog", "$logName $date $err")
        }
    })
}

Build from source code

install and config rust

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/env

use rust nightly

rustup default nightly-2022-08-10

we use build-std feature, so add nightly src component

rustup component add rust-src --toolchain nightly-x86_64-apple-darwin

add target: iOS, android, etc…

rustup target add aarch64-linux-android armv7-linux-androideabi aarch64-apple-ios aarch64-apple-ios-sim x86_64-apple-ios

clone repository and open in command line tool. then run

cargo check

wait crates download…

cargo build -p ezlog

For android build

we use cargo-ndk to build dylib

cargo install cargo-ndk

cd android

sh b_android.sh

then open current workspace in AndroidStudio

For iOS build

install cbindgen

cargo install --force cbindgen

cd ios dir

sh b_ios.sh

open the ios/EZlog.xcworkspace in Xcode

License

See LICENSE-MIT, LICENSE-APACHE,

Macros

event

Every important log case make an event. if you care about what’s things going on, just register an event listener.

Structs

EZLogConfig

A config to set up EZLogger

EZLogConfigBuilder

The builder of EZLogConfig

EZLogger

The Logger struct to implement the Log encode.

EZRecord

Single Log record

EZRecordBuilder

EZRecord’s builder

EventPrinter

Default Event implementation, print every event in console

FetchReq

Fetch Logs file‘s path reqeust

FetchResult

Fetch Logs file‘s path result.

Header

EZLog file Header

Enums

CipherKind

Cipher kind current support

CompressKind

Compress type can be used to compress the log file.

CompressLevel

Compress level

Level

Log level, used to filter log records

Version

Log version enum

Constants

DEFAULT_LOG_NAME

A EZLogger default name. current is “default”.

V1_LOG_HEADER_SIZE

Log file fixed header length.

Traits

Compress

The Compression trait + Decompression trait

Compression

Compress function abstract

Cryptor

The Encryptor trait + Decryptor trait

Decompression

Decompress function abstract

Decryptor

decrypt function abstract

EZLogCallback

Async callback for fetch log files

Encryptor

Encrypt function abstract

Event

EZLog Event Listener

Functions

create_log

Create a new EZLogger from an EZLogConfig

flush

Force flush the log file

Flush all log files

Init ezlog

Write a EZRecord to the log file

request_log_files_for_date

Request logs file path array at the date which EZLogger’s name is define in the parameter

set_boxed_callback

Set the boxed EZLogCallback

set_event_listener

Set global Event listener

trim

Trim all EZLoggers outdated files