← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

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

  • Committer: Daniel Nichter
  • Date: 2011-08-13 20:41:38 UTC
  • mto: This revision was merged to the branch mainline in revision 2413.
  • Revision ID: daniel@percona.com-20110813204138-stxa89ca1t7cg1uy
https://launchpad.net/bugs/793182
Skeleton documentation for all plugins, more complete docu for first half of plugins.
Clean up plugin.ini titles and descriptions.
Reformat and reorganize root index.
Change Administrative to Administration and remove empty files (logging, etc.)
Add, fix, and tag documentation for functions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/syslog/docs/index.rst
 
1
Syslog
 
2
======
 
3
 
 
4
Syslog interface for query log, error messages, and functions.
 
5
 
 
6
.. _syslog_loading:
 
7
 
 
8
Loading
 
9
-------
 
10
 
 
11
This plugin is loaded by default, but it may need to be configured.  See
 
12
the plugin's :ref:`syslog_configuration` and
 
13
:ref:`syslog_variables`.
 
14
 
 
15
To stop the plugin from loading by default, start :program:`drizzled`
 
16
with::
 
17
 
 
18
   --plugin-remove=syslog
 
19
 
 
20
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
21
 
 
22
.. _syslog_configuration:
 
23
 
 
24
Configuration
 
25
-------------
 
26
 
 
27
These command line options configure the plugin when :program:`drizzled`
 
28
is started.  See :doc:`/configuration` for more information about specifying
 
29
command line options.
 
30
 
 
31
.. program:: drizzled
 
32
 
 
33
.. option:: --syslog.errmsg-enable 
 
34
 
 
35
   :Default: false
 
36
   :Variable: :ref:`syslog_errmsg_enable <syslog_errmsg_enable>`
 
37
 
 
38
   Enable logging to syslog of the error messages
 
39
 
 
40
.. option:: --syslog.errmsg-priority ARG
 
41
 
 
42
   :Default: warning
 
43
   :Variable: :ref:`syslog_errmsg_priority <syslog_errmsg_priority>`
 
44
 
 
45
   Syslog Priority of error messages
 
46
 
 
47
.. option:: --syslog.facility ARG
 
48
 
 
49
   :Default: local0
 
50
   :Variable: :ref:`syslog_facility <syslog_facility>`
 
51
 
 
52
   Syslog Facility
 
53
 
 
54
.. option:: --syslog.ident ARG
 
55
 
 
56
   :Default: drizzled
 
57
   :Variable:
 
58
 
 
59
   Syslog Ident
 
60
 
 
61
.. option:: --syslog.logging-enable 
 
62
 
 
63
   :Default: false
 
64
   :Variable: :ref:`syslog_logging_enable <syslog_logging_enable>`
 
65
 
 
66
   Enable logging to syslog of the query log
 
67
 
 
68
.. option:: --syslog.logging-priority ARG
 
69
 
 
70
   :Default: warning
 
71
   :Variable: :ref:`syslog_logging_priority <syslog_logging_priority>`
 
72
 
 
73
   Syslog Priority of query logging
 
74
 
 
75
.. option:: --syslog.logging-threshold-big-examined 
 
76
 
 
77
   :Default: 0
 
78
   :Variable: :ref:`syslog_logging_threshold_big_examined <syslog_logging_threshold_big_examined>`
 
79
 
 
80
   Threshold for logging big queries
 
81
 
 
82
.. option:: --syslog.logging-threshold-big-resultset 
 
83
 
 
84
   :Default: 0
 
85
   :Variable: :ref:`syslog_logging_threshold_big_resultset <syslog_logging_threshold_big_resultset>`
 
86
 
 
87
   Threshold for logging big queries
 
88
 
 
89
.. option:: --syslog.logging-threshold-slow 
 
90
 
 
91
   :Default: 0
 
92
   :Variable: :ref:`syslog_logging_threshold_slow <syslog_logging_threshold_slow>`
 
93
 
 
94
   Threshold for logging slow queries
 
95
 
 
96
.. _syslog_variables:
 
97
 
 
98
Variables
 
99
---------
 
100
 
 
101
These variables show the running configuration of the plugin.
 
102
See `variables` for more information about querying and setting variables.
 
103
 
 
104
.. _syslog_errmsg_enable:
 
105
 
 
106
* ``syslog_errmsg_enable``
 
107
 
 
108
   :Scope: Global
 
109
   :Dynamic: No
 
110
   :Option: :option:`--syslog.errmsg-enable`
 
111
 
 
112
   Enable logging to syslog of the error messages
 
113
 
 
114
.. _syslog_errmsg_priority:
 
115
 
 
116
* ``syslog_errmsg_priority``
 
117
 
 
118
   :Scope: Global
 
119
   :Dynamic: No
 
120
   :Option: :option:`--syslog.errmsg-priority`
 
121
 
 
122
   Syslog Priority of error messages
 
123
 
 
124
.. _syslog_facility:
 
125
 
 
126
* ``syslog_facility``
 
127
 
 
128
   :Scope: Global
 
129
   :Dynamic: No
 
130
   :Option: :option:`--syslog.facility`
 
131
 
 
132
   Syslog Facility
 
133
 
 
134
.. _syslog_logging_enable:
 
135
 
 
136
* ``syslog_logging_enable``
 
137
 
 
138
   :Scope: Global
 
139
   :Dynamic: No
 
140
   :Option: :option:`--syslog.logging-enable`
 
141
 
 
142
   Enable logging to syslog of the query log
 
143
 
 
144
.. _syslog_logging_priority:
 
145
 
 
146
* ``syslog_logging_priority``
 
147
 
 
148
   :Scope: Global
 
149
   :Dynamic: No
 
150
   :Option: :option:`--syslog.logging-priority`
 
151
 
 
152
   Syslog Priority of query logging
 
153
 
 
154
.. _syslog_logging_threshold_big_examined:
 
155
 
 
156
* ``syslog_logging_threshold_big_examined``
 
157
 
 
158
   :Scope: Global
 
159
   :Dynamic: No
 
160
   :Option: :option:`--syslog.logging-threshold-big-examined`
 
161
 
 
162
   Threshold for logging big queries
 
163
 
 
164
.. _syslog_logging_threshold_big_resultset:
 
165
 
 
166
* ``syslog_logging_threshold_big_resultset``
 
167
 
 
168
   :Scope: Global
 
169
   :Dynamic: No
 
170
   :Option: :option:`--syslog.logging-threshold-big-resultset`
 
171
 
 
172
   Threshold for logging big queries
 
173
 
 
174
.. _syslog_logging_threshold_slow:
 
175
 
 
176
* ``syslog_logging_threshold_slow``
 
177
 
 
178
   :Scope: Global
 
179
   :Dynamic: No
 
180
   :Option: :option:`--syslog.logging-threshold-slow`
 
181
 
 
182
   Threshold for logging slow queries
 
183
 
 
184
.. _syslog_examples:
 
185
 
 
186
Examples
 
187
--------
 
188
 
 
189
Sorry, there are no examples for this plugin.
 
190
 
 
191
.. _syslog_authors:
 
192
 
 
193
Authors
 
194
-------
 
195
 
 
196
Mark Atwood
 
197
 
 
198
.. _syslog_version:
 
199
 
 
200
Version
 
201
-------
 
202
 
 
203
This documentation applies to **syslog 0.3**.
 
204
 
 
205
To see which version of the plugin a Drizzle server is running, execute:
 
206
 
 
207
.. code-block:: mysql
 
208
 
 
209
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='syslog'
 
210