[ 
https://issues.apache.org/jira/browse/FLUME-1634?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13474271#comment-13474271
 ] 

Brock Noland edited comment on FLUME-1634 at 10/11/12 4:10 PM:
---------------------------------------------------------------

I have a patch, which is really just a POC, which generate the following output 
after scanning the source code. Below is from FileChannel only.

{code}
keep-alive              3                                       Seconds         
Integer                 Advanced        Amount of time to wait for a put 
operation                    
transactionCapacity     1000                                    Events          
Integer                 Advanced        The maximum size of transaction 
supported by the channel      
use-fast-replay         false                                   -               
Boolean                 Advanced        Use fast full replay logic              
                      
capacity                1000000                                 Events          
Integer                 Public          Maximum capacity of the channel         
                      
checkpointInterval      30000                                   Milliseconds    
Long                    Advanced        Amount of time between checkpoints      
                      
maxFileSize             1623195648                              Bytes           
Long                    Advanced        Max size of a single log file           
                      
write-timeout           10                                      Seconds         
Integer                 Advanced        Amount of time to wait for a write 
operation                  
dataDirs                $HOME/.flume/file-channel/data          -               
Comma Seperated String  Public          The directories where log files will be 
stored.               
checkpoint-timeout      600                                     Seconds         
Integer                 Advanced        Amount of time to wait for writes to 
queuese for a checkpoint 
checkpointDir           $HOME/.flume/file-channel/checkpoint    -               
String                  Public          The directory where checkpoint file 
will be stored            
{code}
                
      was (Author: brocknoland):
    I have a patch, which is really just a POC, which generate the following 
output after scanning the source code.

{code}
keep-alive              3                                       Seconds         
Integer                 Advanced        Amount of time to wait for a put 
operation                    
transactionCapacity     1000                                    Events          
Integer                 Advanced        The maximum size of transaction 
supported by the channel      
use-fast-replay         false                                   -               
Boolean                 Advanced        Use fast full replay logic              
                      
capacity                1000000                                 Events          
Integer                 Public          Maximum capacity of the channel         
                      
checkpointInterval      30000                                   Milliseconds    
Long                    Advanced        Amount of time between checkpoints      
                      
maxFileSize             1623195648                              Bytes           
Long                    Advanced        Max size of a single log file           
                      
write-timeout           10                                      Seconds         
Integer                 Advanced        Amount of time to wait for a write 
operation                  
dataDirs                $HOME/.flume/file-channel/data          -               
Comma Seperated String  Public          The directories where log files will be 
stored.               
checkpoint-timeout      600                                     Seconds         
Integer                 Advanced        Amount of time to wait for writes to 
queuese for a checkpoint 
checkpointDir           $HOME/.flume/file-channel/checkpoint    -               
String                  Public          The directory where checkpoint file 
will be stored            
{code}
                  
> Configuration documentation could be generated automatically
> ------------------------------------------------------------
>
>                 Key: FLUME-1634
>                 URL: https://issues.apache.org/jira/browse/FLUME-1634
>             Project: Flume
>          Issue Type: Bug
>          Components: Configuration, Docs
>            Reporter: Brock Noland
>
> We could use annotations to automatically generate documentation on these 
> options. It's also possible that this could be used while validating the 
> configuration.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Reply via email to