aboutsummaryrefslogtreecommitdiff
path: root/README
blob: 87c029a583bf5701fdf5d7393c673064ec0d2a63 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
Mysqlstat README
Copyright (C) 2016 Sergey Poznyakoff
See the end of file for copying conditions.

* Introduction

This file contains brief information about configuring, testing
and using Mysqlstat. It is *not* intended as a replacement
for the documentation, and is provided as a brief reference only.
For a detailed documentation, please see the mysqlstat(8)
manpage.

* Overview

Mysqlstat is a dynamically loadable object module for net-snmp
snmpd, that provides access to process list statistics and replication 
status of the mysqld server.

* Installation

In order to compile the package you need to have Net-SNMP and MySQL
client installed.  The installation sequence is as usual:

  ./configure [options]
  make
  make install

(the last step normally requires root privileges).  For generic
options to configure, please see the file INSTALL.  Package-specific
options are:

** --with-dlmoddir=DIR

Install varnish_mod.so in DIR.  By default it is installed in
$PREFIX/lib/snmp, where $PREFIX stands for the installation prefix.

** --with-mibdir=DIR

Install MIBs (the file MYSQL-STAT-MIB.txt) in DIR.  By default it is
installed in $prefix/share/snmp.

** --with-snmp-config-dir=DIR

Net-SNMP configuration directory.  Default is $sysconfdir/snmp.

To enable the module, run

  mysqlstat-setup

as root.  The utility will do the following:

 - Create MySQL user and grant it the necessary privileges.
 - Create the file mysqlstat.cnf in Net-SNMP configuration directory.
 - Edit the file /etc/snmp/snmpd.conf

In order to do that, it will need to connect to MySQL server as a user
with GRANT privileges.  The preferred way to supply MySQL server credentials
is by defining them in your ~/.my.cnf file.  You may use another file name
using the --defaults-file option:

  mysqlstat-setup --defaults-file=setup.cnf

You can also use the familiar --user, --pasword and --host options to supply
the credentials from the command line:

  mysqlstat-setup --user=root --password=guessme

By default, the MySQL user 'snmp'@'localhost' will be created (with
empty password).  To change this use the following options:

  --snmp-user=USER
  --snmp-password=PASSWORD
  --snmp-host=HOST_OR_IP

For more details, refer to the manpage mysqlstat-setup(8).

* Bug reporting

Send bug reports and suggestions to <bug-mysqlstat@gnu.org.ua>.


* Copyright information:

Copyright (C) 2016 Sergey Poznyakoff

   Permission is granted to anyone to make or distribute verbatim copies
   of this document as received, in any medium, provided that the
   copyright notice and this permission notice are preserved,
   thus giving the recipient permission to redistribute in turn.

   Permission is granted to distribute modified versions
   of this document, or of portions of it,
   under the above conditions, provided also that they
   carry prominent notices stating who last changed them.


Local Variables:
mode: outline
paragraph-separate: "[ 	]*$"
version-control: never
End:


 

Return to:

Send suggestions and report system problems to the System administrator.