Actions

Mahara日本語ドキュメント/システム管理者ガイド/MaharaをMuninで監視する: Difference between revisions

From Mahara Wiki

< Mahara日本語ドキュメント‎ | システム管理者ガイド
No edit summary
(done.)
 
(75 intermediate revisions by the same user not shown)
Line 1: Line 1:
作成中です - [[User:Mits|mits]]
[[File:mahara munin plugin.jpg|200px|thumb|right]]
[[File:mahara munin plugin.jpg|200px|thumb|right]]
さまざまなMahara統計データを生成できるMuninプラグインはランカスター大学 (Lancaster University) CISの無償提供により、[https://github.com/lucisgit/mahara-munin-plugin GitHubにてダウンロードすることができます]。 This is a multigraph wildcard Munin plugin, that allows you to gather some useful statistics from Mahara database and represent it in the nice graphs. Among the graphs it generates are:
さまざまなMahara統計データを生成できるMuninプラグインはランカスター大学 (Lancaster University) CISの無償提供により、[https://github.com/lucisgit/mahara-munin-plugin GitHubからダウンロードすることができます]。これは複数グラフのためのワイルドカードMuninプラグインであり、Maharaデータベースから有用な統計を取得して美しいグラフを表示します。生成されるグラフは以下のとおりです:
* Currently logged-in users
* 現在のログインユーザ
* Groups
* グループ
* Disk usage
* ディスク使用量
* Pages
* ページ
* Users's activity
* ユーザ活動


The plugin can be used with Mahara 1.5 and above. '''It works with PostgreSQL database only''' at the moment.
プラグインはMahara 1.5またはそれ以上で使用することができます。現在のところ、'''PostgreSQLデータベースのみで動作します'''。


== Pre-requires ==
== 事前要件 (Pre-requires) ==


You need to have Munin installed and configured on your system. This is beyond the scope of this discussion, please use [http://munin-monitoring.org/wiki/Documentation Munin documentation] for more information.
あなたのシステムにおいて、Muninをインストールおよび設定する必要があります。これは説明の範囲を超えているため、詳細情報に関して、[http://munin-monitoring.org/wiki/Documentation Munin documentation]をご覧ください。


== Configuration ==
== 設定 ==


To make this work, you have to install plugin, create plugin configuration file and then create a symlink to plugin that reflects the name of the Moodle database.
これを動作させるため、あなたはプラグインをインストール、プラグイン設定ファイルを作成、そしてプラグインへのシンボリックリンク (Moodleデータベース名を反映させるため) を作成する必要があります。


=== Installing plugin ===
=== プラグインのインストール ===


You can clone using git or download the plugin [https://github.com/lucisgit/mahara-munin-plugin from GitHub], unpack (if you downloaded it) and copy to either Munin standard plugins directory (i.e. <tt>/usr/share/munin/plugins/</tt>) or custom directory if you want to keep custom plugins separate.
あなたはgitを使用してコピーするか、[https://github.com/lucisgit/mahara-munin-plugin GitHubから]プラグインをダウンロードすることができます。あなたがプラグインをダウンロードした場合、解凍してMunin標準プラグインディレクトリ (例 <tt>/usr/share/munin/plugins/</tt>) に入れること、またカスタムプラグインを分離したい場合、カスタムディレクトリに入れることができます。
<pre>
<pre>
mv /tmp/mahara_ /usr/share/munin/plugins/mahara_
mv /tmp/mahara_ /usr/share/munin/plugins/mahara_
</pre>
</pre>


=== Configuring plugin ===
=== プラグインの設定 ===


You need to create configuration file in <tt>plugin-conf.d</tt> directory, it's usually located in <tt>/etc/munin/</tt>. There is no specific requirements for configuration file name, but it is better to call it <tt>mahara</tt> for convenience. The configuration may contain standard [http://munin-monitoring.org/wiki/plugin-conf.d Munin plugin configuration attributes], libpq environment variables for configuring database connection settings (e.g. PGUSER, PGHOST, etc.) and plugin-specific settings. Generally, it is easier if you run the the plugin directly on the database server as postgres user. In this case the minimum configuration will look like:
あなたは「<tt>plugin-conf.d</tt>」ディレクトリ内に設定ファイルを作成する必要があります。通常、このディレクトリは「<tt>/etc/munin/</tt>」となります。設定ファイル名に関して、特定の要件はありませんが、利便性のため「mahara」にした方が良いでしょう。設定には、標準[http://munin-monitoring.org/wiki/plugin-conf.d Muninプラグイン設定属性]、データベース接続設定のlibpq環境変数 (例 PGUSER, PGHOST等) および プラグイン独自の設定が含まれます。通常、postgresユーザとして、データベースサーバ上でプラグインを直接実行した方が簡単です。この場合、minimum設定は下記のようになります:


<pre>
<pre>
Line 35: Line 33:
</pre>  
</pre>  


If your plugin located on the different server, it will need an additional settings to accessing Mahara database. Given that plugin is using Munin::Plugin::Pgsql library, it supports all libpq variables, the most common of them are:


* PGHOST - hostname to connect to
あなたのプラグインが別のサーバにある場合、Maharaデータベースにアクセスするため、さらなる設定が必要となります。プラグインがMunin::Plugin::Pgsqlライブラリを使用する場合、すべてのlibpq変数をサポートします。一般的な変数は下記のとおりです:
* PGPORT - port number to connect to
 
* PGUSER - username to connect as
* PGHOST - 接続するホスト名
* PGPASSWORD - password to connect with, if a password is required
* PGPORT - 接続するポート番号
* PGUSER - 接続するユーザ名
* PGPASSWORD - 接続するためのパスワード (パスワードが必要な場合)


For using these variables in the plugin configuration, you need to pass them as environment setting, i.e. prepend them with <tt>env</tt>.
プラグイン設定で3つの変数を使用するため、あなたは環境設定として渡す必要があります。例) 「<tt>env</tt>.」を先頭に付加


<pre>
<pre>
Line 52: Line 51:
</pre>  
</pre>  


Plugin also has some own configuration variables that need to be set as environment setting as well if you wish using them:
あなたがプラグインを使用したい場合、同様に環境設定として設定する必要のある独自設定変数があります:


* <tt>env.updatetime</tt> - you may configure the period for which the time-based data is calculated (e.g. used in the number of logged-in users reporting or assignments submissions). By default the value of 300 sec is used (which is 5 min Munin default update interval).
* <tt>env.updatetime</tt> - あなたは時間ベースのデータを計算するための期間を設定することができます (例 ログインユーザ数レポートまたは課題提出数)。デフォルトでは設定値300秒 (Munin更新間隔5分) が使用されます。
* <tt>env.dbprefix</tt> - if you use prefix in Mahara database tables, pass the correct one using this parameter.
* <tt>env.dbprefix</tt> - あなたがMaharaデータベーステーブルで接頭辞を使用する場合、このパラメータを使用して正しい接頭辞を渡してください。
* <tt>env.showdefaultpages</tt> - whether to show default/system pages on the graph (user dashboard, user profile, group home page). Can be enabled by setting this variable to 1. Disabled by default.
* <tt>env.showdefaultpages</tt> - デフォルト/システムページ (ユーザダッシュボード、ユーザプロファイル、グループホームページ) をグラフに表示するかどうか指定します。この変数の値を設定で「1」にすることができます。デフォルトでは無効にされています。


For more information on Munin plugins configuration see corresponding [http://munin-monitoring.org/wiki/plugin-conf.d Munin wiki page].
Muninプラグイン設定に関する詳細は[http://munin-monitoring.org/wiki/plugin-conf.d Munin wikiページ]をご覧ください。


===Creating a symlink===
===シンボリックリンク (symlink) を作成する===


The final bit that needs to be done is to create a symlink to the plugin in <tt>/etc/munin/plugins</tt> directory. Being a [http://munin-monitoring.org/wiki/WildcardPlugins wildcard plugin], Mahara plugin will attempt to determine the database name it will be using from the symlink, thus the symlink need to contain the name of the Mahara database:
最後の作業は「<tt>/etc/munin/plugins</tt>」ディレクトリのシンボリックリンク (symlink) を作成することです。[http://munin-monitoring.org/wiki/WildcardPlugins ワイルドカードプラグインとして、Maharaプラグインは使用されるシンボリックリンクからデータベース名の決定を試みます。そのため、シンボリックリンクにはMaharaデータベース名を含む必要があります:


<pre>
<pre>
Line 68: Line 67:
</pre>
</pre>


<tt>ls -la</tt> command run in <tt>/usr/share/munin/plugins</tt> directory will display that the symlink is correct:
「<tt>/usr/share/munin/plugins</tt>」ディレクトリ内でコマンド「<tt>ls -la</tt>」を実行することで、シンボリックリンクが正しいかどうか確認することができます:


<pre>
<pre>
Line 74: Line 73:
</pre>
</pre>


The database name in the example above is <tt>mahara-db</tt>
上記例のデータベース名は「<tt>mahara-db</tt>」となります。


The wildcard plugin concept is especially useful for large scale systems when you have more than one Mahara database on the same database server. I this case you may create symlink for each Mahara database on the same system and have them all monitored.
あなたが同じデータベースサーバ上に1つ以上のMaharaデータベースを稼動させる場合、ワイルドカードプラグインの考え方は大規模システムに対して特に有用です。この場合、あなたは同一システム内のそれぞれのMaharaデータベースにシンボリックリンクを作成して、すべてを監視することができます。


==Testing configuration and plugin==
==設定およびプラグインのテスト==


You will need to restart munin node on the client to make sure it picked up new plugins. Now, you may see what the plugin outputs when it is being queried by Munin service:
新しいプラグインが取り込まれることを確認するため、あなたはクライアントのmuninノードを再起動する必要があります。ここであなたは、Muninサービスから問い合わせがあった場合に何が表示されるのか閲覧することができます:


  ~# munin-run mahara_mahara-db
  ~# munin-run mahara_mahara-db


will output the current data values for each graph
上記コマンドは、それぞれのグラフに関する現在のデータ値を出力します。


<pre>
<pre>
Line 97: Line 96:
</pre>
</pre>


to see the graphs configuration that plugin returns run
プラグインが出力するグラフに関する設定を閲覧するには、次のコマンドを実行します:


  ~# munin-run mahara_mahara-db config
  ~# munin-run mahara_mahara-db config


You may read more about plugin debugging in [http://munin-monitoring.org/wiki/Debugging_Munin_plugins Munin wiki document].
あなたはプラグインのデバッグ詳細に関して、[http://munin-monitoring.org/wiki/Debugging_Munin_plugins Munin wikiドキュメント (英語)]をお読みください。


==Some useful hints==
==役立つヒント==


You may set up warning and critical thresholds for particular services on the Munin server side. When one of the values will be above defined limits, the service will be highlighted in the Munin web interface. You may elaborate this further and set up various alerts. For more info see [http://munin-monitoring.org/wiki/HowToContact page].
あなたはMuninサーバサイドの特定のサービスにおいて、警告および限界閾値を設定しても良いでしょう。上記の値の1つで制限が設定された場合、Muninウェブインターフェース内のサービスがハイライトされます。さらに詳細に設定した後、あなたは様々な警告を設定することができます。詳細は、[http://munin-monitoring.org/wiki/HowToContact このページ]をご覧ください。


==Note for developers==
==開発者メモ==


This Munin Mahara plugin is using [https://github.com/munin-monitoring/munin/blob/devel/plugins/lib/Munin/Plugin/Pgsql.pm Munin::Plugin::Pgsql] library, which makes it work with PostgreSQL database only at the moment. It is also a [http://munin-monitoring.org/wiki/MultigraphSampleOutput multigraph] plugin which allows to keep all the graphs generation code within the same file. The [http://munin-monitoring.org/wiki/WildcardPlugins wildcard plugin] functionality is implemented the way that it takes database name from the symlink.
このMunin Maharaプラグインは[https://github.com/munin-monitoring/munin/blob/devel/plugins/lib/Munin/Plugin/Pgsql.pm Munin::Plugin::Pgsql]ライブラリを使用しています。現在のところ、PostgreSQLのみで動作します。また、グラフ生成コードを同一ファイル内に保持することのできる[http://munin-monitoring.org/wiki/MultigraphSampleOutput multigraph]プラグインでもあります。シンボリックリンクからデータベース名を取得するよう、[http://munin-monitoring.org/wiki/WildcardPlugins ワイルドカードプラグイン]機能が実装されます。


You are more than welcome to contribute to this work and create pull request for integration of your changes.
この作業に関する寄贈、およびあなたの変更を統合するためのpullリクエストの作成を歓迎します。


==Useful Links==
==有用なリンク==


* [https://github.com/lucisgit/mahara-munin-plugin mahara-munin-plugin on GitHub]
* [https://github.com/lucisgit/mahara-munin-plugin mahara-munin-plugin - GitHub]
* [http://munin-monitoring.org/wiki/Documentation Munin system documentation]
* [http://munin-monitoring.org/wiki/Documentation Muninシステムドキュメンテーション (英語)]

Latest revision as of 04:09, 26 September 2013

Mahara munin plugin.jpg

さまざまなMahara統計データを生成できるMuninプラグインはランカスター大学 (Lancaster University) CISの無償提供により、GitHubからダウンロードすることができます。これは複数グラフのためのワイルドカードMuninプラグインであり、Maharaデータベースから有用な統計を取得して美しいグラフを表示します。生成されるグラフは以下のとおりです:

  • 現在のログインユーザ
  • グループ
  • ディスク使用量
  • ページ
  • ユーザ活動

プラグインはMahara 1.5またはそれ以上で使用することができます。現在のところ、PostgreSQLデータベースのみで動作します。

事前要件 (Pre-requires)

あなたのシステムにおいて、Muninをインストールおよび設定する必要があります。これは説明の範囲を超えているため、詳細情報に関して、Munin documentationをご覧ください。

設定

これを動作させるため、あなたはプラグインをインストール、プラグイン設定ファイルを作成、そしてプラグインへのシンボリックリンク (Moodleデータベース名を反映させるため) を作成する必要があります。

プラグインのインストール

あなたはgitを使用してコピーするか、GitHubからプラグインをダウンロードすることができます。あなたがプラグインをダウンロードした場合、解凍してMunin標準プラグインディレクトリ (例 /usr/share/munin/plugins/) に入れること、またカスタムプラグインを分離したい場合、カスタムディレクトリに入れることができます。 

mv /tmp/mahara_ /usr/share/munin/plugins/mahara_

プラグインの設定

あなたは「plugin-conf.d」ディレクトリ内に設定ファイルを作成する必要があります。通常、このディレクトリは「/etc/munin/」となります。設定ファイル名に関して、特定の要件はありませんが、利便性のため「mahara」にした方が良いでしょう。設定には、標準Muninプラグイン設定属性、データベース接続設定のlibpq環境変数 (例 PGUSER, PGHOST等) および プラグイン独自の設定が含まれます。通常、postgresユーザとして、データベースサーバ上でプラグインを直接実行した方が簡単です。この場合、minimum設定は下記のようになります: 

[mahara_*]
user postgres


あなたのプラグインが別のサーバにある場合、Maharaデータベースにアクセスするため、さらなる設定が必要となります。プラグインがMunin::Plugin::Pgsqlライブラリを使用する場合、すべてのlibpq変数をサポートします。一般的な変数は下記のとおりです:

  • PGHOST - 接続するホスト名
  • PGPORT - 接続するポート番号
  • PGUSER - 接続するユーザ名
  • PGPASSWORD - 接続するためのパスワード (パスワードが必要な場合)

プラグイン設定で3つの変数を使用するため、あなたは環境設定として渡す必要があります。例) 「env.」を先頭に付加 

[mahara_*]
user root
env.PGHOST your_db_hostname
env.PGUSER your_db_username
env.PGPASSWORD your_db_password

あなたがプラグインを使用したい場合、同様に環境設定として設定する必要のある独自設定変数があります:

  • env.updatetime - あなたは時間ベースのデータを計算するための期間を設定することができます (例 ログインユーザ数レポートまたは課題提出数)。デフォルトでは設定値300秒 (Munin更新間隔5分) が使用されます。
  • env.dbprefix - あなたがMaharaデータベーステーブルで接頭辞を使用する場合、このパラメータを使用して正しい接頭辞を渡してください。
  • env.showdefaultpages - デフォルト/システムページ (ユーザダッシュボード、ユーザプロファイル、グループホームページ) をグラフに表示するかどうか指定します。この変数の値を設定で「1」にすることができます。デフォルトでは無効にされています。

Muninプラグイン設定に関する詳細はMunin wikiページをご覧ください。

シンボリックリンク (symlink) を作成する

最後の作業は「/etc/munin/plugins」ディレクトリのシンボリックリンク (symlink) を作成することです。[http://munin-monitoring.org/wiki/WildcardPlugins ワイルドカードプラグインとして、Maharaプラグインは使用されるシンボリックリンクからデータベース名の決定を試みます。そのため、シンボリックリンクにはMaharaデータベース名を含む必要があります: 

ln -s /usr/share/munin/plugins/mahara_ /etc/munin/plugins/mahara_yourmaharadatabasename

「/usr/share/munin/plugins」ディレクトリ内でコマンド「ls -la」を実行することで、シンボリックリンクが正しいかどうか確認することができます: 

lrwxrwxrwx 1 root root 52 Nov 21 16:29 mahara_mahara-db -> /usr/share/munin/plugins/mahara_

上記例のデータベース名は「mahara-db」となります。

あなたが同じデータベースサーバ上に1つ以上のMaharaデータベースを稼動させる場合、ワイルドカードプラグインの考え方は大規模システムに対して特に有用です。この場合、あなたは同一システム内のそれぞれのMaharaデータベースにシンボリックリンクを作成して、すべてを監視することができます。

設定およびプラグインのテスト

新しいプラグインが取り込まれることを確認するため、あなたはクライアントのmuninノードを再起動する必要があります。ここであなたは、Muninサービスから問い合わせがあった場合に何が表示されるのか閲覧することができます: 

~# munin-run mahara_mahara-db

上記コマンドは、それぞれのグラフに関する現在のデータ値を出力します。 

multigraph maharausers
users.value 1

multigraph maharapages
groupportfolio.value 42
instportfolio.value 1
userportfolio.value 531
...

プラグインが出力するグラフに関する設定を閲覧するには、次のコマンドを実行します: 

~# munin-run mahara_mahara-db config

あなたはプラグインのデバッグ詳細に関して、Munin wikiドキュメント (英語)をお読みください。

役立つヒント

あなたはMuninサーバサイドの特定のサービスにおいて、警告および限界閾値を設定しても良いでしょう。上記の値の1つで制限が設定された場合、Muninウェブインターフェース内のサービスがハイライトされます。さらに詳細に設定した後、あなたは様々な警告を設定することができます。詳細は、このページをご覧ください。

開発者メモ

このMunin MaharaプラグインはMunin::Plugin::Pgsqlライブラリを使用しています。現在のところ、PostgreSQLのみで動作します。また、グラフ生成コードを同一ファイル内に保持することのできるmultigraphプラグインでもあります。シンボリックリンクからデータベース名を取得するよう、ワイルドカードプラグイン機能が実装されます。

この作業に関する寄贈、およびあなたの変更を統合するためのpullリクエストの作成を歓迎します。

有用なリンク

Retrieved from ‘https://wiki.mahara.org/index.php?title=Mahara日本語ドキュメント/システム管理者ガイド/MaharaをMuninで監視する&oldid=4747’