Add files via upload

Commit the draft code.

Author: liuboxa

IBMDCO.md

@@ -0,0 +1,21 @@
+# IBM Process For Accepting Third Party Code Contributions
+
+To improve tracking of contributions to this project we will use a process modeled on the modified DCO 1.1 and use a "sign-off" procedure on patches that are being emailed around or contributed in any other way.
+
+The sign-off is a simple line within the pull requests comments section, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch.  The rules are pretty simple, if you can certify the below:
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source License and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
+
+(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
+
+(d) The contribution is made free of any other party's intellectual property claims or rights.
+
+(e) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
+
+Then you just add a line saying:
+
+	Signed-off-by: Random J Developer random@developer.org>

LICENSE.txt

@@ -0,0 +1,61 @@
+Apache License
+
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/ 
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+a.You must give any other recipients of the Work or Derivative Works a copy of this License; and
+b.You must cause any modified files to carry prominent notices stating that You changed the files; and
+c.You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+d.If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. 
+
+ You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+
+
+Dependencies are licensed under their respective licenses.
+
+
+
+END OF TERMS AND CONDITIONS
+

Makefile

@@ -0,0 +1,59 @@
+
+RELEASE_BUILD=`date '+%y%m%d'`
+BUILD_MONTH=$(shell date +%b)
+BUILD_DAY=$(shell date +%e)
+BUILD_YEAR=$(shell date +%Y)
+BUILD_TIME=${BUILD_DAY} ${BUILD_MONTH}, ${BUILD_YEAR}
+CURRENT_DIR=$(shell pwd)
+
+BEATS_VERSION=6.4.2
+
+_arch=x86_64
+_os=linux-${_arch}
+
+# env variable to build lsfeventsbeat
+LSFEVENTSBEAT_PACKAGE=lsfeventsbeat-${BEATS_VERSION}-${LSF_VERSION}-${BNAME}
+
+FILEBEAT_DIR=${BUILDTMP}/src/github.com/elastic/beats/filebeat
+
+prepare:clean
+	@echo "====================================================="
+	@echo "Prepare the building..."
+	@echo "====================================================="
+	@mkdir -p ${BUILDTMP} 
+
+build-lsfeventsbeat:	prepare
+    # get source code of filebeat to build lsfeventsbeat
+	@mkdir -p ${BUILDTMP}/src/github.com/elastic
+	@cd ${BUILDTMP}/src/github.com/elastic; git clone -b v6.4.2 https://github.com/elastic/beats.git
+    # overwrite some files with our modified versions
+	@cp -rf src/filebeat/parselsb ${FILEBEAT_DIR}/
+	@cp -rf src/filebeat/log/* ${FILEBEAT_DIR}/input/log/
+	@cp -rf src/lsfeventsparser ${FILEBEAT_DIR}/
+	@cp -rf src/outputs/rabbitmq ${FILEBEAT_DIR}/../libbeat/outputs/
+	@cp -rf src/outputs/rocketmq ${FILEBEAT_DIR}/../libbeat/outputs/
+	@cp -rf src/outputs/includes.go ${FILEBEAT_DIR}/../libbeat/publisher/includes/
+    # get dependent 3rd package 
+	@go get github.com/robfig/cron
+	@go get github.com/streadway/amqp
+	@go get github.com/sevenNt/rocketmq
+	
+    # copy lsbatch.h from include/lsf to include/
+	@cp -f ${LSF_LIB_PATH}/../../include/lsf/lsbatch.h ${LSF_LIB_PATH}/../../include/
+	
+    # rebuild filebeat with events parser
+	@cd ${FILEBEAT_DIR}/lsfeventsparser; make all
+	@cp -rf ${FILEBEAT_DIR}/lsfeventsparser/lib ${FILEBEAT_DIR}/
+	@cd ${FILEBEAT_DIR}; env CGO_CFLAGS="-I${FILEBEAT_DIR}/lib" CGO_LDFLAGS="-L${FILEBEAT_DIR}/lib -lreadlsbevents" make; mv filebeat lsfeventsbeat
+
+	# generate package
+	@mkdir ${BUILDTMP}/${LSFEVENTSBEAT_PACKAGE}
+	@cp ${FILEBEAT_DIR}/lsfeventsbeat ${BUILDTMP}/${LSFEVENTSBEAT_PACKAGE}
+	@cp -f README* ${BUILDTMP}/${LSFEVENTSBEAT_PACKAGE}/
+	@cp -f conf/* ${BUILDTMP}/${LSFEVENTSBEAT_PACKAGE}/	
+	@cp -Rf ${FILEBEAT_DIR}/lib ${BUILDTMP}/${LSFEVENTSBEAT_PACKAGE}	
+	@cd ${BUILDTMP}; tar cvf $(LSFEVENTSBEAT_PACKAGE).tar $(LSFEVENTSBEAT_PACKAGE); gzip $(LSFEVENTSBEAT_PACKAGE).tar; mv $(LSFEVENTSBEAT_PACKAGE).tar.gz ${BUILDTMP}/../	
+	@rm -rf  ${BUILDTMP}/src ${BUILDTMP}
+	
+clean:
+	@rm -rf ${BUILDTMP} 

README.md

@@ -1,2 +1,109 @@
-# lsfmq
-lsfmq provides one way for lsf users to integrate different kinds of messge queues with lsf.
+# lsfmq
+
+This project is intended to provide one way for lsf users to integrate different kinds of messge queues with lsf. 
+
+lsfeventsbeat is provided as a lsf event publisher which is enhanced from elastic filebeat, loading and parsing latest lsf events from lsf log files (lsb.acct/lsb.stream) and publishing data into message queues such as kafka, RabbitMQ, etc. Three kinds of data are published into message queue:
+
++ "lsf_acct":        Job finish events (from lsb.acct file)
++ "lsf_events":      All job events and LSF performance metrics (from lsb.stream file)
++ "lsf_job_status":  Job status tracing, published whenever a job status is changed, including current status, previous status, failed reason if job exit (transformed from lsb.stream file)
+
+Sample lsf data consumer is provided for each kind of messge queue to faciliate lsf users to customize their own data consumer based on their own business need.
+
+
+# Build the lsf publisher (lsfeventsbeat)
+
+__Note__
++ Make sure network is available
++ Make sure git has been installed
++ Download Go installation package from [Go download](https://golang.org/dl/) and set up your go environment.
+
+__Build Steps__
+1. Copy the codes into target directory.
+2. Specifiy below parameters in build.sh.
+    + LSF_VERSION - lsf version. Default value is LSF10
+    + BNAME - os platform. Defalut value is linux-x86_64
+    + LSF_LIB_PATH - LSF library path. e.g. /opt/lsf10_1_0_7/10.1/linux2.6-glibc2.3-x86_64/lib
+3. Run build.sh. If all things go well, package like lsfeventsbeat-6.4.2-${LSF_VERSION}-${BNAME}.tar.gz will be generated.
+``` bash
+    sh build.sh
+```
+
+# Setup the lsf publisher for your message queue
+
+__Note__: The package can be installed on any server either inside or outside lsf cluster. 
+
+1. Uncompress the tar.gz package generated above.
+``` bash
+    tar -zxvf lsfeventsbeat-6.4.2-LSF10-linux-x86_64.tar.gz
+```
+2. Copy libreadlsbevents.so to LSF_LIB_PATH specified in __Build__ step
+``` bash
+    cp lsfeventsbeat-6.4.2-LSF10-linux-x86_64/lib/libreadlsbevents.so ${LSF_LIB_PATH}
+```
+3. Add LSF_LIB_PATH to LD_LIBRARY_PATH
+``` bash
+    export LD_LIBRARY_PATH=${LSF_LIB_PATH}:${LD_LIBRARY_PATH}
+```
+
+# Config the lsf publisher for your message queue
+
+Ensure specify correct values for parameters below:
++ In "filebeat.inputs" section: 
+    - 'paths' is the absolute path of the latest lsf event file:  lsb.stream file for topic "lsf_events" and lsb.acct file for topic "lsf_acct".  To guarantee event order sent to message queue, only the latest lsb.events and lsb.acct file should be harvested. 
+    - 'cluster_name' is the name of your lsf cluster. 
+
++ In "output.*" section:
+    - hosts: specify correct "$ip:$port" of your message queue broker server(s).
+  
+__Note__: 
+You can also refer to [Configuring Filebeat](https://www.elastic.co/guide/en/beats/filebeat/current/configuring-howto-filebeat.html) for common file beat configuration.   
+    
+A option named lsf_topics has been added in filebeat.inputs section for lsf specific configuration. Take the below sample as an example.
+``` yml
+lsf_topics: 
+  - topic_name: "lsf_events"
+    type: "job.raw"
+    include_fields:
+      - version
+      - event_type
+      - event_time
+    exclude_fields:
+      - job_description
+    add_fields: {cluster_name: "lsf_cluster"}
+```
+
++ topic_name - Output message queue topic name
+    - for Kafka, it means topic name
+    - for RabbitMQ, it means exchange name
++ type - Parsed data type
+    - "job.raw" represents raw job event data
+    - "job.status.trace" represents generated job status trace data based on raw job data
++ include_fields - A list of fields name you want lsfeventsbeat to include
++ exclude_fields - A list of fields name you want lsfeventsbeat to exclude
+    - if both include_fields and exclude_fields are defined, lsfeventsbeat executes include_fields first and then executes exclude_fields. The order in which the two options are defined doesn’t matter. The include_fields option will always be executed before the exclude_fields option, even if exclude_fields appears before include_fields in the config file.
++ add_fields - Optional fields that you can specify to add additional information to the output
+
+
+# Run the lsf publisher for Kafka
+
+Enter the target directory and run lsfeventsbeat as below.
+``` bash
+    ./lsfeventsbeat -c lsfeventsbeat.yml
+```
+
+# Consume lsf events data in Kafka
+
+For example, use Kafka built-in consumer tool "kafka-console-consumer.sh" to subscribe Kafka topic "lsf_job_status"
+
+``` bash
+bin/kafka-console-consumer.sh --bootstrap-server 9.21.51.241:9092 --topic lsf_job_status --from-beginning
+{"app_profile":"","begin_time":0,"cluster_name":"test_cluster1","command":"sleep 10","cwd":"/env/lsf/work/cluster1/logdir/stream","depend_cond":"","event_time":"2018-10-18T05:47:38-0400","event_time_utc":1539856058,"event_type":"JOB_NEW","job_arr_idx":0,"job_description":"","job_group":"","job_id":101,"job_name":"yytest","num_arr_elements":1,"out_file":"","project_name":"default","queue_name":"normal","req_num_procs_max":1,"res_req":"","sla":"","src_cluster_name":"","submission_host_name":"icp5x1","submit_time":1539856058,"user_group_name":"","user_name":"u1","version":"10.1"}
+{"change_reason":"new job submitted","cluster_name":"","current_status":"PEND","job_arr_idx":0,"job_id":101}
+{"cluster_name":"test_cluster1","event_time":1539856059,"event_time_utc":1539856059,"event_type":"JOB_START_ACCEPT","job_arr_idx":0,"job_id":101,"start_time":1539856059,"version":"10.1"}
+{"change_reason":"job starts","cluster_name":"","current_status":"RUN","job_arr_idx":0,"job_id":101}
+{"cluster_name":"test_cluster1","cpu_time":0.076,"end_time":1539856070,"event_time":"2018-10-18T05:47:50-0400","event_time_utc":1539856070,"event_type":"JOB_STATUS","exit_info":0,"exit_status":0,"job_arr_idx":0,"job_id":101,"job_status":"DONE","job_status_code":64,"max_mem":0,"stime":0.06,"utime":0.016,"version":"10.1"}
+{"change_reason":"","cluster_name":"","current_status":"DONE","job_arr_idx":0,"job_id":101,"last_status":"RUN"}
+{"cluster_name":"test_cluster1","cpu_time":0.076,"end_time":1539856070,"event_time":"2018-10-18T05:47:50-0400","event_time_utc":1539856070,"event_type":"JOB_STATUS","exit_info":0,"exit_status":0,"job_arr_idx":0,"job_id":101,"job_status":"DONE+PDONE","job_status_code":192,"max_mem":0,"stime":0,"utime":0,"version":"10.1"}
+{"change_reason":"","cluster_name":"","current_status":"DONE+PDONE","job_arr_idx":0,"job_id":101}
+```