| Package | Description | 
|---|---|
| org.apache.flume | |
| org.apache.flume.agent.embedded | 
 This package provides Flume users the ability to embed simple agents
 in applications. 
 | 
| org.apache.flume.channel | |
| org.apache.flume.channel.file | |
| org.apache.flume.channel.jdbc | |
| org.apache.flume.channel.kafka | |
| org.apache.flume.lifecycle | |
| org.apache.flume.node | |
| org.apache.flume.sink | |
| org.apache.flume.sink.hbase | |
| org.apache.flume.sink.hbase2 | |
| org.apache.flume.sink.hdfs | |
| org.apache.flume.sink.hive | |
| org.apache.flume.sink.http | 
 This package provides an HTTP sink for Flume so that events can be sent out
 to a target HTTP endpoint. 
 | 
| org.apache.flume.sink.irc | |
| org.apache.flume.sink.kafka | |
| org.apache.flume.sink.solr.morphline | |
| org.apache.flume.source | |
| org.apache.flume.source.avroLegacy | |
| org.apache.flume.source.http | |
| org.apache.flume.source.jms | |
| org.apache.flume.source.kafka | |
| org.apache.flume.source.scribe | |
| org.apache.flume.source.taildir | |
| org.apache.flume.source.thriftLegacy | |
| org.apache.flume.source.twitter | 
| Modifier and Type | Interface and Description | 
|---|---|
interface  | 
Channel
 | 
interface  | 
EventDrivenSource
 | 
interface  | 
PollableSource
 | 
interface  | 
Sink
 A sink is connected to a Channel and consumes its contents,
 sending them to a configured destination that may vary according to
 the sink type. 
 | 
interface  | 
SinkProcessor
 Interface for a device that allows abstraction of the behavior of multiple
 sinks, always assigned to a SinkRunner 
 | 
interface  | 
Source
 A source generates  and calls methods on the
 configured  
ChannelProcessor to persist those events into the
 configured channels. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
SinkRunner
 | 
class  | 
SourceRunner
A source runner controls how a source is driven. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
EmbeddedSource
Simple source used to allow direct access to the channel for the Embedded
 Agent. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AbstractChannel  | 
class  | 
BasicChannelSemantics
 An implementation of basic  
Channel semantics, including the
 implied thread-local semantics of the Transaction class,
 which is required to extend BasicTransactionSemantics. | 
class  | 
MemoryChannel
 MemoryChannel is the recommended channel to use when speeds which
 writing to disk is impractical is required or durability of data is not
 required. 
 | 
class  | 
PseudoTxnMemoryChannel
 A capacity-capped  
Channel implementation that supports in-memory
 buffering and delivery of events. | 
class  | 
SpillableMemoryChannel
 SpillableMemoryChannel will use main memory for buffering events until it has reached capacity. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
FileChannel
 A durable  
Channel implementation that uses the local file system for
 its storage. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
JdbcChannel
 A JDBC based channel implementation. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
KafkaChannel  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
LifecycleSupervisor  | 
| Modifier and Type | Field and Description | 
|---|---|
LifecycleAware | 
LifecycleSupervisor.MonitorRunnable.lifecycleAware  | 
| Modifier and Type | Method and Description | 
|---|---|
boolean | 
LifecycleSupervisor.isComponentInErrorState(LifecycleAware component)  | 
void | 
LifecycleSupervisor.setDesiredState(LifecycleAware lifecycleAware,
               LifecycleState desiredState)  | 
void | 
LifecycleSupervisor.supervise(LifecycleAware lifecycleAware,
         LifecycleSupervisor.SupervisorPolicy policy,
         LifecycleState desiredState)  | 
void | 
LifecycleSupervisor.unsupervise(LifecycleAware lifecycleAware)  | 
static boolean | 
LifecycleController.waitForOneOf(LifecycleAware delegate,
            LifecycleState[] states)  | 
static boolean | 
LifecycleController.waitForOneOf(LifecycleAware delegate,
            LifecycleState[] states,
            long timeout)  | 
static boolean | 
LifecycleController.waitForState(LifecycleAware delegate,
            LifecycleState state)  | 
static boolean | 
LifecycleController.waitForState(LifecycleAware delegate,
            LifecycleState state,
            long timeout)  | 
| Modifier and Type | Method and Description | 
|---|---|
static void | 
LifecycleController.stopAll(List<LifecycleAware> services)  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
PollingPropertiesFileConfigurationProvider
Deprecated. 
 
Use UriConfigurationProvider instead. 
 | 
class  | 
PollingZooKeeperConfigurationProvider  | 
class  | 
PropertiesFileConfigurationProvider
Deprecated. 
 
Use UriConfigurationProvider. 
 | 
class  | 
UriConfigurationProvider
 A configuration provider that uses properties for specifying
 configuration. 
 | 
