Kibana ポートレットの設定¶
概要¶
Kibana ポートレット連携時の接続先情報を設定します。
モジュール Kibana ポートレット連携 フォーマットファイル(xsd) WEB-INF/schema/im-kibana-config.xsd 設定場所 WEB-INF/conf/im-kibana-config/{任意のファイル名}.xml <?xml version="1.0" encoding="UTF-8"?> <im-kibana-config xmlns="http://www.intra-mart.jp/system/im-kibana/config/im-kibana-config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.intra-mart.jp/system/im-kibana/config/im-kibana-config ../../schema/im-kibana-config.xsd "> <authz action="execute" uri="service://im_kibana_portlet/web_service/visualize"/> <kibana-config-list> <kibana-config id="sample_1"> <root-url>http://localhost:5601</root-url> <kibana-version>5.2.0</kibana-version> </kibana-config> <kibana-config id="sample_2" tenant="default another"> <root-url>http://localhost:5602</root-url> <kibana-version>4.3.1</kibana-version> <kibana-meta-index>.kibana</kibana-meta-index> <authorizer>sample.Authorizer</authorizer> <custom-field> <field type="boolean" required="true" key="foo1">bar1</field> <field required="true" key="foo2">bar2</field> <field key="foo3">bar3</field> </custom-field> <field-mapper>sample.FieldMapper</field-mapper> <field-provider>sample.FieldProvider</field-provider> </kibana-config> </kibana-config-list> </im-kibana-config>
リファレンス¶
Kibana ポートレットの設定¶
タグ名 kibana-config-list Kibana ポートレット連携時の接続先情報を設定します。【設定項目】
<im-kibana-config> <kibana-config-list> ... </kibana-config-list> </im-kibana-config>
必須項目 × 複数設定 × 設定値・設定する内容
kibana-config Kibana ポートレットの詳細設定 単位・型 なし 省略時のデフォルト値 なし 親タグ im-kibana-config
Kibana ポートレットの詳細設定¶
タグ名 kibana-config Kibana ポートレットの詳細を設定します。【設定項目】
<kibana-config id="sample_2" tenant="default another"> <root-url>http://localhost:5602</root-url> <kibana-version>4.3.1</kibana-version> <kibana-meta-index>.kibana</kibana-meta-index> <authorizer>sample.Authorizer</authorizer> <custom-field> <field type="boolean" required="true" key="I18N.MESSAGE.EXAMPLE1">true</field> <field required="true" key="I18N.MESSAGE.EXAMPLE2">example2</field> <field key="I18N.MESSAGE.EXAMPLE3">example3</field> </custom-field> <field-mapper>sample.FieldMapper</field-mapper> <field-provider>sample.FieldProvider</field-provider> </kibana-config>
必須項目 × 複数設定 ○ 設定値・設定する内容
root-url 接続先KibanaのルートURL kibana-version 接続先Kibanaのバージョン kibana-meta-index 接続先Kibanaのメタインデックス名 authorizer アクセス権のチェックを行うプラグインクラス名 custom-field カスタムフィールド field-mapper フィールド名の物理名と論理名を変換するプラグインクラス名 field-provider フィールドの一覧を提供するプラグインクラス名 単位・型 なし 省略時のデフォルト値 なし 親タグ kibana-config-list 【属性】
属性名 説明 必須 デフォルト値 id Kibana ポートレットを識別する一意のIDを設定します。 ○ なし timeout Kibana ポートレットへ接続する際のコネクションタイムアウトするまでの秒数を設定します。 × 30 tenant 利用できる intra-mart Accel Platform の テナントID を設定します。複数の テナント を指定する場合、テナントID は半角スペースで区切って記載してください。テナントID の指定がない場合、全ての テナント で利用が可能です。× なし
カスタムフィールド¶
タグ名 custom-field カスタムフィールドを設定します。【設定項目】
<kibana-config> <custom-field> ... </custom-field> </kibana-config>
必須項目 × 複数設定 × 設定値・設定する内容
field カスタムフィールドの詳細設定 単位・型 なし 省略時のデフォルト値 なし 親タグ kibana-config
フィールド¶
タグ名 field カスタムフィールドの詳細を設定します。【設定項目】
<custom-field> <field type="boolean" required="true" key="I18N.MESSAGE.EXAMPLE1">true</field> </custom-field>
必須項目 × 複数設定 ○ 設定値・設定する内容 カスタムフィールドの詳細を設定します。 単位・型 なし 省略時のデフォルト値 なし 親タグ custom-field 【属性】
属性名 説明 必須 デフォルト値 type カスタムフィールドのタイプを設定します。
- string, boolean, integer のいずれかを指定してください。
× なし required このカスタムフィールドが必須かどうかを設定します。 × false key このカスタムフィールドの名称を取得するメッセージキーを指定します。 キーに対応する名称を、メッセージプロパティファイル (conf/message/*.properties) に定義してください。 ○ なし
認可の設定¶
タグ名 authz 認可の設定をします。通常は変更しません。【設定項目】
<im-kibana-config> <authz action-"" uri=""/> </im-kibana-config>
必須項目 × 複数設定 × 設定値・設定する内容 Kibana ポートレット への接続を許可する認可の設定を行います。 単位・型 なし 省略時のデフォルト値 なし 親タグ im-kibana-config 【属性】
属性名 説明 必須 デフォルト値 action 認可のアクションを指定します。 × execute uri 認可のリソースURIを指定します。 × service://im_kibana_portlet/web_service/visualize
ハンドラー実装クラス¶
タグ名 handler Kibana ポートレットへ接続する処理を実装したクラスを設定します。通常は変更しません。【設定項目】
<im-kibana-config> <handler /> </im-kibana-config>
必須項目 × 複数設定 × 設定値・設定する内容 Kibana ポートレットへ接続する処理を実装したクラスを設定します。単位・型 なし 省略時のデフォルト値 jp.co.intra_mart.foundation.kibana.proxy.KibanaProxyHandler 親タグ im-kibana-config 【属性】
属性名 説明 必須 デフォルト値 className KibanaDefaultReverseProxyHandler を実装したクラスを設定します。 × jp.co.intra_mart.foundation.kibana.proxy.KibanaProxyHandler