fluent / fluent-logger-scala Goto Github PK

View Code? Open in Web Editor NEW

45.0 15.0 18.0 1.05 MB

A structured logger implementation in Scala.

Home Page: https://github.com/fluent

License: Other

Shell 45.85% Scala 43.17% Java 10.98%

scala fluentd fluentd-logger

fluent-logger-scala's Introduction

fluent-logger-scala

Fluentd logger for Scala

Many web/mobile applications generate huge amount of event logs (c,f. login, logout, purchase, follow, etc). To analyze these event logs could be really valuable for improving the service. However, the challenge is collecting these logs easily and reliably.

Fluentd solves that problem by having: easy installation, small footprint, plugins, reliable buffering, log forwarding, etc.

fluent-logger-scala is a Scala library, to record the events from Scala application, based on fluent-logger-java. Main difference between scala and java version is to support Scala Collection.

Please see QuickStart to get started!

Usage

# For Scala 2.11 and 2.12 (Since fluent-logger-scala 0.7.0)
libraryDependencies += "org.fluentd" %% "fluent-logger-scala" % "(version)"

# For Scala 2.10 users (deprecated)
libraryDependencies += "org.fluentd" %% "fluent-logger-scala" % "0.6.0"

API

fluent-logger-scala API is based on fluent-logger-java:

FluentLoggerFactory#getLogger(tag: String): FluentLogger
FluentLoggerFactory#getLogger(tag: String, host: String, port: Int): FluentLogger
FluentLoggerFactory#getLogger(tag: String, host: String, port: Int, timeout: Int, bufferCapacity: Int): FluentLogger
FluentLoggerFactory#flushAll(): Unit
FluentLoggerFactory#closeAll(): Unit

FluentLogger#log(label: String, key: String, value: Any): Boolean
FluentLogger#log(label: String, key: String, value: Any, timestamp: Long): Boolean
FluentLogger#log(tag:String, mutableMap/immutableMap[String, Any]):Boolean
FluentLogger#flush()
FluentLogger#close()

For Developers

$ ./sbt
> compile
> test
# cross Scala version testing
> + test

Publishing to Maven Central

Describe your account information in $HOME/.sbt/(sbt-version)/sonatype.sbt file:

credentials += Credentials("Sonatype Nexus Repository Manager",
    "oss.sonatype.org",
    "(Sonatype user name)",
    "(Sonatype password)")

The release command will publish signed artifacts to the Sonatype repository, and perform releasing to Maven Central:

./sbt release

License and Copyright

Copyright © 2011- Tsuyoshi Ozawa and Taro L. Saito
Apache License, Version 2.0

Misc

This document is inspired by fluent-logger-python

fluent-logger-scala's People

Contributors

Stargazers

Watchers

Forkers

tototoshi xuwei-k choplin xerial anekos yanana cosmo0920 ocadaruma vl4ds homma-takamasa futoase dalavancloud takayahilton fan-adn fan-ta-sato isabella232

fluent-logger-scala's Issues

Adding test

fluent-logger-scala has no test code.

support Scala 2.12

xerial/fluentd-standalone#3
fluent-logger-scala use fluentd-standalone in test.
fluentd-standalone 0.1.2 depends on Scala 2.10 https://oss.sonatype.org/content/repositories/releases/org/xerial/fluentd-standalone/0.1.2/fluentd-standalone-0.1.2.pom
need cross build (or temporary disable tests when Scala 2.12)

/cc @xerial

What happened to the master branch?

It seems that the current 'fluent-logger-scala' project uses the develop branch
as its default branch, and the master branch has not been updated since v0.6.0.

Specifically, the last update of the master branch was more than a year ago:

https://github.com/fluent/fluent-logger-scala/commits/master

Does this mean that the master branch is now deprecated?
Or is it just left behind by some mistake?

Why is this a problem?

Some external documentations assume that the master branch is the latest tip of
the project. For this reason, they are still relying on the outdated information.

For example, the official documentation still refers to the outdated CHANGELOG file,
which is still referring to v0.6.0 as the latest stable:

https://github.com/fluent/fluentd-docs/blob/master/docs/v1.0/scala.txt#L46

Release 0.7.0 for Scala 2.12

Shouldn't use blocking method

Currently, FluentLogger.log() method uses FutureChannel.await() function.
It blocks main program, so this should be removed.

Release for Scala 2.13

Supports more Scala objects by using MessagePack for Scala

Currently, the serialization is delegated fluent-logger-java. This design causes a problem - Scala objects cannot be serialized.

By using MessagePack for Scala, this problem can be solved. I'll fix the problem.

org.fluentd.logger.sender.RawSocketSender java.net.ConnectException: Connection refused

ScalaRawSocketSender -> open() shows exceptions with stacktrace when failed to connect to server. The behavior itself seems to have no problem. However, it is confusing in production and during tests. Observed "printStackTrace" message when server refused to connect. Could we suppress it please in production code 0.7.0 versionon-wards?

Reference Code:
def open(): Unit = {
try {
connect()
} catch {
case e: IOException =>
LOG.severe(s"Failed to connect fluentd: $server")
LOG.severe("Connection will be retried")
e.printStackTrace()
close()
}
}