Fluent Logger for Java 技术文档

1. 安装指南

1.1 使用一键式 JAR 包安装

您可以从以下地址下载 Fluent Logger for Java 的一键式 JAR 包：

wget http://central.maven.org/maven2/org/fluentd/fluent-logger/${logger.version}/fluent-logger-${logger.version}-jar-with-dependencies.jar

将下载的 JAR 包添加到您的类路径中，即可使用 Fluent Logger for Java。

1.2 从 Maven2 仓库安装

Fluent Logger for Java 已发布到 Maven2 仓库。您可以在 pom.xml 或 build.gradle 文件中添加以下依赖：

Maven:

<dependencies>
  ...
  <dependency>
    <groupId>org.fluentd</groupId>
    <artifactId>fluent-logger</artifactId>
    <version>${logger.version}</version>
  </dependency>
  ...
</dependencies>

Gradle:

dependencies {
    compile 'org.fluentd:fluent-logger:'+loggerVersion
}

1.3 从 GitHub 仓库安装

您可以使用 git 命令获取最新的源代码：

git clone [e-mail]:fluent/fluent-logger-java.git
cd fluent-logger-java
mvn assembly:assembly

在 fluent-logger-java/target 目录中，您将得到名为 fluent-logger-${logger.version}-jar-with-dependencies.jar 的 JAR 包。更多详细信息，请查看 pom.xml。

将 ${logger.version} 或 loggerVersion 替换为 Fluent Logger for Java 的当前版本。

2. 项目使用说明

以下是一个使用 Fluent Logger for Java 的简单示例：

import java.util.HashMap;
import java.util.Map;
import org.fluentd.logger.FluentLogger;

public class Main {
    private static FluentLogger LOG = FluentLogger.getLogger("app");

    public void doApplicationLogic() {
        // ...
        Map<String, Object> data = new HashMap<String, Object>();
        data.put("from", "userA");
        data.put("to", "userB");
        LOG.log("follow", data);
        // ...
    }
}

要创建 Fluent Logger 实例，用户需要像 org.slf4j、org.log4j 日志库那样调用 getLogger 方法。此方法只需调用一次。默认情况下，日志记录器假设本地已启动 fluentd 守护进程。您也可以通过传递以下选项来指定远程日志记录器：

// 远程 fluentd
private static FluentLogger LOG = FluentLogger.getLogger("app", "remotehost", port);

然后，按照如下方式创建事件。这将向 fluentd 发送一个带有标签 app.follow 和属性 from 及 to 的事件。

当应用程序结束时，应显式调用 FluentLogger 类的 close 方法。该方法会关闭与 fluentd 的套接字连接。

FluentLogger.close();

3. 项目 API 使用文档

由于项目是基于 Java 编写，具体 API 使用请参考以下示例：

• getLogger(String tag): 获取一个指定标签的日志记录器。
• getLogger(String tag, String host, int port): 获取一个指定标签和远程地址的日志记录器。
• log(String tag, Map<String, Object> data): 将事件记录到指定标签。
• close(): 关闭日志记录器。

4. 项目安装方式

请参考上文“安装指南”部分，您可以选择使用一键式 JAR 包安装、从 Maven2 仓库安装或从 GitHub 仓库安装。根据您的项目需求选择合适的安装方式。