square.gif 開発者リファレンス

homeicon.gif Print Page commentsicon.gif

Event Console(イベントコンソール)

目次 表示

コンソールのプロパティ

以下に、イベントコンソール・パッケージのコンソールのプロパティを示します。

######################################################

# console.properties

# All GW Console properties are configured here.

######################################################

 

#Webservices URL foundation_webserviceURL=http://localhost:8080/foundation-webapp/services/

 

#Page size for the data table in console. A numeric value. Set this to a reasonable limit upto 1000. Increasing beyond may have performance impact.

page_size=50

 

#JMS Client properties

java.naming.factory.initial=fr.dyade.aaa.jndi2.client.NamingContextFactory

 

java.naming.factory.host=localhost

java.naming.factory.port=16400

topic.name=foundation_events

context.factory=cf0

 

#Datatable built-in or common columns. Order of columns appears exactly the way listed here.

#Delimited with commas. To change the column label change the second part of the column.

#For example, to change the reportDate column label, change Received By GW to something else.

built_in_columns=reportDate:Received By GW,msgCount:Message

Count,device:Device,monitorStatus:Status,textMessage:Message,applicationType:Application Type,severity:Severity,lastInsertDate:Last

Detected,firstInsertDate:First Detected

 

#Nagios specific properties.valid values are true or false.

nagios_send_notification=true;

nagios_persistent_comment=true;

パブリックフィルタの追加

イベントコンソールは、異なる監視データのための表示任意を提供します。特定のApplications(アプリケーション)Host Groups(ホストグループ)、や、Accepted(承認済)、Open Closed(オープン・クローズ)、およびNotified(通知済)を含む指定されたOperation Status(任意ステータス)を含むシステムフィルタを見ることができます。定義済のPublic Filters(パブリックフィルタ)を通して監視データを見ることもできます。

GroundWork Monitor は、All Events(全イベント)Critical(クリティカル)Warning(ワーニング)Nagios Warning(Nagios ワーニング)Last 5 SNMPTRAP Warning(最近5つの SNMP TRAP ワーニング)Last 10 Minutes NAGIOS Critical(最近10分間の NAGIOS クリティカル)の5つの定義済のパブリックフィルタといっしょにリリースされます。イベントコンソールアプリケーションでは、開発者はパブリックフィルタの追加ができます。

パブリックフィルタのカスタマイズに使用するファイルは、/usr/local/groundwork/config ディレクトリ内にある console-admin-config.xml です。その構造を下記に示します:

注意: このファイルを修正したら、サーバの再起動が必要です。

表:設定の説明

Name

フィルタの名前です。これはコード識別子として使用され、どこからも参照されません。

<Name></Name>

Label

[必須] これはナビゲーションパネル上の UI 内に表示される実際のラベルです。

<Label></Label>

AppType

[任意] これはアプリケーションのタイプです; 有効な値は SYSTEM、NAGIOS、SNMPTRAP、SYSLOG のみです。

<AppType></AppType>

MonitorStatus

[任意] メッセージのステータス; 有効な値は WARNING、CRITICAL、UNKNOWN、OK、UP、UNREACHABLE、DOWN と PENDING です。

<MonitorStatus></MonitorStatus>

Severity

[任意] これはメッセージの重大度です (例. FATAL、NORMAL)

<Severity></Severity>

Fetch

[任意] フェッチサイズ (0よりもおきな値である必要) と順番(有効な値 ASC:昇順 と DESC:降順)の組み合わせです。

<Fetch>

  <Size></Size>

  <Order></Order>

</Fetch>

Time

[任意] これはサーバの reportDate アトリビュートに割り当てられます。Unit は、常に現在時間が基準となります(例、最近10分の場合は、10で、Measurement が MIN となります)。Measurement は時間の単位です;有効な値は MIN(分) と SEC(秒)のみです。

<Time>

  <Unit></Unit>

  <Measurement></Measurement>

</Time>

OpStatus

[任意] これはメッセージのオペレーションステータスです;有効な値は NOTIFY、ACCEPT、OPEN、CLOSED です。コンマで区切ることで、オペレーションステータスをサポートできます。

<OpStatus></OpStatus>

構造体の例

