← Back to branch summary

~ubuntu-branches/ubuntu/trusty/drizzle/trusty

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Clint Byrum
  • Date: 2012-06-19 10:46:49 UTC
  • mfrom: (1.1.6)
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20120619104649-e2l0ggd4oz3um0f4
Tags: upstream-7.1.36-stable
Import upstream version 7.1.36-stable

Show diffs side-by-side

added added

removed removed

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