@@ -26,77 +26,98 @@ Java >= 1.6
2626
2727You can download all-in-one jar file for Fluent Logger for Java.
2828
29- $ wget http://central.maven.org/maven2/org/fluentd/fluent-logger/${logger.version}/fluent-logger-${logger.version}-jar-with-dependencies.jar
29+ ``` bash
30+ wget http://central.maven.org/maven2/org/fluentd/fluent-logger/${logger.version} /fluent-logger-${logger.version} -jar-with-dependencies.jar
31+ ```
3032
3133To use Fluent Logger for Java, set the above jar file to your classpath.
3234
3335### Install from Maven2 repository
3436
3537Fluent Logger for Java is released on Fluent Maven2 repository. You can
36- configure your pom.xml as follows to use it:
37-
38- <dependencies>
39- ...
40- <dependency>
41- <groupId>org.fluentd</groupId>
42- <artifactId>fluent-logger</artifactId>
43- <version>${logger.version}</version>
44- </dependency>
45- ...
46- </dependencies>
47-
38+ configure your pom.xml or build.gradle as follows to use it:
39+
40+ ** Maven:**
41+
42+ ``` xml
43+ <dependencies >
44+ ...
45+ <dependency >
46+ <groupId >org.fluentd</groupId >
47+ <artifactId >fluent-logger</artifactId >
48+ <version >${logger.version}</version >
49+ </dependency >
50+ ...
51+ </dependencies >
52+ ```
53+
54+ ** Gradle:**
55+
56+ ``` gradle
57+ dependencies {
58+ compile 'org.fluentd:fluent-logger:'+loggerVersion
59+ }
60+ ```
4861
4962### Install from Github repository
5063
5164You can get latest source code using git.
5265
53- $ git clone git@github.com:fluent/fluent-logger-java.git
54- $ cd fluent-logger-java
55- $ mvn assembly:assembly
66+ ``` bash
67+ git clone git@github.com:fluent/fluent-logger-java.git
68+ cd fluent-logger-java
69+ mvn assembly:assembly
70+ ```
5671
5772You will get the fluent logger jar file in fluent-logger-java/target
5873directory. File name will be fluent-logger-${logger.version}-jar-with-dependencies.jar.
5974For more detail, see pom.xml.
6075
61- ** Replace ${logger.version} with the current version of Fluent Logger for Java.**
76+ ** Replace ` ${logger.version} ` or ` loggerVersion ` with the current version of Fluent Logger for Java.**
6277
6378## Quickstart
6479
6580The following program is a small example of Fluent Logger for Java.
6681
67- import java.util.HashMap;
68- import java.util.Map ;
69- import org.fluentd.logger.FluentLogger ;
70-
71- public class Main {
72- private static FluentLogger LOG = FluentLogger.getLogger("app");
73-
74- public void doApplicationLogic() {
75- // ...
76- Map<String, Object> data = new HashMap<String, Object>();
77- data.put("from", "userA" );
78- data.put("to ", "userB ");
79- LOG.log("follow ", data );
80- // ...
81- }
82+ ``` java
83+ import java.util.HashMap ;
84+ import java.util.Map ;
85+ import org.fluentd.logger.FluentLogger ;
86+
87+ public class Main {
88+ private static FluentLogger LOG = FluentLogger . getLogger( " app " );
89+
90+ public void doApplicationLogic () {
91+ // ...
92+ Map< String , Object > data = new HashMap< String , Object > ( );
93+ data. put(" from " , " userA " );
94+ data . put( " to " , " userB " );
95+ LOG . log( " follow " , data);
96+ // ...
8297 }
98+ }
99+ ```
83100
84101To create Fluent Logger instances, users need to invoke getLogger method in
85102FluentLogger class like org.slf4j, org.log4j logging libraries. The method
86103should be called only once. By default, the logger assumes fluent daemon is
87104launched locally. You can also specify remote logger by passing the following
88105options.
89106
90- // for remote fluentd
91- private static FluentLogger LOG = FluentLogger.getLogger("app", "remotehost", port);
107+ ``` java
108+ // for remote fluentd
109+ private static FluentLogger LOG = FluentLogger . getLogger(" app" , " remotehost" , port);
110+ ```
92111
93112Then, please create the events like this. This will send the event to fluentd,
94113with tag 'app.follow' and the attributes 'from' and 'to'.
95114
96115Close method in FluentLogger class should be called explicitly when application
97116is finished. The method closes socket connection with the fluentd.
98117
99- FluentLogger.close();
118+ ``` java
119+ FluentLogger . close();
120+ ```
100121
101122## License
102123
0 commit comments