flume使用之httpSource

flume自带很长多的source，如：exe、kafka...其中有一个非常简单的source——httpsource，使用httpSource，flume启动后会拉起一个web服务来监听指定的ip和port。常用的使用场景：对于有些应用环境中，不能部署Flume SDK及其依赖项，可以在代码中通过HTTP而不是Flume的PRC发送数据的情况，此时HTTP SOURCE可以用来将数据接收到Flume中。

1、httpsource 参数：

配置参数	默认值	描述
type		http (org.apache.fluem.source.httpSource）
bind		绑定的IP地址或主机名
port		绑定的端口号
enableSSL	false
keystore		使用的keystore文件的路径
keystorePassword		能够进入keystore的密码
handler	JSONHandler	HTTP SOURCE使用的处理程序类
handler.*		传给处理程序类的任何参数 可以 通过使用此参数（*）配置传入

1）handler：

Flume使用一个可插拔的“handler”程序来实现转换，如果不指定默认是：JSONHandler，它能处理JSON格式的事件，格式如下。此外用户可以自定义handler，必须实现HTTPSourceHandler接口。

json数据格式：

1. [ { "headers":{"":"","":""
2. },
3. "body":"the first event"
4. },
5. { "headers":{"":"","":""
6. },
7. "body":"the second event"
8. }
9. ]

2、简单介绍一下flume的logger sink：

记录INFO级别的日志，一般用于调试。本文将使用这种类型的sink，配置的属性：

• type  logger
• maxBytesToLog    16    Maximum number of bytes of the Event body to log

注意：要求必须在 --conf 参数指定的目录下有 log4j的配置文件，可以通过-Dflume.root.logger=INFO,console在命令启动时手动指定log4j参数。

3、简单的httpSource实例：

1）下载flume、解压：

1. cd /usr/local/
2. wget http://mirror.bit.edu.cn/apache/flume/1.7.0/apache-flume-1.7.0-bin.tar.gz
3. tar -xvzf apache-flume-1.7.9-bin.tar.gz

配置flume的环境变量：

1. vim /etc/profile
2. export PS1="[\u@`/sbin/ifconfig eth0|grep 'inet '|awk -F'[: ]+' '{print $4}'` \W]"'$ '
3. export FLUME_HOME=/usr/local/apache-flume-1.6.0-bin
4. export PATH=$PATH:$FLUME_HOME/bin

2）安装jdk、配置环境变量；

3）配置flume：

1. cd /usr/local/flume/conf
2. vim flume-env.sh

指定java_home，同时放入如下log4j.properties

1. ### set log levels ###
2. log4j.rootLogger = info,stdout ,  D ,  E
3. ###
4. log4j.appender.stdout = org.apache.log4j.ConsoleAppender
5. log4j.appender.stdout.Target = System.out
6. log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
7. log4j.appender.stdout.layout.ConversionPattern =  [%d{MM-dd HH:mm:ss}] [%p] [%c:%L] %m%n
8. ### 输出到日志文件 ###
9. log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
10. log4j.appender.D.File = /data/logs/flume/flume.log
11. log4j.appender.D.Append = true
12. log4j.appender.D.Threshold = info
13. log4j.appender.D.layout = org.apache.log4j.PatternLayout
14. log4j.appender.D.layout.ConversionPattern = [%d{MM-dd HH:mm:ss}] [%p] [%c:%L] %m%n
15. ### 保存异常信息到单独文件 ###
16. log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
17. log4j.appender.E.File =/data/logs/flume/flume_error.log
18. log4j.appender.E.Append = true
19. log4j.appender.E.Threshold = ERROR
20. log4j.appender.E.layout = org.apache.log4j.PatternLayout
21. log4j.appender.E.layout.ConversionPattern = [%d{MM-dd HH:mm:ss}] [%p] [%c:%L] %m%n
22. ### sink
23. log4j.logger.com.iqiyi.ttbrain.log.flume.sink.MysqlSink= INFO, F, EE
24. log4j.additivity.com.iqiyi.ttbrain.log.flume.sink.MysqlSink = false
25. log4j.appender.F= org.apache.log4j.DailyRollingFileAppender
26. log4j.appender.F.File=/data/logs/flume/flume_sink.log
27. log4j.appender.F.Append = true
28. log4j.appender.F.Threshold = info
29. log4j.appender.F.layout=org.apache.log4j.PatternLayout
30. log4j.appender.F.layout.ConversionPattern= [%d{MM-dd HH:mm:ss}] [%p] [%c:%L] %m%n
31. log4j.appender.EE= org.apache.log4j.DailyRollingFileAppender
32. log4j.appender.EE.File=/data/logs/flume/flume_sink_error.log
33. log4j.appender.EE.Append = true
34. log4j.appender.EE.Threshold = ERROR
35. log4j.appender.EE.layout=org.apache.log4j.PatternLayout
36. log4j.appender.EE.layout.ConversionPattern= [%d{MM-dd HH:mm:ss}] [%p] [%c:%L] %m%n

4）配置httpSource：

1. cd /usr/local/flume/conf
2. vim http_test.conf
3. a1.sources=r1
4. a1.sinks=k1
5. a1.channels=c1
6. a1.sources.r1.type=http
7. a1.sources.r1.bind=localhost
8. a1.sources.r1.port=50000
9. a1.sources.r1.channels=c1
10. a1.sinks.k1.type=logger
11. a1.sinks.k1.channel=c1
12. a1.channels.c1.type=memory
13. a1.channels.c1.capacity=1000
14. a1.channels.c1.transactionCapacity=100

5）启动flume：

1. flume-ng agent -c /usr/local/flume/conf/ -f /usr/local/flume/conf/http_test.conf -n a1

6）测试：

开一个shell窗口，输入命令：

1. curl -X POST -d'[{"headers":{"h1":"v1","h2":"v2"},"body":"hello body"}]'  http://localhost:50000

在/data/log/flume/flume.log 文件中可以看到：

1. [09-29 10:31:12] [INFO] [org.apache.flume.sink.LoggerSink:94] Event: { headers:{h1=v1, h2=v2} body: 68 65 6C 6C 6F 20 62 6F 64 79                   hello body }

4、自定义handler：

假定xml请求格式，期望格式如下：

1. <events>
2. <event>
3. <headers><header1>value1</header1></headers>
4. <body>test</body>
5. </event>
6. <event>
7. <headers><header1>value1</header1></headers>
8. <body>test2</body>
9. </event>
10. </events>

1）pom.xml

1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
3. <modelVersion>4.0.0</modelVersion>
4. <groupId>org.pq</groupId>
5. <artifactId>flume-demo</artifactId>
6. <packaging>jar</packaging>
7. <version>1.0</version>
8. <name>flume-demo Maven jar</name>
9. <url>http://maven.apache.org</url>
10. <dependencies>
11. <dependency>
12. <groupId>junit</groupId>
13. <artifactId>junit</artifactId>
14. <version>4.8.2</version>
15. <scope>test</scope>
16. </dependency>
17. <dependency>
18. <groupId>org.slf4j</groupId>
19. <artifactId>slf4j-log4j12</artifactId>
20. <version>1.7.7</version>
21. <scope>compile</scope>
22. </dependency>
23. <dependency>
24. <groupId>org.apache.flume</groupId>
25. <artifactId>flume-ng-core</artifactId>
26. <version>1.6.0</version>
27. <scope>compile</scope>
28. </dependency>
29. </dependencies>
30. <build>
31. <finalName>flume-demo</finalName>
32. </build>
33. </project>

2）自定义handler：

1. package org.pq.flumeDemo.sources;
2. import com.google.common.base.Preconditions;
3. import org.apache.flume.Context;
4. import org.apache.flume.Event;
5. import org.apache.flume.event.EventBuilder;
6. import org.apache.flume.source.http.HTTPBadRequestException;
7. import org.apache.flume.source.http.HTTPSourceHandler;
8. import org.slf4j.Logger;
9. import org.slf4j.LoggerFactory;
10. import org.w3c.dom.Document;
11. import org.w3c.dom.Element;
12. import org.w3c.dom.Node;
13. import org.w3c.dom.NodeList;
14. import org.xml.sax.SAXException;
15. import javax.servlet.http.HttpServletRequest;
16. import javax.xml.parsers.DocumentBuilder;
17. import javax.xml.parsers.DocumentBuilderFactory;
18. import java.util.ArrayList;
19. import java.util.HashMap;
20. import java.util.List;
21. import java.util.Map;
22. public class HTTPSourceXMLHandler implements HTTPSourceHandler {
23. private final String ROOT = "events";
24. private final String EVENT_TAG = "event";
25. private final String HEADERS_TAG = "headers";
26. private final String BODY_TAG = "body";
27. private final String CONF_INSERT_TIMESTAMP = "insertTimestamp";
28. private final String TIMESTAMP_HEADER = "timestamp";
29. private final DocumentBuilderFactory documentBuilderFactory
30. = DocumentBuilderFactory.newInstance();
31. // Document builders are not thread-safe.
32. // So make sure we have one for each thread.
33. private final ThreadLocal<DocumentBuilder> docBuilder
34. = new ThreadLocal<DocumentBuilder>();
35. private boolean insertTimestamp;
36. private static final Logger LOG = LoggerFactory.getLogger(HTTPSourceXMLHandler.class);
37. public List<Event> getEvents(HttpServletRequest httpServletRequest) throws HTTPBadRequestException, Exception {
38. if (docBuilder.get() == null) {
39. docBuilder.set(documentBuilderFactory.newDocumentBuilder());
40. }
41. Document doc;
42. final List<Event> events;
43. try {
44. doc = docBuilder.get().parse(httpServletRequest.getInputStream());
45. Element root = doc.getDocumentElement();
46. root.normalize();
47. // Verify that the root element is "events"
48. Preconditions.checkState(
49. ROOT.equalsIgnoreCase(root.getTagName()));
50. NodeList nodes = root.getElementsByTagName(EVENT_TAG);
51. LOG.info("get nodes={}",nodes);
52. int eventCount = nodes.getLength();
53. events = new ArrayList<Event>(eventCount);
54. for (int i = 0; i < eventCount; i++) {
55. Element event = (Element) nodes.item(i);
56. // Get all headers. If there are multiple header sections,
57. // combine them.
58. NodeList headerNodes
59. = event.getElementsByTagName(HEADERS_TAG);
60. Map<String, String> eventHeaders
61. = new HashMap<String, String>();
62. for (int j = 0; j < headerNodes.getLength(); j++) {
63. Node headerNode = headerNodes.item(j);
64. NodeList headers = headerNode.getChildNodes();
65. for (int k = 0; k < headers.getLength(); k++) {
66. Node header = headers.item(k);
67. // Read only element nodes
68. if (header.getNodeType() != Node.ELEMENT_NODE) {
69. continue;
70. }
71. // Make sure a header is inserted only once,
72. // else the event is malformed
73. Preconditions.checkState(
74. !eventHeaders.containsKey(header.getNodeName()),
75. "Header expected only once " + header.getNodeName());
76. eventHeaders.put(
77. header.getNodeName(), header.getTextContent());
78. }
79. }
80. Node body = event.getElementsByTagName(BODY_TAG).item(0);
81. if (insertTimestamp) {
82. eventHeaders.put(TIMESTAMP_HEADER, String.valueOf(System
83. .currentTimeMillis()));
84. }
85. events.add(EventBuilder.withBody(
86. body.getTextContent().getBytes(
87. httpServletRequest.getCharacterEncoding()),
88. eventHeaders));
89. }
90. } catch (SAXException ex) {
91. throw new HTTPBadRequestException(
92. "Request could not be parsed into valid XML", ex);
93. } catch (Exception ex) {
94. throw new HTTPBadRequestException(
95. "Request is not in expected format. " +
96. "Please refer documentation for expected format.", ex);
97. }
98. return events;
99. }
100. public void configure(Context context) {
101. insertTimestamp = context.getBoolean(CONF_INSERT_TIMESTAMP,
102. false);
103. }
104. }

打包成dependency，然后放到flume的lib下。

3）flume配置文件：

1. a1.sources=r1
2. a1.sinks=k1
3. a1.channels=c1
4. a1.sources.r1.type=http
5. a1.sources.r1.bind=localhost
6. a1.sources.r1.port=50000
7. a1.sources.r1.channels=c1
8. a1.sources.r1.handler=org.pq.flumeDemo.sources.HTTPSourceXMLHandler
9. a1.sources.r1.insertTimestamp=true
10. a1.sinks.k1.type=logger
11. a1.sinks.k1.channel=c1
12. a1.channels.c1.type=memory
13. a1.channels.c1.capacity=1000
14. a1.channels.c1.transactionCapacity=100

4）启动：

1. $ bin/flume-ng agent -c conf -f conf/http_test.conf  -n a1 -Dflume.root.logger=INFO,console