flume-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rgo...@apache.org
Subject svn commit: r1351592 - in /incubator/flume/branches/flume-1262: flume-ng-channels/flume-file-channel/src/site/xdoc/ flume-ng-channels/flume-jdbc-channel/src/site/xdoc/ flume-ng-channels/flume-recoverable-memory-channel/src/site/xdoc/ flume-ng-clients/f...
Date Tue, 19 Jun 2012 07:40:16 GMT
Author: rgoers
Date: Tue Jun 19 07:40:16 2012
New Revision: 1351592

URL: http://svn.apache.org/viewvc?rev=1351592&view=rev
Log:
Add descriptions of channels and log4j appender

Added:
    incubator/flume/branches/flume-1262/flume-ng-channels/flume-file-channel/src/site/xdoc/
    incubator/flume/branches/flume-1262/flume-ng-channels/flume-file-channel/src/site/xdoc/index.xml
    incubator/flume/branches/flume-1262/flume-ng-channels/flume-jdbc-channel/src/site/xdoc/
    incubator/flume/branches/flume-1262/flume-ng-channels/flume-jdbc-channel/src/site/xdoc/index.xml
    incubator/flume/branches/flume-1262/flume-ng-channels/flume-recoverable-memory-channel/src/site/xdoc/
    incubator/flume/branches/flume-1262/flume-ng-channels/flume-recoverable-memory-channel/src/site/xdoc/index.xml
    incubator/flume/branches/flume-1262/flume-ng-clients/flume-ng-log4jappender/src/site/xdoc/
    incubator/flume/branches/flume-1262/flume-ng-clients/flume-ng-log4jappender/src/site/xdoc/index.xml

Added: incubator/flume/branches/flume-1262/flume-ng-channels/flume-file-channel/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/incubator/flume/branches/flume-1262/flume-ng-channels/flume-file-channel/src/site/xdoc/index.xml?rev=1351592&view=auto
==============================================================================
--- incubator/flume/branches/flume-1262/flume-ng-channels/flume-file-channel/src/site/xdoc/index.xml
(added)
+++ incubator/flume/branches/flume-1262/flume-ng-channels/flume-file-channel/src/site/xdoc/index.xml
Tue Jun 19 07:40:16 2012
@@ -0,0 +1,46 @@
+<?xml version="1.0"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<document>
+  <properties>
+    <title>Apache Flume File Channel</title>
+    <author email="rgoers@apache.org">Ralph Goers</author>
+  </properties>
+
+  <body>
+    <section name="Flume File Channel">
+
+      <p>
+        A durable Channel implementation that uses the local file system for its storage.
+      </p>
+      <p>
+        FileChannel works by writing all transactions to a set of directories
+        specified in the configuration. Additionally, when a commit occurs
+        the transaction is synced to disk. Pointers to events put on the
+        channel are stored in memory. As such, each event on the queue
+        will require 8 bytes of DirectMemory (non-heap). However, the channel
+        will only allow a configurable number messages into the channel.
+        The appropriate amount of direct memory for said capacity,
+        must be allocated to the JVM via the JVM property: -XX:MaxDirectMemorySize
+      </p>
+
+
+    </section>
+
+  </body>
+</document>
\ No newline at end of file

Added: incubator/flume/branches/flume-1262/flume-ng-channels/flume-jdbc-channel/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/incubator/flume/branches/flume-1262/flume-ng-channels/flume-jdbc-channel/src/site/xdoc/index.xml?rev=1351592&view=auto
==============================================================================
--- incubator/flume/branches/flume-1262/flume-ng-channels/flume-jdbc-channel/src/site/xdoc/index.xml
(added)
+++ incubator/flume/branches/flume-1262/flume-ng-channels/flume-jdbc-channel/src/site/xdoc/index.xml
Tue Jun 19 07:40:16 2012
@@ -0,0 +1,35 @@
+<?xml version="1.0"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<document>
+  <properties>
+    <title>Apache Flume JDBC Channel</title>
+    <author email="rgoers@apache.org">Ralph Goers</author>
+  </properties>
+
+  <body>
+    <section name="Flume JDBC Channel">
+
+      <p>
+        A durable Channel implementation that uses a database accessed via JDBC for its storage.
+      </p>
+
+    </section>
+
+  </body>
+</document>
\ No newline at end of file

Added: incubator/flume/branches/flume-1262/flume-ng-channels/flume-recoverable-memory-channel/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/incubator/flume/branches/flume-1262/flume-ng-channels/flume-recoverable-memory-channel/src/site/xdoc/index.xml?rev=1351592&view=auto
==============================================================================
--- incubator/flume/branches/flume-1262/flume-ng-channels/flume-recoverable-memory-channel/src/site/xdoc/index.xml
(added)
+++ incubator/flume/branches/flume-1262/flume-ng-channels/flume-recoverable-memory-channel/src/site/xdoc/index.xml
Tue Jun 19 07:40:16 2012
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<document>
+  <properties>
+    <title>Apache Flume Recoverable Memory Channel</title>
+    <author email="rgoers@apache.org">Ralph Goers</author>
+  </properties>
+
+  <body>
+    <section name="Flume Recoverable Memory Channel">
+
+      <p>
+        A Channel implementation that uses the local memory for its storage.
+      </p>
+
+
+    </section>
+
+  </body>
+</document>
\ No newline at end of file

Added: incubator/flume/branches/flume-1262/flume-ng-clients/flume-ng-log4jappender/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/incubator/flume/branches/flume-1262/flume-ng-clients/flume-ng-log4jappender/src/site/xdoc/index.xml?rev=1351592&view=auto
==============================================================================
--- incubator/flume/branches/flume-1262/flume-ng-clients/flume-ng-log4jappender/src/site/xdoc/index.xml
(added)
+++ incubator/flume/branches/flume-1262/flume-ng-clients/flume-ng-log4jappender/src/site/xdoc/index.xml
Tue Jun 19 07:40:16 2012
@@ -0,0 +1,56 @@
+<?xml version="1.0"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<document>
+  <properties>
+    <title>Apache Flume Log4j Appender</title>
+    <author email="rgoers@apache.org">Ralph Goers</author>
+  </properties>
+
+  <body>
+    <section name="Flume Log4j Appender">
+
+      <p>
+        Appends Log4j Events to an external Flume client which is decribed by
+        the Log4j configuration file. The appender takes two required parameters:
+        <br />
+        <strong>Hostname</strong> : This is the hostname of the first hop
+        at which Flume (through an AvroSource) is listening for events.
+        <br />
+        <strong>Port</strong> : This the port on the above host where the Flume
+        Source is listening for events.
+      </p>
+      <p>
+        A sample log4j properties file which appends to a source would look like:
+      </p>
+      <pre>
+        log4j.appender.out2 = org.apache.flume.clients.log4jappender.Log4jAppender
+        log4j.appender.out2.Port = 25430
+        log4j.appender.out2.Hostname = foobarflumesource.com
+        log4j.logger.org.apache.flume.clients.log4jappender = DEBUG,out2</pre>
+       <p><i>Note: Change the last line to the package of the class(es), that
will
+        do the appending.For example if classes from the package
+        com.bar.foo are appending, the last line would be:</i><br />
+        <pre><p>log4j.logger.com.bar.foo = DEBUG,out2</p></pre>
+       </p>
+
+
+    </section>
+
+  </body>
+</document>
\ No newline at end of file



Mime
View raw message