-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathevent-listener.html
113 lines (100 loc) · 4.95 KB
/
event-listener.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>10.8. Event Listener — Presto 0.204 Documentation</title>
<link rel="stylesheet" href="../_static/presto.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.204',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="top" title="Presto 0.204 Documentation" href="../index.html" />
<link rel="up" title="10. Developer Guide" href="../develop.html" />
<link rel="next" title="11. Release Notes" href="../release.html" />
<link rel="prev" title="10.7. Password Authenticator" href="password-authenticator.html" />
</head>
<body role="document">
<div class="header">
<h1 class="heading"><a href="../index.html">
<span>Presto 0.204 Documentation</span></a></h1>
<h2 class="heading"><span>10.8. Event Listener</span></h2>
</div>
<div class="topnav">
<p class="nav">
<span class="left">
« <a href="password-authenticator.html">10.7. Password Authenticator</a>
</span>
<span class="right">
<a href="../release.html">11. Release Notes</a> »
</span>
</p>
</div>
<div class="content">
<div class="section" id="event-listener">
<h1>10.8. Event Listener</h1>
<p>Presto supports custom event listeners that are invoked for the following
events:</p>
<ul class="simple">
<li>Query creation</li>
<li>Query completion (success or failure)</li>
<li>Split completion (success or failure)</li>
</ul>
<p>This functionality enables development of custom logging, debugging and
performance analysis plugins. In a Presto cluster, only a single event
listener plugin can be active at a time .</p>
<div class="section" id="implementation">
<h2>Implementation</h2>
<p><code class="docutils literal"><span class="pre">EventListenerFactory</span></code> is responsible for creating an
<code class="docutils literal"><span class="pre">EventListener</span></code> instance. It also defines an <code class="docutils literal"><span class="pre">EventListener</span></code>
name which is used by the administrator in a Presto configuration.
Implementations of <code class="docutils literal"><span class="pre">EventListener</span></code> implement methods for the event types
they are interested in handling.</p>
<p>The implementation of <code class="docutils literal"><span class="pre">EventListener</span></code> and <code class="docutils literal"><span class="pre">EventListenerFactory</span></code>
must be wrapped as a plugin and installed on the Presto cluster.</p>
</div>
<div class="section" id="configuration">
<h2>Configuration</h2>
<p>After a plugin that implements <code class="docutils literal"><span class="pre">EventListener</span></code> and
<code class="docutils literal"><span class="pre">EventListenerFactory</span></code> has been installed on the coordinator, it is
configured using an <code class="docutils literal"><span class="pre">etc/event-listener.properties</span></code> file. All of the
properties other than <code class="docutils literal"><span class="pre">event-listener.name</span></code> are specific to the
<code class="docutils literal"><span class="pre">EventListener</span></code> implementation.</p>
<p>The <code class="docutils literal"><span class="pre">event-listener.name</span></code> property is used by Presto to find a registered
<code class="docutils literal"><span class="pre">EventListenerFactory</span></code> based on the name returned by
<code class="docutils literal"><span class="pre">EventListenerFactory.getName()</span></code>. The remaining properties are passed
as a map to <code class="docutils literal"><span class="pre">EventListenerFactory.create()</span></code>.</p>
<p>Example configuration file:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>event-listener.name=custom-event-listener
custom-property1=custom-value1
custom-property2=custom-value2
</pre></div>
</div>
</div>
</div>
</div>
<div class="bottomnav">
<p class="nav">
<span class="left">
« <a href="password-authenticator.html">10.7. Password Authenticator</a>
</span>
<span class="right">
<a href="../release.html">11. Release Notes</a> »
</span>
</p>
</div>
<div class="footer" role="contentinfo">
</div>
</body>
</html>