← Back to branch summary

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

« back to all changes in this revision

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