← Back to branch summary

~hingo/drizzle/drizzle-fix-make-clean-for-docs

« back to all changes in this revision

Viewing changes to plugin/logging_stats/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_stats/docs/index.rst
 
1
User Statistics
 
2
===============
 
3
 
 
4
The :program:`logging_stats` plugin provides user statistics as
 
5
DATA_DICTIONARY tables.
 
6
 
 
7
.. _logging_stats_loading:
 
8
 
 
9
Loading
 
10
-------
 
11
 
 
12
This plugin is loaded by default, but it may need to be configured.  See
 
13
the plugin's :ref:`logging_stats_configuration` and
 
14
:ref:`logging_stats_variables`.
 
15
 
 
16
To stop the plugin from loading by default, start :program:`drizzled`
 
17
with::
 
18
 
 
19
   --plugin-remove=logging_stats
 
20
 
 
21
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
22
 
 
23
.. _logging_stats_configuration:
 
24
 
 
25
Configuration
 
26
-------------
 
27
 
 
28
These command line options configure the plugin when :program:`drizzled`
 
29
is started.  See :doc:`/configuration` for more information about specifying
 
30
command line options.
 
31
 
 
32
.. program:: drizzled
 
33
 
 
34
.. option:: --logging-stats.bucket-count ARG
 
35
 
 
36
   :Default: 10
 
37
   :Variable: :ref:`logging_stats_bucket_count <logging_stats_bucket_count>`
 
38
 
 
39
   Max number of range locks to use for Scoreboard.
 
40
 
 
41
.. option:: --logging-stats.disable 
 
42
 
 
43
   :Default: 
 
44
   :Variable:
 
45
 
 
46
   Disable logging statistics collection.
 
47
 
 
48
.. option:: --logging-stats.max-user-count ARG
 
49
 
 
50
   :Default: 500
 
51
   :Variable: :ref:`logging_stats_max_user_count <logging_stats_max_user_count>`
 
52
 
 
53
   Max number of users to log.
 
54
 
 
55
.. option:: --logging-stats.scoreboard-size ARG
 
56
 
 
57
   :Default: 2000
 
58
   :Variable: :ref:`logging_stats_scoreboard_size <logging_stats_scoreboard_size>`
 
59
 
 
60
   Max number of concurrent sessions to log.
 
61
 
 
62
.. _logging_stats_variables:
 
63
 
 
64
Variables
 
65
---------
 
66
 
 
67
These variables show the running configuration of the plugin.
 
68
See `variables` for more information about querying and setting variables.
 
69
 
 
70
.. _logging_stats_bucket_count:
 
71
 
 
72
* ``logging_stats_bucket_count``
 
73
 
 
74
   :Scope: Global
 
75
   :Dynamic: No
 
76
   :Option: :option:`--logging-stats.bucket-count`
 
77
 
 
78
   Max number of range locks to use for Scoreboard.
 
79
 
 
80
.. _logging_stats_enable:
 
81
 
 
82
* ``logging_stats_enable``
 
83
 
 
84
   :Scope: Global
 
85
   :Dynamic: No
 
86
   :Option:
 
87
 
 
88
   If logging stats is enabled or not.
 
89
 
 
90
.. _logging_stats_max_user_count:
 
91
 
 
92
* ``logging_stats_max_user_count``
 
93
 
 
94
   :Scope: Global
 
95
   :Dynamic: No
 
96
   :Option: :option:`--logging-stats.max-user-count`
 
97
 
 
98
   Max number of users to log.
 
99
 
 
100
.. _logging_stats_scoreboard_size:
 
101
 
 
102
* ``logging_stats_scoreboard_size``
 
103
 
 
104
   :Scope: Global
 
105
   :Dynamic: No
 
106
   :Option: :option:`--logging-stats.scoreboard-size`
 
107
 
 
108
   Max number of concurrent sessions to log.
 
109
 
 
110
.. _logging_stats_examples:
 
111
 
 
112
Examples
 
113
--------
 
114
 
 
115
Sorry, there are no examples for this plugin.
 
116
 
 
117
.. _logging_stats_authors:
 
118
 
 
119
Authors
 
120
-------
 
121
 
 
122
Joseph Daly
 
123
 
 
124
.. _logging_stats_version:
 
125
 
 
126
Version
 
127
-------
 
128
 
 
129
This documentation applies to **logging_stats 0.1**.
 
130
 
 
131
To see which version of the plugin a Drizzle server is running, execute:
 
132
 
 
133
.. code-block:: mysql
 
134
 
 
135
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='logging_stats'
 
136
 
 
137
 
 
138
Changelog
 
139
---------
 
140
 
 
141
v0.1
 
142
^^^^
 
143
* First release.