OX munin scripts: Difference between revisions

From Open-Xchange
No edit summary
 
(27 intermediate revisions by 7 users not shown)
Line 1: Line 1:
= How to install Munin scripts for Open-Xchange=
= How to install Munin scripts for Open-Xchange=
== Support for Jolokia ==
By Version 7.4.0, Munin Scripts do support [[Jolokia]] as a bridge to get their information.
This has been done to get less overhead and speak with the corresponding JMX-beans directly.


== Prerequisites ==
== Prerequisites ==


Munin-Node must be installed prior installing the Munin scripts package for Open-Xchange.
Munin node and munin master must be installed and configured prior using the Munin scripts package for Open-Xchange. The installation for this core components differs on various Linux distributions. For details, please visit:
Note that SUSE LINUX Enterprise Server does not include Munin.  
 
http://munin-monitoring.org/
 
especially:
 
http://munin-monitoring.org/wiki/LinuxInstallation
 
=== open-xchange-munin-scripts ===
 
== Installation on OX App Suite ==
 
=== Debian GNU/Linux 7.0 (valid until v7.8.2)===
 
Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:
 
deb https://software.open-xchange.com/products/appsuite/7.8.2/backend/DebianWheezy/ /
 
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/7.8.2/backend/updates/DebianWheezy/ /
 
and run
 
$ apt-get update
$ apt-get install open-xchange-munin-scripts
 
=== Debian GNU/Linux 8.0 ===
 
Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:
 
deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianJessie/ /
 
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/DebianJessie/ /
 
and run
 
$ apt-get update
$ apt-get install open-xchange-munin-scripts
 
=== SUSE Linux Enterprise Server 11 (valid until v7.8.2) ===
 
Add the package repository using zypper if not already present:
 
$ zypper ar https://software.open-xchange.com/products/appsuite/7.8.2/backend/SLES11 ox
 
If you have a valid maintenance subscription, please run the following command and add the ldb account data to the url so that the most recent packages get installed:
 
$ zypper ar https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/7.8.2/backend/updates/SLES11 ox-updates
 
and run


To get the munin graphs generated for the webserver, munin needs to be installed and configured, too. For more information, please visit http://munin-monitoring.org/.
$ zypper ref
$ zypper in open-xchange-munin-scripts


If you are running RHEL6 you need to enable to optional RHN channel to get munin. Also you need to add the EPEL repo. An instruction for this can be found on https://fedoraproject.org/wiki/EPEL6-FAQ.
=== SUSE Linux Enterprise Server 12 ===


{{InstallPlugin|pluginname=open-xchange-munin-scripts|sopath=unsupported/repo|reponame=oxmunin}}
Add the package repository using zypper if not already present:


== munin and munin-node ==
$ zypper ar https://software.open-xchange.com/products/appsuite/stable/backend/SLE_12 ox
munin collects the prepared data (by munin-node) from the nodes. Munin can run on the same system as the node, but if you want to monitor more nodes it makes sense to have it on another server running without Open-Xchange.
 
   
If you have a valid maintenance subscription, please run the following command and add the ldb account data to the url so that the most recent packages get installed:
munin-node has to be installed on every Open-Xchange server you want to monitor
 
$ zypper ar https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/SLES11 ox-updates
 
and run
 
$ zypper ref
$ zypper in open-xchange-munin-scripts
 
=== RedHat Enterprise Linux 6 ===
 
Start a console and create a software repository file if not already present:
 
$ vim /etc/yum.repos.d/ox.repo
 
