-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathlogging.html
More file actions
223 lines (186 loc) · 8.12 KB
/
logging.html
File metadata and controls
223 lines (186 loc) · 8.12 KB
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
<!DOCTYPE html>
<html lang="en">
<head>
<title>Ebean ORM Setup</title>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script async defer src="https://buttons.github.io/buttons.js"></script>
<link rel="shortcut icon" href="/images/favicon.ico" >
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" crossorigin="anonymous">
<link rel="stylesheet" href="/css/pygments.css" type="text/css" />
<link rel="stylesheet" href="/css/site.css">
</head>
<body>
<div id="wrap">
<div id="header">
<div class="navbar" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".mobile-nav">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">
<img src="/images/lg5-21x100.png" height="35">
</a>
</div>
<div class="collapse navbar-collapse">
<ul class="nav navbar-nav pull-right nav-btn-rhs">
<li ><a href="/"><span class="fas fa-home"></span> Home</a></li>
<li class="active"><a href="/docs">Docs</a></li>
<li ><a href="/docs/getting-started">Get Started</a></li>
<li ><a href="/support">Help</a></li>
<li ><a href="/videos">Videos</a></li>
<li ><a target="_blank" href="/apidoc/13">ApiDocs</a></li>
<li ><a href="/releases">Releases</a></li>
<li><a target="_blank" href="https://github.com/ebean-orm/ebean"> <i class="fab fa-github"></i></a></li>
</ul>
</div>
<div class="mobile-nav">
<ul class="nav navbar-nav pull-right nav-btn-rhs">
<li ><a href="/"><span class="fas fa-home"></span> Home</a></li>
<li class="active"><a href="/docs">Docs</a></li>
<li ><a href="/docs/getting-started">Get Started</a></li>
<li ><a href="/support">Help</a></li>
<li ><a href="/videos">Videos</a></li>
<li ><a target="_blank" href="/apidoc/13">ApiDocs</a></li>
<li ><a href="/releases">Releases</a></li>
<li><a target="_blank" href="https://github.com/ebean-orm/ebean"> <i class="fab fa-github"></i></a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="main">
<div class="jumbotron mini">
<div class="container">
<h1><a href="/docs">Documentation</a> / <a href="/docs/setup">Setup</a> / Logging </h1>
</div>
</div>
<div class="container doc-index bs-docs-container">
<div class="row">
<div class="col-md-9" role="main">
<div class="bs-docs-section">
<p>Ebean uses <a href="//www.slf4j.org/">SLF4J</a> for logging.</p>
<h2 id="sql">SQL and Transaction logging</h2>
<p>
During development it is expected that you include logging of
<code>io.ebean.SQL</code> and <code>io.ebean.TXN</code>.
These log the sql statements executed, bind values for statement execution
and transaction demarcation.
</p>
<div class="syntax xml"><div class="highlight"><pre><span></span><span class="c"><!-- LOGBACK configuration --></span>
<span class="c"><!-- SQL and bind values --></span>
<span class="nt"><logger</span> <span class="na">name=</span><span class="s">"io.ebean.SQL"</span> <span class="na">level=</span><span class="s">"TRACE"</span><span class="nt">/></span>
<span class="c"><!-- Transaction Commit and Rollback events --></span>
<span class="nt"><logger</span> <span class="na">name=</span><span class="s">"io.ebean.TXN"</span> <span class="na">level=</span><span class="s">"TRACE"</span><span class="nt">/></span>
</pre></div>
</div>
<h2 id="summary">Summary logging</h2>
<p>
The summary logging of <code>io.ebean.SUM</code> is useful for showing lazy loading queries and how they relate
back to origin queries. This is useful when looking at more complex object graphs are
built. In tuning queries for N+1 etc.
</p>
<div class="syntax xml"><div class="highlight"><pre><span></span><span class="c"><!-- LOGBACK configuration --></span>
<span class="c"><!-- Summary level details --></span>
<span class="nt"><logger</span> <span class="na">name=</span><span class="s">"io.ebean.SUM"</span> <span class="na">level=</span><span class="s">"TRACE"</span><span class="nt">/></span>
</pre></div>
</div>
<h2 id="l2cache">L2 Cache logging</h2>
<p>The L2 cache events can be logged using the logger entries below.
This is useful when you are starting out using the L2 cache and looking
at the behaviour with L2 caching.
</p>
<div class="syntax xml"><div class="highlight"><pre><span></span><span class="c"><!-- LOGBACK configuration --></span>
<span class="c"><!-- L2 logging --></span>
<span class="nt"><logger</span> <span class="na">name=</span><span class="s">"io.ebean.cache.QUERY"</span> <span class="na">level=</span><span class="s">"TRACE"</span><span class="nt">/></span>
<span class="nt"><logger</span> <span class="na">name=</span><span class="s">"io.ebean.cache.BEAN"</span> <span class="na">level=</span><span class="s">"TRACE"</span><span class="nt">/></span>
<span class="nt"><logger</span> <span class="na">name=</span><span class="s">"io.ebean.cache.COLL"</span> <span class="na">level=</span><span class="s">"TRACE"</span><span class="nt">/></span>
<span class="nt"><logger</span> <span class="na">name=</span><span class="s">"io.ebean.cache.NATKEY"</span> <span class="na">level=</span><span class="s">"TRACE"</span><span class="nt">/></span>
</pre></div>
</div>
</div>
</div>
<div class="col-md-3" role="complementary">
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm">
<ul class="nav bs-docs-sidenav">
<li >
<a href="/docs/setup/enhancement">Enhancement</a>
</li>
<li >
<a href="/docs/setup/eclipse-apt">Eclipse IDE - APT</a>
</li>
<li class="active">
<a href="/docs/setup/logging">Logging</a>
<ul class="nav">
<li><a href="#sql">SQL and Transaction logging</a></li>
<li><a href="#summary">Summary logging</a></li>
<li><a href="#l2cache">L2 Cache logging</a></li>
</ul>
</li>
<li >
<a href="/docs/setup/serverconfig">DatabaseBuilder</a>
</li>
<li >
<a href="/docs/setup/guice">Guice</a>
</li>
<li >
<a href="/docs/setup/spring">Spring</a>
</li>
<li >
<a href="/docs/setup/activerecord">Active Record</a>
</li>
<li >
<a href="/docs/setup/ddl-create-all">DDL - Create All</a>
</li>
<li >
<a href="/docs/setup/dbmigration">DDL - DB Migration</a>
</li>
<li >
<a href="/docs/setup/test-properties"> Test properties</a>
</li>
<li >
<a href="/docs/setup/testing">Testing</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<!-- /.row -->
</div> <!-- /.container -->
</div>
</div>
<footer id="footer">
<div class="doc-footer">
<ul class="doc-footer-links">
<li><a href="/">Ebean ORM</a></li>
<li> | </li>
<li><a href="http://avaje-metric.github.io">Metrics</a></li>
</ul>
</div>
</footer>
<script type="text/javascript">
var categoryNames = {};
</script>
<script src="https://code.jquery.com/jquery-3.3.1.min.js"></script>
<script src="/js/bootstrap.min.js"></script>
<script src="/js/jquery.easing.min.js"></script>
<script src="/js/jquery.storageapi.min.js"></script>
<script src="/js/ebean-site.js"></script>
<script src="/js/extra.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-75181644-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>