Flume Cookbook
===============
flume-dev@cloudera.org

// version number comes from command line.

////////////////////
Licensed to Cloudera, Inc. under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  Cloudera, Inc. 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.
////////////////////

// Upgrading to use asciidoc 8.4.4
// Build using 'asciidoc -a toc FullGuide'

== Introduction

Flume is a distributed, reliable, and available service for
efficiently collecting, aggregating, and moving large amounts of log
data.  Being highly configurable and very extensible means that there
are many options and thus many decisions that need to be made by an
operator.  This document is a "cookbook" with "recipes" for getting
Flume up and running quickly without being overwhelmed with all the
details.

This document starts with some basic tips on experimenting with Flume
nodes, and then three stories about setting up agents for different
kinds of sources.  Finally we'll do a quick setup for collectors and
how to troubleshoot distributed deployments.

* Basic debugging with one-shot Flume nodes
* Flume agents for Apache web server logging
* Flume agents for syslog / syslog-ng logging
* Flume agents for scribe logging
// * Flume agents for logging via log4j
// * Configuring nodes on node startup
// * Small Deployments.

include::Testing[]
include::Apache[]
include::Syslog[]
include::Scribe[]
// include::Log4J[]
// include::ConfigOnStart[]
// include::SmallDeploy[]


     ______
    / ___//_  ______  ____
   / /_/ / / / /    \/ __/
  / __/ / /_/ / / / / __/
 / / /_/\____/_/_/_/\__/
/_/ Distributed Log Collection.