← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/logging_gearman/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/logging_gearman/docs/index.rst
 
1
Gearman Logging
 
2
===============
 
3
 
 
4
N_("Log queries to a Gearman server").
 
5
 
 
6
.. _logging_gearman_loading:
 
7
 
 
8
Loading
 
9
-------
 
10
 
 
11
To load this plugin, start :program:`drizzled` with::
 
12
 
 
13
   --plugin-add=logging_gearman
 
14
 
 
15
Loading the plugin may not enable or configure it.  See the plugin's
 
16
:ref:`logging_gearman_configuration` and :ref:`logging_gearman_variables`.
 
17
 
 
18
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
19
 
 
20
.. _logging_gearman_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-gearman.function ARG
 
32
 
 
33
   :Default: drizzlelog
 
34
   :Variable: :ref:`logging_gearman_function <logging_gearman_function>`
 
35
 
 
36
   Gearman Function to send logging to
 
37
 
 
38
.. option:: --logging-gearman.host ARG
 
39
 
 
40
   :Default: localhost
 
41
   :Variable: :ref:`logging_gearman_host <logging_gearman_host>`
 
42
 
 
43
   Hostname for logging to a Gearman server
 
44
 
 
45
.. _logging_gearman_variables:
 
46
 
 
47
Variables
 
48
---------
 
49
 
 
50
These variables show the running configuration of the plugin.
 
51
See `variables` for more information about querying and setting variables.
 
52
 
 
53
.. _logging_gearman_function:
 
54
 
 
55
* ``logging_gearman_function``
 
56
 
 
57
   :Scope: Global
 
58
   :Dynamic: No
 
59
   :Option: :option:`--logging-gearman.function`
 
60
 
 
61
   Gearman Function to send logging to
 
62
 
 
63
.. _logging_gearman_host:
 
64
 
 
65
* ``logging_gearman_host``
 
66
 
 
67
   :Scope: Global
 
68
   :Dynamic: No
 
69
   :Option: :option:`--logging-gearman.host`
 
70
 
 
71
   Hostname for logging to a Gearman server
 
72
 
 
73
.. _logging_gearman_examples:
 
74
 
 
75
Examples
 
76
--------
 
77
 
 
78
Sorry, there are no examples for this plugin.
 
79
 
 
80
.. _logging_gearman_authors:
 
81
 
 
82
Authors
 
83
-------
 
84
 
 
85
Mark Atwood
 
86
 
 
87
.. _logging_gearman_version:
 
88
 
 
89
Version
 
90
-------
 
91
 
 
92
This documentation applies to **logging_gearman 0.1**.
 
93
 
 
94
To see which version of the plugin a Drizzle server is running, execute:
 
95
 
 
96
.. code-block:: mysql
 
97
 
 
98
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='logging_gearman'
 
99