<PublicFilters>

    <Filter>

        <Name>Critical Events</Name>

        <Label>Critical</Label>

        <AppType></AppType>

        <MonitorStatus>CRITICAL</MonitorStatus>

        <Severity></Severity>

        <Fetch>

            <Size></Size>

            <Order></Order>

        </Fetch>

        <Time>

            <Unit></Unit>

            <Measurement></Measurement>

        </Time>

        <OpStatus></OpStatus>

    </Filter>

 

    <Filter>

        <Name>Warning Events</Name>

        <Label>Warning</Label>

        <AppType></AppType>

        <MonitorStatus>WARNING</MonitorStatus>

        <Severity></Severity>

        <Fetch>

            <Size></Size>

            <Order></Order>

        </Fetch>

        <Time>

            <Unit></Unit>

            <Measurement></Measurement>

        </Time>

        <OpStatus></OpStatus>

    </Filter>

 

    <Filter>

        <Name>Nagios Warning Events</Name>

        <Label>Nagios Warning</Label>

        <AppType>NAGIOS</AppType>

        <MonitorStatus>WARNING</MonitorStatus>

        <Severity></Severity>

        <Fetch>

            <Size></Size>

            <Order></Order>

        </Fetch>

        <Time>

            <Unit></Unit>

            <Measurement></Measurement>

        </Time>

        <OpStatus></OpStatus>

    </Filter>

 

    <Filter>

        <Name>Last 5 SNMPTRAPs of MonitorStatus Warning Events</Name>

        <Label>Last 5 SNMPTRAP Warning</Label>

        <AppType>SNMPTRAP</AppType>

        <MonitorStatus>WARNING</MonitorStatus>

        <Severity></Severity>

        <Fetch>

            <Size>5</Size>

            <Order>DESC</Order>

        </Fetch>

        <Time>

            <Unit></Unit>

            <Measurement></Measurement>

        </Time>

        <OpStatus></OpStatus>

    </Filter>

 

    <Filter>

        <Name>Last 10 Minutes worth of NAGIOS Critical Events</Name>

        <Label>Last 10 Minutes NAGIOS Critical</Label>

        <AppType>NAGIOS</AppType>

        <MonitorStatus>CRITICAL</MonitorStatus>

        <Severity></Severity>

        <Fetch>

            <Size></Size>

            <Order>DESC</Order>

        </Fetch>

        <Time>

            <Unit>-10</Unit>

            <Measurement>MIN</Measurement>

        </Time>

        <OpStatus></OpStatus>

    </Filter>

 

</PublicFilters>

クションの構成設定

イベントコンソールで、ユーザは、メッセージを選んで、選んだメッセージについて、Open Log Message(ログメッセージを開く)、Close Log Message(ログメッセージを閉じる)、Accept Log Message(ログメッセージを承認)、および他のアプリケーションタイプなど、さまざまなアクションを適用することができます。

選択したメッセージで起動されるアクションのリストが提供されます。二つのアクションタイプのセットがあります。 OPEN、CLOSE、ACCEPT および NOTIFYを含む標準のシステムアクションと、NAGIOS ACKNOWLEDGE を含むアプリケーションアクションです。単一のアプリケーションタイプに属するメッセージが選ばれた場合、
そのアクションのリストは、標準システムアクションに指定されたアプリケーションアクション加わったもので構成されます。複数のアプリケーションタイプに属するメッセージが選ばれた場合、標準のシステムアクションのみがリストされるでしょう。
アクションの説明は、下表を参照してください。

開発者は、特定のアプリケーションタイプのためのイベントコンソールのアクションを構成できます。これらのアクションは3つのモードでデータをサブミットできます:

  1. サーバ側のスクリプトを呼び出す

  2. URLにポストする

  3. Java APIを呼び出す

注意: アクションの構成設定後は、gwservices をリスタートする必要があります: /usr/local/groundwork/ctlscript.sh restart gwservices

イベントコンソールでスクリプトベースのアクションを設定する

ステップ 1 - ログインとアクションのメニュー名の定義

データベースの GWCollageDB スキーマにログインします。 下記のアクションテーブルスクリプトを適用します。 Name フィールドはアクションメニュー内に表示されます。このフィールドには、どのようなテキストでの入力できますが、アクションを説明するべきです。

INSERT INTO Action (ActionTypeID,Name,Description) values((SELECT ActionTypeID FROM ActionType WHERE Name = "SCRIPT_ACTION"),"Invoke my script","Invoke a script for the selected message");

ステップ 2 - アクションのプロパティ設定

actionProperty テーブルに下記のスクリプトを適用します。Name は、サーバ側スクリプトのための定数 ”Script”です。Value は、そのシェルスクリプトのパスです。

INSERT INTO ActionProperty (ActionID, Name, Value)

VALUES( (SELECT ActionID FROM Action WHERE Name = "Invoke my script"), "Script", "/usr/local/groundwork/foundation/scripts/my_script.sh");

注意: シェルスクリプトは、"nagios" ユーザに対する実行特権を持つことを確実にしてください。

ステップ 3 -アプリケーションのアプリケーションタイプへの割り当て

ApplicationAction に下記のスクリプトを適用します。

INSERT INTO ApplicationAction (ApplicationTypeID,ActionID)

VALUES ((SELECT ApplicationTypeID FROM ApplicationType WHERE Name = "NAGIOS"), (SELECT ActionID FROM Action WHERE Name = "Invoke my script"));

ステップ 4 - アクションのパラメータの構成設定

これらは、コマンドラインの引数です。ActionParameter テーブルに下記のスクリプトを適用します。Name と Value は同じです。
コンソールから以下のパラメータが利用できます:

アクションパラメータのためのスクリプト

INSERT INTO ActionParameter (ActionID, Name, Value) VALUES ((SELECT ActionID FROM Action WHERE Name = "Invoke my script")  ,"LogMessageIds","LogMessageIds");

INSERT INTO ActionParameter (ActionID, Name, Value) VALUES ((SELECT ActionID FROM Action WHERE Name = "Invoke my script"),"UserName","UserName");