| Constructor and Description | 
|---|
Application(List<LifecycleAware> components)  | 
| Modifier and Type | Interface and Description | 
|---|---|
static interface  | 
LoadBalancingSinkProcessor.SinkSelector
 An interface that allows the LoadBalancingSinkProcessor to use
 a load-balancing strategy such as round-robin, random distribution etc. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AbstractRpcSink
This sink provides the basic RPC functionality for Flume. 
 | 
class  | 
AbstractSingleSinkProcessor
A Sink Processor that only accesses a single Sink. 
 | 
class  | 
AbstractSink  | 
class  | 
AbstractSinkProcessor
A convenience base class for sink processors. 
 | 
class  | 
AbstractSinkSelector  | 
class  | 
AvroSink
 A  
Sink implementation that can send events to an RPC server (such as
 Flume's AvroSource). | 
class  | 
DefaultSinkProcessor
Default sink processor that only accepts a single sink, passing on process
 results without any additional handling. 
 | 
class  | 
FailoverSinkProcessor
FailoverSinkProcessor maintains a prioritized list of sinks,
 guarranteeing that so long as one is available events will be processed. 
 | 
class  | 
LoadBalancingSinkProcessor
Provides the ability to load-balance flow over multiple sinks. 
 | 
class  | 
LoggerSink
 A  
Sink implementation that logs all events received at the INFO level
 to the org.apache.flume.sink.LoggerSink logger. | 
class  | 
NullSink
 A  
Sink implementation that simply discards all events it receives. | 
class  | 
RollingFileSink  | 
class  | 
ThriftSink
 A  
Sink implementation that can send events to an RPC server (such as
 Flume's ThriftSource). | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AsyncHBaseSink
A simple sink which reads events from a channel and writes them to HBase. 
 | 
class  | 
HBaseSink
A simple sink which reads events from a channel and writes them to HBase. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
HBase2Sink
A simple sink which reads events from a channel and writes them to HBase 2. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
HDFSEventSink  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
HiveSink  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
HttpSink
Implementation of an HTTP sink. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
IRCSink  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
KafkaSink
A Flume Sink that can publish messages to Kafka. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
MorphlineSink
Flume sink that extracts search documents from Flume events and processes them using a morphline
  
Command chain. | 
class  | 
MorphlineSolrSink
Flume sink that extracts search documents from Flume events, processes them using a morphline
  
Command chain, and loads them into Apache Solr. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AbstractEventDrivenSource
Base class which ensures sub-classes will inherit all the properties
 of BasicSourceSemantics. 
 | 
class  | 
AbstractPollableSource
Base class which ensures sub-classes will inherit all the properties
 of BasicSourceSemantics in addition to:
 
 Ensuring when configure/start throw an exception process will not
 be called
 Ensure that process will not be called unless configure and start
 have successfully been called
  
 | 
class  | 
AbstractSource  | 
class  | 
AvroSource
 A  
Source implementation that receives Avro events from clients that
 implement AvroSourceProtocol. | 
class  | 
BasicSourceSemantics
Alternative to AbstractSource, which:
 
  Ensure configure cannot be called while started
  Exceptions thrown during configure, start, stop put source in ERROR state
  Exceptions thrown during start, stop will be logged but not re-thrown.
  Exception in configure disables starting
  
 | 
class  | 
EventDrivenSourceRunner
Starts, stops, and manages
 event-driven sources. 
 | 
class  | 
ExecSource
 A  
Source implementation that executes a Unix process and turns each
 line of text into an event. | 
class  | 
MultiportSyslogTCPSource  | 
class  | 
NetcatSource
 A netcat-like source that listens on a given port and turns each line of text
 into an event. 
 | 
class  | 
NetcatUdpSource  | 
class  | 
PollableSourceRunner
 An implementation of  
SourceRunner that can drive a
 PollableSource. | 
class  | 
SequenceGeneratorSource  | 
class  | 
SpoolDirectorySource  | 
class  | 
SslContextAwareAbstractSource  | 
class  | 
StressSource
StressSource is an internal load-generating source implementation
 which is very useful for stress tests. 
 | 
class  | 
SyslogTcpSource
Deprecated. 
 
use  
MultiportSyslogTCPSource instead. | 
class  | 
SyslogUDPSource  | 
class  | 
ThriftSource  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AvroLegacySource
 A  
Source implementation that receives Avro events from Avro sink of
 Flume OG | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
HTTPSource
A source which accepts Flume Events by HTTP POST and GET. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
JMSSource  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
KafkaSource
A Source for Kafka which reads messages from kafka topics. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
ScribeSource
Flume should adopt the Scribe entry  
LogEntry from existing
 Scribe system. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
TaildirSource  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
ThriftLegacySource  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
TwitterSource
Demo Flume source that connects via Streaming API to the 1% sample twitter
 firehose, continuously downloads tweets, converts them to Avro format and
 sends Avro events to a downstream Flume sink. 
 | 
Copyright © 2009-2022 Apache Software Foundation. All Rights Reserved.