← Back to branch summary

~vjsamuel/drizzle/fix-bug-850858

« back to all changes in this revision

Viewing changes to plugin/logging_query/docs/index.rst

  • Committer: Mark Atwood
  • Date: 2011-09-13 19:54:55 UTC
  • mfrom: (2397.1.3 plugin-docs)
  • Revision ID: me@mark.atwood.name-20110913195455-3bk3locm85m4jimp
merge lp:~daniel-nichter/drizzle/plugin-docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/logging_query/docs/index.rst
 
1
Query Logging
 
2
=============
 
3
 
 
4
The :program:`logging_query` plugin logs queries to a CSV file.
 
5
 
 
6
.. _logging_query_loading:
 
7
 
 
8
Loading
 
9
-------
 
10
 
 
11
To load this plugin, start :program:`drizzled` with::
 
12
 
 
13
   --plugin-add=logging_query
 
14
 
 
15
Loading the plugin may not enable or configure it.  See the plugin's
 
16
:ref:`logging_query_configuration` and :ref:`logging_query_variables`.
 
17
 
 
18
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
19
 
 
20
.. _logging_query_configuration:
 
21
 
 
22
Configuration
 
23
-------------
 
24
 
 
25
These command line options configure the plugin when :program:`drizzled`
 
26
is started.  See :doc:`/configuration` for more information about specifying
 
27
command line options.
 
28
 
 
29
.. program:: drizzled
 
30
 
 
31
.. option:: --logging-query.enable 
 
32
 
 
33
   :Default: false
 
34
   :Variable: :ref:`logging_query_enable <logging_query_enable>`
 
35
 
 
36
   Enable logging to CSV file.
 
37
 
 
38
.. option:: --logging-query.filename 
 
39
 
 
40
   :Default: 
 
41
   :Variable: :ref:`logging_query_filename <logging_query_filename>`
 
42
 
 
43
   File to log to.
 
44
 
 
45
.. option:: --logging-query.pcre ARG
 
46
 
 
47
   :Default: 
 
48
   :Variable: :ref:`logging_query_pcre <logging_query_pcre>`
 
49
 
 
50
   PCRE to match the query against.
 
51
 
 
52
.. option:: --logging-query.threshold-big-examined 
 
53
 
 
54
   :Default: 0
 
55
   :Variable: :ref:`logging_query_threshold_big_examined <logging_query_threshold_big_examined>`
 
56
 
 
57
   Threshold for logging big queries by rows examined.
 
58
 
 
59
.. option:: --logging-query.threshold-big-resultset 
 
60
 
 
61
   :Default: 0
 
62
   :Variable: :ref:`logging_query_threshold_big_resultset <logging_query_threshold_big_resultset>`
 
63
 
 
64
   Threshold for logging big queries by result set size.
 
65
 
 
66
.. option:: --logging-query.threshold-slow 
 
67
 
 
68
   :Default: 0
 
69
   :Variable: :ref:`logging_query_threshold_slow <logging_query_threshold_slow>`
 
70
 
 
71
   Threshold for logging slow queries by execution time.
 
72
 
 
73
.. _logging_query_variables:
 
74
 
 
75
Variables
 
76
---------
 
77
 
 
78
These variables show the running configuration of the plugin.
 
79
See `variables` for more information about querying and setting variables.
 
80
 
 
81
.. _logging_query_enable:
 
82
 
 
83
* ``logging_query_enable``
 
84
 
 
85
   :Scope: Global
 
86
   :Dynamic: No
 
87
   :Option: :option:`--logging-query.enable`
 
88
 
 
89
   Enable logging to CSV file.
 
90
 
 
91
.. _logging_query_filename:
 
92
 
 
93
* ``logging_query_filename``
 
94
 
 
95
   :Scope: Global
 
96
   :Dynamic: No
 
97
   :Option: :option:`--logging-query.filename`
 
98
 
 
99
   File to log to.
 
100
 
 
101
.. _logging_query_pcre:
 
102
 
 
103
* ``logging_query_pcre``
 
104
 
 
105
   :Scope: Global
 
106
   :Dynamic: No
 
107
   :Option: :option:`--logging-query.pcre`
 
108
 
 
109
   PCRE to match the query against.
 
110
 
 
111
.. _logging_query_threshold_big_examined:
 
112
 
 
113
* ``logging_query_threshold_big_examined``
 
114
 
 
115
   :Scope: Global
 
116
   :Dynamic: No
 
117
   :Option: :option:`--logging-query.threshold-big-examined`
 
118
 
 
119
   Threshold for logging big queries by rows examined.
 
120
 
 
121
.. _logging_query_threshold_big_resultset:
 
122
 
 
123
* ``logging_query_threshold_big_resultset``
 
124
 
 
125
   :Scope: Global
 
126
   :Dynamic: No
 
127
   :Option: :option:`--logging-query.threshold-big-resultset`
 
128
 
 
129
   Threshold for logging big queries by result set size.
 
130
 
 
131
.. _logging_query_threshold_slow:
 
132
 
 
133
* ``logging_query_threshold_slow``
 
134
 
 
135
   :Scope: Global
 
136
   :Dynamic: No
 
137
   :Option: :option:`--logging-query.threshold-slow`
 
138
 
 
139
   Threshold for logging slow queries by execution time.
 
140
 
 
141
.. _logging_query_examples:
 
142
 
 
143
Examples
 
144
--------
 
145
 
 
146
Sorry, there are no examples for this plugin.
 
147
 
 
148
.. _logging_query_authors:
 
149
 
 
150
Authors
 
151
-------
 
152
 
 
153
Mark Atwood
 
154
 
 
155
.. _logging_query_version:
 
156
 
 
157
Version
 
158
-------
 
159
 
 
160
This documentation applies to **logging_query 0.2**.
 
161
 
 
162
To see which version of the plugin a Drizzle server is running, execute:
 
163
 
 
164
.. code-block:: mysql
 
165
 
 
166
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='logging_query'
 
167
 
 
168
Changelog
 
169
---------
 
170
 
 
171
v0.2
 
172
^^^^
 
173
* First release.