[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/products/appsuite/stable/backend/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
 
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/RHEL6/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m
 
and run
 
$ yum update
$ yum install open-xchange-munin-scripts
 
=== RedHat Enterprise Linux 7 ===
 
Start a console and create a software repository file if not already present:
 
$ vim /etc/yum.repos.d/ox.repo
 
[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/products/appsuite/stable/backend/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
 
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/RHEL7/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m
 
and run
 
$ yum update
$ yum install open-xchange-munin-scripts
 
=== CentOS 6 ===
 
Start a console and create a software repository file if not already present:
 
$ vim /etc/yum.repos.d/ox.repo
 
[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/products/appsuite/stable/backend/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
 
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/RHEL6/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m
 
and run
 
$ yum update
$ yum install open-xchange-munin-scripts
 
=== CentOS 7 ===
 
Start a console and create a software repository file if not already present:
 
$ vim /etc/yum.repos.d/ox.repo
 
[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/products/appsuite/stable/backend/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
 
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/RHEL7/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m
 
and run
 
$ yum update
  $ yum install open-xchange-munin-scripts
 
=== open-xchange-munin-scripts-jolokia ===
 
Munin-scripts for Jolokia need an additional perl modules json and lwp, which are set inside the depenecies. Those should be installed automaticly.
 
If not, please install the following modules:
 
Debian: libwww-perl, libjson-perl
 
rpm: perl-JSON, perl-libwww-perl


== Configuring munin-node scripts for Open-Xchange ==
== Configuring munin-node scripts for Open-Xchange ==


The configuration of the scripts is done automatically. The database pool monitoring scripts will get configured only if the Open-Xchange server is running when installing the open-xchange-munin-scripts packages.
The configuration of the scripts is done automatically.  
 
Note: The database pool monitoring script will get only configured if the Open-Xchange server is running and the database pools initialized when installing the open-xchange-munin-scripts package. That can be verified by e.g.:
 
# showruntimestats -x | grep "DB Pool"
com.openexchange.pooling:name=DB Pool 4,NumWaiting = 0
com.openexchange.pooling:name=DB Pool 4,PoolSize = 3
com.openexchange.pooling:name=DB Pool 4,NumBrokenConnections = 0
com.openexchange.pooling:name=DB Pool 4,NumActive = 0
com.openexchange.pooling:name=DB Pool 4,NumIdle = 3
com.openexchange.pooling:name=DB Pool 4,AvgUseTime = 4.948
com.openexchange.pooling:name=DB Pool 4,MaxUseTime = 16777
com.openexchange.pooling:name=DB Pool 4,MinUseTime = 0
 
=== Configuring for open-xchange-munin-scripts-jolokia ===
 
Munin Scripts for Jolokia do have some additional settings for [[jolokia]].


The default configuration allows connections from the localhost, means that munin has to run on the same host. If you have already a munin host running or decided to use not the same as the Open-Xchange server, you have to change the file <code>/etc/munin/munin-node.conf</code> on each node you want to monitor:
<code>vim /etc/munin/plugin-conf.d/ox</code>
{|width="100%" style="table-layout: fixed" class='wikitable sortable' border='1'
! scope="col" width="30%" | Key
! scope="col" width="20%" | Default value
! scope="col" width="35%" | Comment
|-
| env.oxJolokiaUrl
| http://localhost:8009/monitoring/jolokia
| Base url for jolokia
|-
| env.oxJolokiaUser
| "changeMe!Now"
| <nowiki>User used for authentication with HTTP Basic Authentication.</nowiki>
|-
| env.oxJolokiaPassword
| "s3cr3t!toBeChanged"
| <nowiki>Password used for authentification</nowiki>
|}
 
WARNING: If <code> env.oxJolokiaUser </code> is not changed from its default value <code> changeMe!Now </code>, monitoring will not work as the user <code> changeMe!Now </code> is set to stop monitoring inside the munin scripts.
 
Both, <code> env.oxJolokiaUser </code> and <code> env.oxJolokiaPassword </code> need to be set to the same value as set inside <code>jolokia.properties</code>
 
=== Configuring for OX Documents / Documentconverter ===
 
OX Documents and Documentconverter monitoring can used by installing the additional packages
<code>open-xchange-documents-monitoring</code> and <code>open-xchange-documentconverter-jolokia</code>. The Documentconverter uses a different port to access monitoring data. The corresponding oxJolokiaURL is has to be configured with an entry in the settings.
<pre>
[ox_documentconverter*]
env.oxJolokiaUrl http://localhost:8008/monitoring/jolokia
</pre>
 
See this [[AppSuite:DocumentsMonitoring|article]] for more details.
 
= Supplementary notes for distributed munin clients =
 
== Munin node ==
The default munin node configuration only allows connections from localhost, which means that munin master has to run on the same host. If there already is a munin master running, that master IP has to be added to the file <code>/etc/munin/munin-node.conf</code> on each node:


  # A list of addresses that are allowed to connect.  This must be a
  # A list of addresses that are allowed to connect.  This must be a
Line 30: Line 278:
  allow ^127\.0\.0\.1$
  allow ^127\.0\.0\.1$


Replace the <code>allow</code> line with the IP of the munin host server IP.
== Munin master ==


== Configure Munin host ==
Make sure the munin and apache packages are installed. If only localhost is going to be monitored, the default configuration is sufficient. Other munin nodes can be added in the <code>/etc/munin/munin.conf</code> file:
Make sure you have the munin and apache packages installed. If you just monitor the localhost, you have to do nothing. Adding other nodes via the <code>/etc/munin/munin.conf</code> file:


  # a simple host tree
  # a simple host tree
Line 40: Line 287:
     use_node_name yes
     use_node_name yes


add the needed nodes like this example.
By default, the munin monitoring web page is only reached from localhost, other hosts or networks can be added in <code>/etc/apache2/conf.d/munin</code>:
 
By default you can reach the munin page only from localhost, so you usually have to allow other hosts or networks to connect. In <code>/etc/apache2/conf.d/munin</code> you can add them:


  Allow from localhost 127.0.0.0/8 ::1    # the default setting
  Allow from localhost 127.0.0.0/8 ::1    # the default setting
Line 52: Line 297:


[[Category: OX6]]
[[Category: OX6]]
[[Category: Administrator]]

Latest revision as of 12:31, 8 December 2016

How to install Munin scripts for Open-Xchange

Support for Jolokia

By Version 7.4.0, Munin Scripts do support Jolokia as a bridge to get their information. This has been done to get less overhead and speak with the corresponding JMX-beans directly.

Prerequisites

Munin node and munin master must be installed and configured prior using the Munin scripts package for Open-Xchange. The installation for this core components differs on various Linux distributions. For details, please visit:

http://munin-monitoring.org/

especially:

http://munin-monitoring.org/wiki/LinuxInstallation

open-xchange-munin-scripts

Installation on OX App Suite

Debian GNU/Linux 7.0 (valid until v7.8.2)

Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present: 

deb https://software.open-xchange.com/products/appsuite/7.8.2/backend/DebianWheezy/ /

# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/7.8.2/backend/updates/DebianWheezy/ /

and run 

$ apt-get update
$ apt-get install open-xchange-munin-scripts

Debian GNU/Linux 8.0

Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present: 

deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianJessie/ /

# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/DebianJessie/ /

and run 

$ apt-get update
$ apt-get install open-xchange-munin-scripts

SUSE Linux Enterprise Server 11 (valid until v7.8.2)

Add the package repository using zypper if not already present: 

$ zypper ar https://software.open-xchange.com/products/appsuite/7.8.2/backend/SLES11 ox

If you have a valid maintenance subscription, please run the following command and add the ldb account data to the url so that the most recent packages get installed: 

$ zypper ar https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/7.8.2/backend/updates/SLES11 ox-updates

and run 

$ zypper ref
$ zypper in open-xchange-munin-scripts

SUSE Linux Enterprise Server 12

Add the package repository using zypper if not already present: 

$ zypper ar https://software.open-xchange.com/products/appsuite/stable/backend/SLE_12 ox

If you have a valid maintenance subscription, please run the following command and add the ldb account data to the url so that the most recent packages get installed: 

$ zypper ar https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/SLES11 ox-updates

and run 

$ zypper ref
$ zypper in open-xchange-munin-scripts

RedHat Enterprise Linux 6

Start a console and create a software repository file if not already present: 

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/products/appsuite/stable/backend/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/RHEL6/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run 

$ yum update
$ yum install open-xchange-munin-scripts

RedHat Enterprise Linux 7

Start a console and create a software repository file if not already present: 

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/products/appsuite/stable/backend/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/RHEL7/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run 

$ yum update
$ yum install open-xchange-munin-scripts

CentOS 6

Start a console and create a software repository file if not already present: 

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/products/appsuite/stable/backend/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/RHEL6/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run 

$ yum update
$ yum install open-xchange-munin-scripts

CentOS 7

Start a console and create a software repository file if not already present: 

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/products/appsuite/stable/backend/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m

# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/RHEL7/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run 

$ yum update
$ yum install open-xchange-munin-scripts

open-xchange-munin-scripts-jolokia

Munin-scripts for Jolokia need an additional perl modules json and lwp, which are set inside the depenecies. Those should be installed automaticly.

If not, please install the following modules:

Debian: libwww-perl, libjson-perl

rpm: perl-JSON, perl-libwww-perl

Configuring munin-node scripts for Open-Xchange

The configuration of the scripts is done automatically.

Note: The database pool monitoring script will get only configured if the Open-Xchange server is running and the database pools initialized when installing the open-xchange-munin-scripts package. That can be verified by e.g.: 

# showruntimestats -x | grep "DB Pool"
com.openexchange.pooling:name=DB Pool 4,NumWaiting = 0
com.openexchange.pooling:name=DB Pool 4,PoolSize = 3
com.openexchange.pooling:name=DB Pool 4,NumBrokenConnections = 0
com.openexchange.pooling:name=DB Pool 4,NumActive = 0
com.openexchange.pooling:name=DB Pool 4,NumIdle = 3
com.openexchange.pooling:name=DB Pool 4,AvgUseTime = 4.948
com.openexchange.pooling:name=DB Pool 4,MaxUseTime = 16777
com.openexchange.pooling:name=DB Pool 4,MinUseTime = 0

Configuring for open-xchange-munin-scripts-jolokia

Munin Scripts for Jolokia do have some additional settings for jolokia.

vim /etc/munin/plugin-conf.d/ox

Key Default value Comment
env.oxJolokiaUrl http://localhost:8009/monitoring/jolokia Base url for jolokia
env.oxJolokiaUser "changeMe!Now" User used for authentication with HTTP Basic Authentication.
env.oxJolokiaPassword "s3cr3t!toBeChanged" Password used for authentification

WARNING: If env.oxJolokiaUser is not changed from its default value changeMe!Now , monitoring will not work as the user changeMe!Now is set to stop monitoring inside the munin scripts.

Both, env.oxJolokiaUser and env.oxJolokiaPassword need to be set to the same value as set inside jolokia.properties

Configuring for OX Documents / Documentconverter

OX Documents and Documentconverter monitoring can used by installing the additional packages open-xchange-documents-monitoring and open-xchange-documentconverter-jolokia. The Documentconverter uses a different port to access monitoring data. The corresponding oxJolokiaURL is has to be configured with an entry in the settings. 

[ox_documentconverter*]
env.oxJolokiaUrl http://localhost:8008/monitoring/jolokia

See this article for more details.

Supplementary notes for distributed munin clients

Munin node

The default munin node configuration only allows connections from localhost, which means that munin master has to run on the same host. If there already is a munin master running, that master IP has to be added to the file /etc/munin/munin-node.conf on each node: 

# A list of addresses that are allowed to connect.  This must be a
# regular expression, since Net::Server does not understand CIDR-style
# network notation unless the perl module Net::CIDR is installed.  You
# may repeat the allow line as many times as you'd like

allow ^127\.0\.0\.1$

Munin master

Make sure the munin and apache packages are installed. If only localhost is going to be monitored, the default configuration is sufficient. Other munin nodes can be added in the /etc/munin/munin.conf file: 

# a simple host tree
[localhost.localdomain]
    address 127.0.0.1
    use_node_name yes

By default, the munin monitoring web page is only reached from localhost, other hosts or networks can be added in /etc/apache2/conf.d/munin: 

Allow from localhost 127.0.0.0/8 ::1    # the default setting
Allow from 10.99.0.0/8                  # added network

The munin webpage is located at http://yourhost_where_munin_is_running.org/munin.

Retrieved from "https://wiki.open-xchange.com/wiki/index.php?title=OX_munin_scripts&oldid=22779"