Commit 3c94c10f authored by Maiken's avatar Maiken
Browse files
parents d92b8c85 6ae873c9
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.
END OF TERMS AND CONDITIONS
Prerequisites
=============
The tool works by converting JURA's archived records in XML format into JSON
and submitting them to a specified ES instance. It is therefore assumed that
the archiving option for JURA is turned on in arc.conf.
Please note, that the tool is being tested only against the latest version of
the ES, and with the latest 'elasticsearch-py' module. The current version of
the master tree is not guaranteed to work with non-latest ES.
Installation
============
1. Make sure the next python modules are present on the endpoint (many are a
part of default python installation):
* xml
* json
* glob
* getopt
* os
* sys
* socket
* time
* re
* logging
* signal
* traceback
* elasticsearch
* watchdog
2. In the source code directory, run 'python setup.py install'.
2a. If you need to use other ES host/port and index, than the hardcoded
defaults,
run 'python setup.py install --eshost <hostname> --esport <portnumber>
--esindex <indexname>'
3. Start the tool with '/etc/init.d/jura_to_es start'
4. If needed, make 'jura_to_es' service startable at the boot with chkconfig
Logging
=======
The tool will log by default to '/var/log/arc/jura_to_es.log'. The setup script
also installs a logrorate entry for this file.
Some technical stuff
====================
* It's recommended to apply the mapping to your index before you start submit
data:
curl -XPUT http://your_es_host:your_es_port/your_es_index \
-d @usagerecords.mapping.json -H "Content-Type: application/json"
* The init script has 'dmytrok_arc_test' index hardcoded in itself. Should be
changed when/if we create new production indices for ARC data.
* See also 'python jura_to_es.py --help'.
* The tool currently works not in the most efficient way. It picks up a new
file from the JURA archive dir, converts it, and submits to the ES endpoint.
Since ARC creates one record per accounting endpoint, for the same job -- it
means the tool converts the same job's archival record several times and polls
the ES several times as well (the submit only happens if the poll returns "The
document does not exist" status). That's why it's so desirable that ARC itself
performs the submission to ES: treating the ES as just yet another endpoint
would only interact with the ES once per each job and even can allow to perform
batch-submissions.
* If ARC does not implement it and we have to rely on the tool for a long time,
it might be desirable to implement some mechanism that polls/submits the ES only
once per each job.
/var/log/arc/jura_to_es.log {
missingok
compress
delaycompress
daily
rotate 14
copytruncate
}
#!/bin/sh
#
# JURA to ES conversion tool
#
# chkconfig: - 75 25
# description: JURA to ES conversion tool
#
# config: /etc/arc.conf
### BEGIN INIT INFO
# Provides: jura_to_es
# Required-Start: $local_fs $remote_fs
# Required-Stop: $local_fs $remote_fs
# Default-Start:
# Default-Stop:
# Short-Description: JURA to ES conversion tool
# Description: jura_to_es converts JURA's XML archive files to JSON and submit it to the ES
### END INIT INFO
# source function library
if [ -f /etc/init.d/functions ]; then
. /etc/init.d/functions
log_success_msg() {
echo -n "$@"
success "$@"
echo
}
log_warning_msg() {
echo -n "$@"
warning "$@"
echo
}
log_failure_msg() {
echo -n "$@"
failure "$@"
echo
}
elif [ -f /lib/lsb/init-functions ]; then
. /lib/lsb/init-functions
else
echo "Error: Cannot source neither init.d nor lsb functions"
exit 1
fi
prog=jura_to_es
# sysconfig files
if [ -r /etc/sysconfig/${prog} ]; then
. /etc/sysconfig/${prog}
elif [ -r /etc/default/${prog} ]; then
. /etc/default/${prog}
fi
# ARC_CONFIG
if [ "x$ARC_CONFIG" = "x" ]; then
if [ -r $ARC_LOCATION/etc/arc.conf ]; then
ARC_CONFIG=$ARC_LOCATION/etc/arc.conf
elif [ -r /etc/arc.conf ]; then
ARC_CONFIG=/etc/arc.conf
fi
fi
if [ ! -r "$ARC_CONFIG" ]; then
log_failure_msg "ARC configuration not found (usually /etc/arc.conf)"
exit 1
fi
CMD=/usr/bin/python
if [ ! -x "$CMD" ]; then
log_failure_msg "Cannot find python executable"
exit 1
fi
JURA_ARCHIVING_DIR=`grep archiving ${ARC_CONFIG} | awk -F'#' '{print $1;}' | sed -n -e 's/^.*archiving:\(.*\)"/\1/p' | awk -F',' '{print $1;}'`
if [ ! -d "$JURA_ARCHIVING_DIR" ]; then
log_failure_msg "JURA archiving dir not found (no such dir $JURA_ARCHIVING_DIR)"
exit 1
fi
PID_FILE="/var/run/arc/jura_to_es.pid"
LOG_FILE="/var/log/arc/jura_to_es.log"
if [ `id -u` = 0 ] ; then
# Debian does not have /var/lock/subsys
if [ -d /var/lock/subsys ]; then
LOCKFILE=/var/lock/subsys/$prog
else
LOCKFILE=/var/lock/$prog
fi
if [ "x$PID_FILE" = "x" ]; then
PID_FILE=/var/run/$prog.pid
fi
if [ "x$LOG_FILE" = "x" ]; then
LOG_FILE=/var/log/arc/$prog.log
fi
else
LOCKFILE=$HOME/$prog.lock
if [ "x$PID_FILE" = "x" ]; then
PID_FILE=$HOME/$prog.pid
fi
if [ "x$LOG_FILE" = "x" ]; then
LOG_FILE=$HOME/$prog.log
fi
fi
#CMDLAUNCHLINE#
start() {
echo -n "Starting $prog: "
# Check if we are already running
if [ -f $PID_FILE ]; then
read pid < $PID_FILE
if [ "x$pid" != "x" ]; then
ps -p "$pid" -o comm 2>/dev/null | grep "^python$" 1>/dev/null 2>/dev/null
if [ $? -eq 0 ] ; then
log_success_msg "already running (pid $pid)"
return 0
fi
fi
rm -f "$PID_FILE" "$LOCKFILE"
fi
eval "$CMD"
RETVAL=$?
if [ $RETVAL -eq 0 ]; then
touch $LOCKFILE
log_success_msg
else
log_failure_msg
fi
return $RETVAL
}
stop() {
echo -n "Stopping $prog: "
if [ -f "$PID_FILE" ]; then
read pid < "$PID_FILE"
if [ ! -z "$pid" ] ; then
kill "$pid"
RETVAL=$?
if [ $RETVAL -eq 0 ]; then
log_success_msg
else
log_failure_msg
fi
sleep 1
kill -9 "$pid" 1>/dev/null 2>&1
rm -f "$PID_FILE" "$LOCKFILE"
else
RETVAL=1
log_failure_msg "$prog shutdown - pidfile is empty"
fi
else
RETVAL=0
log_success_msg "$prog shutdown - already stopped"
fi
return $RETVAL
}
status() {
if [ -f "$PID_FILE" ]; then
read pid < "$PID_FILE"
if [ "$pid" != "" ]; then
if ps -p "$pid" > /dev/null; then
echo "$1 (pid $pid) is running..."
return 0
fi
echo "$1 stopped but pid file exists"
return 1
fi
fi
if [ -f $LOCKFILE ]; then
echo "$1 stopped but lockfile exists"
return 2
fi
echo "$1 is stopped"
return 3
}
restart() {
stop
start
}
case "$1" in
start)
start
;;
stop)
stop
;;
status)
status $prog
;;
restart | force-reload)
restart
;;
reload)
;;
condrestart | try-restart)
[ -f $LOCKFILE ] && restart || :
;;
*)
echo "Usage: $0 {start|stop|status|restart|force-reload|reload|condrestart|try-restart}"
exit 1
;;
esac
exit $?
# Copyright 2017 Dmytro Karpenko
#
# Licensed 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.
import xml.etree.ElementTree as ET
import json, glob, getopt, os, sys, socket
import time, re, logging, signal, traceback
from elasticsearch import Elasticsearch
from watchdog.observers import Observer
from watchdog.events import RegexMatchingEventHandler
#----------------------------
def strip_namespace(name):
if name[0] == "{":
return name.split("}")[1]
else:
return name
#----------------------------
def ur_xml_to_json(xml_filename):
treeroot = ET.parse(xml_filename).getroot()
jdict = {}
for elem in treeroot:
elem_name = strip_namespace(elem.tag)
if elem_name == 'RecordIdentity':
for k, v in elem.attrib.iteritems():
jdict[strip_namespace(k)] = v
elif elem_name == 'JobIdentity':
for nested_elem in elem:
jdict[strip_namespace(nested_elem.tag)] = nested_elem.text
elif elem_name == 'UserIdentity':
for nested_elem in elem:
if strip_namespace(nested_elem.tag) == "VO":
for k, v in nested_elem.attrib.iteritems():
jdict["VO"+strip_namespace(k)] = v
jdict["VOattributes"] = []
for nested_nested_elem in nested_elem:
if strip_namespace(nested_nested_elem.tag) == "Attribute":
jdict["VOattributes"].append({})
for n_n_n_elem in nested_nested_elem:
if n_n_n_elem.text:
jdict["VOattributes"][-1][strip_namespace(n_n_n_elem.tag)] = n_n_n_elem.text
elif nested_nested_elem.text:
jdict["VO"+strip_namespace(nested_nested_elem.tag)] = nested_nested_elem.text
else:
jdict[strip_namespace(nested_elem.tag)] = nested_elem.text
elif elem_name == 'JobName' or \
elem_name == 'Status' or \
elem_name == 'WallDuration' or \
elem_name == 'StartTime' or \
elem_name == 'EndTime'or \
elem_name == 'MachineName' or \
elem_name == 'Host' or \
elem_name == 'SubmitHost' or \
elem_name == 'Queue' or \
elem_name == 'NodeCount' or \
elem_name == 'Processors' or \
elem_name == 'RuntimeEnvironment':
jdict[elem_name] = elem.text
elif elem_name == "Memory":
for k, v in elem.attrib.iteritems():
jdict["Memory"+strip_namespace(k)] = v
jdict[elem_name] = elem.text
elif elem_name == "CpuDuration":
for k, v in elem.attrib.iteritems():
jdict["CpuDuration"+v] = elem.text
elif elem_name == "FileTransfers":
jdict["FileDownloads"] = []
jdict["FileUploads"] = []
for nested_elem in elem:
transfer_key = strip_namespace(nested_elem.tag)
jdict[transfer_key + "s"].append({})
for nested_nested_elem in nested_elem:
jdict[transfer_key + "s"][-1][strip_namespace(nested_nested_elem.tag)] = nested_nested_elem.text
else:
logging.warning("Encountered an unknown entry in XML: " + elem_name)
# Do not need the recordId, it's already constructed before this subroutine
del jdict["recordId"]
return jdict
#----------------------------
def convert_and_submit_document(es, es_index, recordId, ur_xml):
try:
if not es.exists(index = es_index, doc_type = 'doc', id = recordId):
ur_json = ur_xml_to_json(ur_xml)
es_res = es.index(index = es_index, doc_type = 'doc', id = recordId, body = ur_json)
if es_res['result'] != 'created':
return 1
else:
return 0
else:
return 2
except:
logging.critical("Unexpected exception when trying to submit the document")
logging.critical(traceback.format_exc())
return 1
#----------------------------
class ArchiveFilesHandler(RegexMatchingEventHandler):
def __init__(self, regexes, ignore_directories, case_sensitive, record_prefix, es, es_index):
RegexMatchingEventHandler.__init__(self, regexes=regexes,
ignore_directories=ignore_directories,
case_sensitive=case_sensitive)
self.record_prefix = record_prefix
self.es = es
self.es_index = es_index
def process(self, event):
# the file will be processed there
logging.info("Converting " + event.src_path + " and submitting it to the ES")
recordId = self.record_prefix + re.split("/|\.", event.src_path)[-2]
submit_res = convert_and_submit_document(self.es, self.es_index, recordId, event.src_path)
if submit_res == 1:
logging.info("There was a problem submitting the document")
elif submit_res == 2:
logging.info("The document already exists, skipping")
else:
logging.info("The document was successfully submitted")
def on_created(self, event):
self.process(event)
#----------------------------
def daemonize(pidfile):
'''
Do double fork to create daemon process
'''
try:
pid = os.fork()
if pid > 0:
# exit first parent
sys.exit(0)
except OSError: