EZLog

中文介绍

EZLog is a high efficiency Cross-platform logging library.

it is inspired by Xlog and Loagan, rewrite in Rust.

Feature

• multi platform: Flutter, Android, iOS, Windows, Linux, MacOS
• map file into memory by mmap.
• zlib compression.
• AEAD encryption.
• fetch log by callback.
• trim out of date files.
• CLI paser support.

Quick Start

Flutter

see Flutter project README.md

iOS

By CocoaPods

Add EZLog to Podfile

shell pod 'EZLog', '~> 0.1' then

shell pod update

Open Xcode, add sample code

```swift import EZLog

init() { pthreadsetnamenp("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")

} ```

1. click run and see console ouput.

Android

Add ezlog to dependencies

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

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

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

open app level build.gradle, add ezlog

groovy dependencies { implementation "wtf.s1.ezlog:ezlog:0.1.6" }

sync gradle

Setup in application. For example

```kotlin 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")
    }
})

}

```

License

See LICENSE-MIT, LICENSE-APACHE,