OCA
/
server-tools
5
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
906 Commits
13 Branches
0 Tags
45 MiB
Tree: 5dfb850786
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5dfb850786'
${ noResults }
server-tools/slow_statement_logger/static/description/index.html

441 lines
13 KiB
Raw Normal View History

[ADD] slow_statement_logger
5 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
[UPD] README.rst
5 years ago
​
[ADD] slow_statement_logger
5 years ago
​
​
[UPD] README.rst
5 years ago
​
[ADD] slow_statement_logger
5 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
  7. <title>Slow SQL Statement Logger</title>
  8. <style type="text/css">
  10. /*
  11. :Author: David Goodger (goodger@python.org)
  12. :Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
  13. :Copyright: This stylesheet has been placed in the public domain.
  15. Default cascading style sheet for the HTML output of Docutils.
  17. See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
  18. customize this style sheet.
  19. */
  21. /* used to remove borders from tables and images */
  22. .borderless, table.borderless td, table.borderless th {
  23. border: 0 }
  25. table.borderless td, table.borderless th {
  26. /* Override padding for "table.docutils td" with "! important".
  27. The right padding separates the table cells. */
  28. padding: 0 0.5em 0 0 ! important }
  30. .first {
  31. /* Override more specific margin styles with "! important". */
  32. margin-top: 0 ! important }
  34. .last, .with-subtitle {
  35. margin-bottom: 0 ! important }
  37. .hidden {
  38. display: none }
  40. .subscript {
  41. vertical-align: sub;
  42. font-size: smaller }
  44. .superscript {
  45. vertical-align: super;
  46. font-size: smaller }
  48. a.toc-backref {
  49. text-decoration: none ;
  50. color: black }
  52. blockquote.epigraph {
  53. margin: 2em 5em ; }
  55. dl.docutils dd {
  56. margin-bottom: 0.5em }
  58. object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  59. overflow: hidden;
  60. }
  62. /* Uncomment (and remove this text!) to get bold-faced definition list terms
  63. dl.docutils dt {
  64. font-weight: bold }
  65. */
  67. div.abstract {
  68. margin: 2em 5em }
  70. div.abstract p.topic-title {
  71. font-weight: bold ;
  72. text-align: center }
  74. div.admonition, div.attention, div.caution, div.danger, div.error,
  75. div.hint, div.important, div.note, div.tip, div.warning {
  76. margin: 2em ;
  77. border: medium outset ;
  78. padding: 1em }
  80. div.admonition p.admonition-title, div.hint p.admonition-title,
  81. div.important p.admonition-title, div.note p.admonition-title,
  82. div.tip p.admonition-title {
  83. font-weight: bold ;
  84. font-family: sans-serif }
  86. div.attention p.admonition-title, div.caution p.admonition-title,
  87. div.danger p.admonition-title, div.error p.admonition-title,
  88. div.warning p.admonition-title, .code .error {
  89. color: red ;
  90. font-weight: bold ;
  91. font-family: sans-serif }
  93. /* Uncomment (and remove this text!) to get reduced vertical space in
  94. compound paragraphs.
  95. div.compound .compound-first, div.compound .compound-middle {
  96. margin-bottom: 0.5em }
  98. div.compound .compound-last, div.compound .compound-middle {
  99. margin-top: 0.5em }
  100. */
  102. div.dedication {
  103. margin: 2em 5em ;
  104. text-align: center ;
  105. font-style: italic }
  107. div.dedication p.topic-title {
  108. font-weight: bold ;
  109. font-style: normal }
  111. div.figure {
  112. margin-left: 2em ;
  113. margin-right: 2em }
  115. div.footer, div.header {
  116. clear: both;
  117. font-size: smaller }
  119. div.line-block {
  120. display: block ;
  121. margin-top: 1em ;
  122. margin-bottom: 1em }
  124. div.line-block div.line-block {
  125. margin-top: 0 ;
  126. margin-bottom: 0 ;
  127. margin-left: 1.5em }
  129. div.sidebar {
  130. margin: 0 0 0.5em 1em ;
  131. border: medium outset ;
  132. padding: 1em ;
  133. background-color: #ffffee ;
  134. width: 40% ;
  135. float: right ;
  136. clear: right }
  138. div.sidebar p.rubric {
  139. font-family: sans-serif ;
  140. font-size: medium }
  142. div.system-messages {
  143. margin: 5em }
  145. div.system-messages h1 {
  146. color: red }
  148. div.system-message {
  149. border: medium outset ;
  150. padding: 1em }
  152. div.system-message p.system-message-title {
  153. color: red ;
  154. font-weight: bold }
  156. div.topic {
  157. margin: 2em }
  159. h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
  160. h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  161. margin-top: 0.4em }
  163. h1.title {
  164. text-align: center }
  166. h2.subtitle {
  167. text-align: center }
  169. hr.docutils {
  170. width: 75% }
  172. img.align-left, .figure.align-left, object.align-left, table.align-left {
  173. clear: left ;
  174. float: left ;
  175. margin-right: 1em }
  177. img.align-right, .figure.align-right, object.align-right, table.align-right {
  178. clear: right ;
  179. float: right ;
  180. margin-left: 1em }
  182. img.align-center, .figure.align-center, object.align-center {
  183. display: block;
  184. margin-left: auto;
  185. margin-right: auto;
  186. }
  188. table.align-center {
  189. margin-left: auto;
  190. margin-right: auto;
  191. }
  193. .align-left {
  194. text-align: left }
  196. .align-center {
  197. clear: both ;
  198. text-align: center }
  200. .align-right {
  201. text-align: right }
  203. /* reset inner alignment in figures */
  204. div.align-right {
  205. text-align: inherit }
  207. /* div.align-center * { */
  208. /* text-align: left } */
  210. .align-top {
  211. vertical-align: top }
  213. .align-middle {
  214. vertical-align: middle }
  216. .align-bottom {
  217. vertical-align: bottom }
  219. ol.simple, ul.simple {
  220. margin-bottom: 1em }
  222. ol.arabic {
  223. list-style: decimal }
  225. ol.loweralpha {
  226. list-style: lower-alpha }
  228. ol.upperalpha {
  229. list-style: upper-alpha }
  231. ol.lowerroman {
  232. list-style: lower-roman }
  234. ol.upperroman {
  235. list-style: upper-roman }
  237. p.attribution {
  238. text-align: right ;
  239. margin-left: 50% }
  241. p.caption {
  242. font-style: italic }
  244. p.credits {
  245. font-style: italic ;
  246. font-size: smaller }
  248. p.label {
  249. white-space: nowrap }
  251. p.rubric {
  252. font-weight: bold ;
  253. font-size: larger ;
  254. color: maroon ;
  255. text-align: center }
  257. p.sidebar-title {
  258. font-family: sans-serif ;
  259. font-weight: bold ;
  260. font-size: larger }
  262. p.sidebar-subtitle {
  263. font-family: sans-serif ;
  264. font-weight: bold }
  266. p.topic-title {
  267. font-weight: bold }
  269. pre.address {
  270. margin-bottom: 0 ;
  271. margin-top: 0 ;
  272. font: inherit }
  274. pre.literal-block, pre.doctest-block, pre.math, pre.code {
  275. margin-left: 2em ;
  276. margin-right: 2em }
  278. pre.code .ln { color: grey; } /* line numbers */
  279. pre.code, code { background-color: #eeeeee }
  280. pre.code .comment, code .comment { color: #5C6576 }
  281. pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
  282. pre.code .literal.string, code .literal.string { color: #0C5404 }
  283. pre.code .name.builtin, code .name.builtin { color: #352B84 }
  284. pre.code .deleted, code .deleted { background-color: #DEB0A1}
  285. pre.code .inserted, code .inserted { background-color: #A3D289}
  287. span.classifier {
  288. font-family: sans-serif ;
  289. font-style: oblique }
  291. span.classifier-delimiter {
  292. font-family: sans-serif ;
  293. font-weight: bold }
  295. span.interpreted {
  296. font-family: sans-serif }
  298. span.option {
  299. white-space: nowrap }
  301. span.pre {
  302. white-space: pre }
  304. span.problematic {
  305. color: red }
  307. span.section-subtitle {
  308. /* font-size relative to parent (h1..h6 element) */
  309. font-size: 80% }
  311. table.citation {
  312. border-left: solid 1px gray;
  313. margin-left: 1px }
  315. table.docinfo {
  316. margin: 2em 4em }
  318. table.docutils {
  319. margin-top: 0.5em ;
  320. margin-bottom: 0.5em }
  322. table.footnote {
  323. border-left: solid 1px black;
  324. margin-left: 1px }
  326. table.docutils td, table.docutils th,
  327. table.docinfo td, table.docinfo th {
  328. padding-left: 0.5em ;
  329. padding-right: 0.5em ;
  330. vertical-align: top }
  332. table.docutils th.field-name, table.docinfo th.docinfo-name {
  333. font-weight: bold ;
  334. text-align: left ;
  335. white-space: nowrap ;
  336. padding-left: 0 }
  338. /* "booktabs" style (no vertical lines) */
  339. table.docutils.booktabs {
  340. border: 0px;
  341. border-top: 2px solid;
  342. border-bottom: 2px solid;
  343. border-collapse: collapse;
  344. }
  345. table.docutils.booktabs * {
  346. border: 0px;
  347. }
  348. table.docutils.booktabs th {
  349. border-bottom: thin solid;
  350. text-align: left;
  351. }
  353. h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
  354. h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  355. font-size: 100% }
  357. ul.auto-toc {
  358. list-style-type: none }
  360. </style>
  361. </head>
  362. <body>
  363. <div class="document" id="slow-sql-statement-logger">
  364. <h1 class="title">Slow SQL Statement Logger</h1>
  366. <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  367. !! This file is generated by oca-gen-addon-readme !!
  368. !! changes will be overwritten. !!
  369. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
  370. <p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/12.0/slow_statement_logger"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-slow_statement_logger"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/149/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
  371. <p>This module lets you log slow SQL statements. It is useful when you don’t have
  372. access to the PostgreSQL log or when it is difficult to correlate the
  373. PostgreSQL log with the Odoo log.</p>
  374. <div class="admonition warning">
  375. <p class="first admonition-title">Warning</p>
  376. <p class="last">This module may leak confidential data in the log, in a similar way
  377. to Odoo’s <tt class="docutils literal"><span class="pre">--log-level=debug_sql</span></tt> option. Use with care.</p>
  378. </div>
  379. <p><strong>Table of contents</strong></p>
  380. <div class="contents local topic" id="contents">
  381. <ul class="simple">
  382. <li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
  383. <li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
  384. <li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
  385. <li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
  386. <li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
  387. <li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
  388. </ul>
  389. </li>
  390. </ul>
  391. </div>
  392. <div class="section" id="usage">
  393. <h1><a class="toc-backref" href="#id1">Usage</a></h1>
  394. <p>Add <tt class="docutils literal">slow_statement_logger</tt> to Odoo’s <tt class="docutils literal"><span class="pre">--load</span></tt> command line option, or to the
  395. <tt class="docutils literal">server_wide_modules</tt> configuration file entry.</p>
  396. <p>Add a <tt class="docutils literal">log_min_duration_statement</tt> entry in the <tt class="docutils literal">options</tt> section of your
  397. Odoo configuration file. Statements running at least this number of
  398. milliseconds will be logged with a <em>debug</em> level in the
  399. <tt class="docutils literal">odoo.addons.slow_statement_logger</tt> logger. <tt class="docutils literal">0</tt> means all statements will be
  400. logged. <tt class="docutils literal"><span class="pre">-1</span></tt> disables this logging. You can also set an environment variable
  401. <tt class="docutils literal">ODOO_LOG_MIN_DURATION_STATEMENT</tt> which will have priority over the
  402. configuration file entry.</p>
  403. <p>Add <tt class="docutils literal">odoo.addons.slow_statement_logger:DEBUG</tt> in your <tt class="docutils literal">log_handler</tt>
  404. configuration file entry or <tt class="docutils literal"><span class="pre">--log-handler</span></tt> command line option.</p>
  405. </div>
  406. <div class="section" id="bug-tracker">
  407. <h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
  408. <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
  409. In case of trouble, please check there if your issue has already been reported.
  410. If you spotted it first, help us smashing it by providing a detailed and welcomed
  411. <a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20slow_statement_logger%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
  412. <p>Do not contact contributors directly about support or help with technical issues.</p>
  413. </div>
  414. <div class="section" id="credits">
  415. <h1><a class="toc-backref" href="#id3">Credits</a></h1>
  416. <div class="section" id="authors">
  417. <h2><a class="toc-backref" href="#id4">Authors</a></h2>
  418. <ul class="simple">
  419. <li>ACSONE SA/NV</li>
  420. </ul>
  421. </div>
  422. <div class="section" id="contributors">
  423. <h2><a class="toc-backref" href="#id5">Contributors</a></h2>
  424. <ul class="simple">
  425. <li><a class="reference external" href="mailto:stephane.bidoul&#64;acsone.eu">stephane.bidoul&#64;acsone.eu</a></li>
  426. </ul>
  427. </div>
  428. <div class="section" id="maintainers">
  429. <h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
  430. <p>This module is maintained by the OCA.</p>
  431. <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
  432. <p>OCA, or the Odoo Community Association, is a nonprofit organization whose
  433. mission is to support the collaborative development of Odoo features and
  434. promote its widespread use.</p>
  435. <p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/12.0/slow_statement_logger">OCA/server-tools</a> project on GitHub.</p>
  436. <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
  437. </div>
  438. </div>
  439. </div>
  440. </body>
  441. </html>