複数のメッセージが選択されると、 LogMessageIds の値は、コンマで区切られます。ログメッセージから他のパラメータを得るために、開発者は LogMessageId を渡して Web サービスを呼ぶことができます。

イベントコンソール内の HTTP 要求アクションを設定する

ステップ 1 - ログインとアクションメニュー名の定義

データベースの GWCollageDB スキーマにログインします。Action テーブルに下記のスクリプトを適用します。 Name には、イベントコンソールのアクションメニューに表示される、意味のある名前が必要です。Description は、どのような文字列でも良いです。

INSERT INTO Action (ActionTypeID,Name,Description) values((SELECT ActionTypeID FROM ActionType WHERE Name = "HTTP_REQUEST_ACTION"),"HTTP Post Test","HTTP Post Test");

ステップ 2 - アクションのプロパティ設定

actionProperty テーブルに下記のスクリプトを適用します。Name はサーバ側 HTTP リクエストのための定数”r;URL”です。Value は URL です。

INSERT INTO ActionProperty (ActionID, Name, Value)

VALUES( (SELECT ActionID FROM Action WHERE Name = "HTTP Post Test"), "URL", "http://172.28.113.102:8081/TestHTTPPost/TestServlet");

ReadTimeout を秒で設定します。ReadTimeout は読み出しオペレーションが完了しない場合にタイムアウトになるまでの秒数です。

INSERT INTO ActionProperty (ActionID, Name, Value)

VALUES( (SELECT ActionID FROM Action WHERE Name = "HTTP Post Test"), "ReadTimeout", "20");

ConnectionTimeout を秒で設定します。ConnectionTimeout はコネクションタイムアウトになるまでの秒数を設定します。

INSERT INTO ActionProperty (ActionID, Name, Value)

VALUES( (SELECT ActionID FROM Action WHERE Name = "HTTP Post Test"), "ConnectionTimeout", "20");

ステップ 3 -アプリケーションのアプリケーションタイプへの割り当て

ApplicationAction に下記のスクリプトを適用します。

INSERT INTO ApplicationAction (ApplicationTypeID,ActionID)

VALUES ((SELECT ApplicationTypeID FROM ApplicationType WHERE Name = "NAGIOS"), (SELECT ActionID FROM Action WHERE Name = "HTTP Post Test"));

ステップ 4 - アクションのパラメータの構成設定

これらは、要求パラメータです。ActionParameter テーブルに下記のスクリプトを適用します。

INSERT INTO ActionParameter (ActionID, Name, Value) VALUES ((SELECT ActionID FROM Action WHERE Name = "HTTP Post Test"),"UserName","UserName");

INSERT INTO ActionParameter (ActionID, Name, Value) VALUES ((SELECT ActionID FROM Action WHERE Name = "HTTP Post Test") ,"LogMessageIds","LogMessageIds");

複数のメッセージが選択されると、 LogMessageIds の値はコンマで区切られます。ログメッセージから他のパラメータを得るために、開発者は LogMessageId を渡して Web サービスを呼ぶことができます。

イベントコンソール内の Java ベース API アクションの構成設定

Java API を使ったアクションを導入するには NagiosAcknowledgeAction (Java class)を参照してください。

org.goundwork.foundation.bs.actionNagiosAcknowledgeAction

イベントコンソールの国際化のための構成設定

GroundWork Monitor の Event Console(イベントコンソール)アプリケーションは、国際化(i18n)をサポートしています。標準サポート言語には英語と仏語で、他は新メッセージバンドルを使って構成できます。注意点として、ラベルはローカライズされますが、データはされません。 (i18n)

イベントコンソールを特定のロケールに構成設定する

ここでは、イベントコンソールを French ロケールに設定します。仏語のための ISO 639-1 コードはfrです。 List of ISO 639-1 コードの完全な一覧は、このリンクを参照してください:

  1.  下記のファイルを開きます:
    /usr/local/groundwork/config/console.properties

  2. ロケールのコードを  English: en から French: fr に変更します

下記を:

#Internationalization

locale=en

下記に:

#Internationalization

locale=fr

新規メッセージバンドルを追加する

この例では、日本語のための新メッセージバンドルを追加します。

  1. 下記のファイルを開きます: /usr/local/groundwork/config/console.properties

  1. 現在のロケール属性コードを日本語のためのコード: jp に変更します。

#Internationalization

locale=jp

  1. 次に messages_en.properties ファイル(現在のロケール属性を使用)を新しいファイル名  messages_jp.properties にコピーし、すべてのメッセージを翻訳する必要があるでしょう。

  2. そして、下記のコマンドで gwservices をリスタートします:

/usr/local/groundwork/ctlscript.sh restart gwservices

Working with Dynamic Properties

You can change the behavior of the Console which relates to installations that have dynamic properties in Foundation - which is the default, since all of the extra Nagios, syslog and snmptrap application fields are dynamic.

  1. To verify this, modify DynaProperty in the console-admin-config.xml in /usr/local/groundwork/config folder with the following instructions.