6 プロパティ
cfg
サブディレクトリに格納されるプロパティ・ファイルについて説明します。これらのファイルには、監視プロセスを制御する設定が格納されます。ソフトウェアのリリースに基づいて事前設定されているプロパティ値と、ユーザーの入力内容に基づいてインストーラによって設定されるプロパティ値があります。この章の内容は次のとおりです。
6.1 Monitorサーバーのプロパティ
monitor.properties
ファイルには、Oracle GoldenGate Monitorの処理に関する特性が記述されます。これには、JMXサーバーとの関係、および接続試行のタイミングを定義するプロパティが含まれています。これらのプロパティ値の多くは、ユーザーの入力内容に基づいてインストール中に初期設定されます。
ノート:
プロパティ値を変更したら、Monitorサーバーを再起動してアクティブ化する必要があります。
6.1.1 制限付きプロパティ
特定のOracle GoldenGate Monitorのプロパティは、変更するとシステム障害が発生する場合があります。これらのプロパティは、制限付きと指定されています。制限付きプロパティに事前設定されている値は変更しないでください。
制限付きプロパティには、次のものがあります。
monitor.jmx.internal.mbeans.enabled monitor.supported.agent.metadata.versioneclipselink.target-database eclipselink.weaving eclipselink.ddl-generation
6.1.2 SSO Webパラメータ
SSO WebパラメータではSSO (シングル・サインオン)ログアウトURLを指定します。Oracle GoldenGate MonitorにSSO環境でアクセスする場合は、monitor.ssoLogOutUrl
を使用してアプリケーションのログアウトURLを設定します。OAM (Oracle Access Manager)の後続のバージョンでログアウトURLの形式が変更された場合は、このプロパティを適切に変更する必要があります。ただし、その場合にサーバーの再起動は必要ありません。
構文は次のとおりです。
monitor.ssoLogOutUrl=/oamsso/logout.html?end_url=/monitor
6.1.3 JMXサーバーのプロパティ
これらのプロパティは、JMXサーバーを有効にし、ユーザー名を識別して、JMXサーバー・ホストの名前とポートを登録します。
6.1.3.1 monitor.jmx.server.enabled
monitor.jmx.server.enabled
では、JMXサーバーを有効化または無効化します。JagentをOracle GoldenGate Monitorサーバーに登録するには、JMXサーバーが有効化されている必要があります。エージェントが登録されるよう、値はtrue
に初期設定されています。
デフォルト
true
構文
monitor.jmx.server.enabled={true | false}
6.1.3.2 monitor.jmx.server.port
monitor.jmx.server.port
では、JMXサーバーのポート番号を指定します。この値は、ユーザーの入力内容に基づいてインストーラによって初期設定されます。これは、エージェントのConfig.properties
ファイル内のmonitor.jmx.port
エントリと一致している必要があります。
構文
monitor.jmx.server.port=port_number
例
monitor.jmx.server.port=5502
6.1.3.3 monitor.jmx.server.host
monitor.jmx.server.host property
を使用すると、Oracle GoldenGate Monitorインストールのコンピュータ名を指定できます。
構文
monitor.jmx.server.host property
を、Oracle GoldenGate Monitorインストールのサーバーの完全修飾ホスト名に設定します。これは、エージェントのConfig.properties
ファイル内のmonitor.host
エントリと一致している必要があります。この値は、ユーザーの入力内容に基づいてインストーラによって初期設定されます。
monitor.jmx.server.host=host_name
6.1.4 通信
通信でSSLを使用するかどうかを選択する必要があります。SSLを使用する場合は、キーおよび資格証明の記憶域を指定する必要があります。
6.1.4.1 monitor.ssl
monitor.ssl
では、Oracle GoldenGate Monitorからの通信でSSLを使用するかどうかを指定します。
ノート:
Oracle GoldenGate Monitorサーバーのmonitor.ssl
設定は、そのサーバーと通信するすべてのエージェントのConfiguration.properties
ファイル内のjagent.ssl
プロパティ設定と一致している必要があります。
デフォルト
false
構文
monitor.ssl=[true | false]
6.1.4.2 monitor.keystore.file
monitor.keystore.file
では、SSL認証に使用されるキーのペアと証明書を格納するファイルを指定します。
デフォルト
monitorKeyStore
構文
monitor.keystore.file=keystore_filename
6.1.5 接続のプロパティ
これらのプロパティは、接続の特性を定義します。これらは変更できますが、まずOracle Supportサポートに問い合せることをお薦めします。詳細はhttp://support.oracle.com
にアクセスしてください。
6.1.5.4 monitor.web.rendering_interval
monitor.web.rendering_interval
プロパティは、間隔レンダラ(秒単位)に使用されます。間隔レンダラを無効にするには0
に設定します。
デフォルト
15秒
構文
monitor.web.rendering_interval=no_of_seconds
6.1.5.5 eclipselink.ddl-generation
管理者がサーバー・インストールを新しいデータベースに指定しなおす必要がある場合に、サーバーの再起動時にデータベース・オブジェクトを再作成するには、eclipselink.ddl-generation
プロパティを使用します。
構文
eclipselink.ddl-generation=create-tables
6.1.5.6 eclipselink.target-database
eclipselink.target-database
プロパティを使用すると、eclipselinkへのポインタを指定してターゲット・データベースに応じて適切な言語を使用できます。
デフォルト
このプロパティにより、eclipselinkの通信先となるデータベースが明確に示されます。
構文
eclipselink.target-database=org.eclipse.persistence.platform.database.OraclePlatform
.SQL Serverの場合、構文はeclipselink.target-database=org.eclipse.persistence.platform.database.SQLServerPlatform
となります。
6.1.6 構成管理のプロパティ
これらのプロパティでは、タイムアウト値と、処理をトリガーするイベント数のしきい値を設定します。
6.1.6.4 monitor.max.mpevent.before.refresh
monitor.max.mpevent.before.refresh
では、ユーザー・インタフェースのリフレッシュ・レートを変更します。monitor.max.mpevent.before.refresh=default
は、リフレッシュ・レートの遅延なしを意味します。この値は、ユーザー・インタフェースがリフレッシュする前に到達する必要があるイベントの数を示します。
構文
monitor.max.mpevent.before.refresh=number_of_events
ノート:
このプロパティは、Oracle GoldenGate Monitor 12.2.1.2.181115+バンドル・パッチにのみ適用できます。ノート:
300プロセスを監視するには、この値を100に設定することをお薦めします。6.1.6.5 monitor.refresh.landing.page
monitor.refresh.landing.page
では、インスタンスのProcess Metricsタブ・ページおよびプロセスのMetricsタブ・ページで、秒に基づいた自動リフレッシュを実行します。
構文
monitor.refresh.landing.page=default
monitor.refresh.landing.page=default
は、Process MetricsおよびMetricsタブの自動リフレッシュなしを意味します。
ノート:
このプロパティは、Oracle GoldenGate Monitor 12.2.1.2.181115+バンドル・パッチにのみ適用できます。6.1.6.6 monitor.disable.solution
monitor.disable.solution
を使用して、ソリューション関数の有効/無効を切り替えます。このプロパティをtrue
に設定すると、ソリューション関数は動作を停止し、「Solutions」サブメニューがUIから消えます。
構文
monitor.disable.solution=true
6.1.6.7 monitor.landing.page.treeview
monitor.landing.page.treeview
では、Oracle GoldenGate Monitor UIでツリー構造ナビゲーションの表示レイアウトを構成します。値default
は、各ツリー・ノードを展開します。値level-1
は、ノード拡張を最初のレベル(「Hosts/Solutions/Views」アイコン)で停止させます。
構文
monitor.landing.page.treeview=default
6.1.6.8 monitor.debug.backendqueue.interval
monitor.debug.backendqueue.interval
では、モニター・キュー操作の様々なメトリックを取得するためにデバッグ・スレッドが待機する時間間隔を指定します。時間単位は秒です。デフォルト値0は、デバッグ・スレッドを無効にします。正の数値は、デバッグ・スレッドを有効にし、定義済の値として定期的に実行します。負の数値は、同様にデバッグ・スレッドを無効にします。監視対象のメトリック情報は監視ログに記録されます。
構文
monitor.debug.backendqueue.interval=<time in seconds>
デフォルト
06.2 エージェントのプロパティ
一部のプロパティには、プロパティ・ファイルにプロパティの値が定義されていない場合に使用されるデフォルト値が含まれています。デフォルト値は無効なエントリには置き換えられません。デフォルト値が使用される場合、メッセージがjagent.log
およびggserr.log
に書き込まれます。
Config.properties
ファイルでは、Oracle GoldenGate MonitorサーバーまたはOracle Enterprise Manager (Oracle GoldenGateリリース11.2.1以降)と通信できるようにOracle GoldenGate Monitorエージェントが構成されます。これには、Oracle GoldenGateコア・インストールで提供される事前設定済プロパティが含まれています。ホスト・サーバー名、ポート、ユーザーなどの値を、使用しているシステムに有効な値にリセットする必要があります。
ノート:
プロパティ値を変更したら、エージェントを再起動してアクティブ化する必要があります。
6.2.1 エージェントの定義
Oracle GoldenGateインスタンスの監視に使用するエージェントのタイプを設定する必要があります。
6.2.1.1 jmx.broker.port
リモートでのJMXサーバーの監視にはjmx.broker.port
パラメータを使用します。これは、jmx.enable.remote.monitoring
がtrue
の場合にのみ適用可能です。jAgentでは、リモートでのJMXの監視のために内部でブローカ・ポートが使用されます。
jmx.broker.port
とjagnet.jmx.port
(OGGMON
モード)の両方、またはjagent.rmi.port
(OEM
モード)を許可する必要があります。これには、有効な任意のオープン・ポート値を使用できます。プロパティjmx.enable.remote.monitoring
の値がtrue
であり、jmx.broker.port
が指定されていないかその値がdefault
として指定されている場合は、jagent.jmx.port
(OGGMON
モード)またはjagent.rmi.port
(OEM
モード)がjmx.broker.port
として使用されます。
デフォルト
default
構文
jmx.broker.port=port_number
例
jmx.broker.port=default jmx.broker.port=12345
6.2.1.2 jmx.enable.remote.monitoring
jmx.enable.remote.monitoring
は、jAgent JMXサーバーのリモート監視を有効にするために使用されます。この値がfalse
である場合は、jAgent JMXサーバーへのリモート接続は許可されません。
デフォルト
true
構文
jmx.enable.remote.monitoring=true
6.2.1.3 jagent.restful.ws.timeout
jagent.restful.ws.timeout
では、Jagent RESTful Webサービスのタイムアウトをミリ秒単位で設定します。
デフォルト
15000
構文
jagent.restful.ws.timeout=number
6.2.1.4 jagent.ggsci.timeout
jagent.ggsci.timeout
では、Jagent GGSCIのタイムアウトを秒単位で設定します。
デフォルト
30
構文
jagent.ggsci.timeout=number
6.2.1.5 continuous.alerts
停止中のプロセスに対してアラートの条件が設定されている場合は、このプロセスが停止するとアラートがトリガーされます。デフォルトでは、アラート抑止時間が経過した場合でも、そのプロセスが停止したままであれば、それ以上アラートはトリガーされません。抑止間隔ごとに連続的にアラートを受信する必要がある場合は、continuous.alerts
パラメータをtrue
に設定します。
構文
continuous.alerts=true
6.2.1.6 jagent.large.deployment.threshold
jagent.large.deployment.threshold
の値により、エージェントが監視しているOracle GoldenGateプロセスを大規模デプロイメントであるとみなすしきい値を定義します。プロセスの数がそのしきい値以上になると、jAgentが自動的に大規模デプロイメント・モードに切り替わります。
大規模デプロイメント・モードのjAgentでは、1つの監視オブジェクトのみが作成されるという以前の動作とは異なり、すべての監視オブジェクトが1つのバッチとして作成されます。これにより、サーバーとエージェントの間のコールが減少し、バッチ処理の効率が向上します。
構文
jagent.large.deployment.threshold=Number_of_processes
デフォルト
10
例
jagent.large.deployment.threshold=5
6.2.1.7 agent.type.enabled
agent.type.enabled
では、監視をOracle GoldenGate MonitorとOracle Enterprise Managerのどちらで行うかを指定します。
Oracle GoldenGate Monitorエージェントは、構成可能な間隔でManagerをポーリングして、監視ポイント・データを収集します。
-
agent.type.enabled
をOGGMON
に設定すると、Oracle GoldenGateエージェントはOracle GoldenGate Monitorサーバーにデータを送信します。 -
agent.type.enabled
をOEM
に設定すると、Oracle GoldenGateエージェントは、Oracle Enterprise ManagerエージェントまたはODIによってポーリングされたときに監視ポイント・データを提供します。
この設定は、Oracle Data Integratorとの統合時にも必要です。GoldenGate MonitorとOracle Data Integrationを同時に使用している場合は、2つのエージェントを設定する必要があります。1つはagent.type.enabled
をOracle GoldenGate Monitorに設定し、もう1つはOEMに設定します。
agent.type.enabled
がOEM
に設定されている場合、Oracle Enterprise ManagerエージェントはRemote Method Invocation (RMI)コネクタ経由でOracle GoldenGate Monitorエージェントに接続するため、jagent.rmi.port
と入力する必要があります。
ノート:
このプロパティは、Oracle GoldenGateのリリース11.2.1以降で有効です。
構文
agent.type.enabled={OGGMON | OEM}
6.2.2 通信
通信でSecure Sockets Layer (SSL)を使用するかどうかを選択する必要があります。SSLを使用する場合は、キーおよび資格証明の記憶域を指定する必要があります。
ノート:
IBM z/OS上で実行されているOracle GoldenGate Monitorエージェントで使用できるのはSSLのみです。また、GoldenGate Monitorサーバーと通信しているすべてのエージェントは同じ接続プロトコルを使用する必要があります。
6.2.2.1 jagent.ssl
jagent.ssl
では、エージェントからの通信でSSLを使用するかどうかを指定します。
ノート:
jagent.backward.compatility
プロパティがtrue
に設定されている場合、Oracle GoldenGate Monitorは、SSLが有効でないと判断し、jagent.ssl
の設定を無視します。
ノート:
Oracle GoldenGate Monitorサーバーと通信するすべてのエージェントのjagent.ssl
設定は、monitor.properties
ファイルのmonitor.ssl
プロパティのサーバーの設定と一致する必要があります。
デフォルト
false
構文
jagent.ssl=[true | false]
6.2.2.2 jagent.keystore.file
jgent.keystore.file
では、SSL認証に使用されるキーのペアと証明書を格納するファイルを指定します。
デフォルト
jagentKeyStore
構文
jagent.keystore.file=keystore_filename
6.2.3 ターゲットの監視
Oracle GoldenGate Managerおよびエージェントが常駐するコンピュータの名前とポートを指定する必要があります。下位互換性を設定し、エージェント資格証明を定義する必要もあります。
6.2.3.1 jagent.host
jagent.host
では、Oracle GoldenGate Monitorエージェントが実行されているコンピュータのホスト名を指定します。これは、監視対象のOracle GoldenGateインスタンスのホスト名で、Oracle GoldenGate Monitorインスタンスに接続するリモートGoldenGate Extractプロセスによって、RMTHOST
パラメータで使用されるのと同じ名前にする必要があります。これにより、ソリューション検出が適切に動作します。
このプロパティは必須です。有効な値が入力されていない場合は、起動の間にManagerによってggserr.log
にエラーが書き込まれ、エージェントが正常に初期化されません。
構文
jagent.host=ogg_host_name
ノート:
RMTTRAIL
を使用して、Extractパラメータ・ファイルでリモート証跡が指定されている場合、RMTHOST
パラメータに指定したホスト名は、Java jagent.host
エントリに設定されている値に一致する必要があります。Oracle GoldenGate Monitorエージェントを実行するローカルのOracle GoldenGate MonitorインスタンスにリモートExtractを接続している場合、パラメータ・ファイルに指定した完全修飾のホスト名は、jagent.host
に使用される完全修飾名と同じにする必要があります。
6.2.3.2 jagent.jmx.port
jagent.jmx.port
では、エージェントのJMXポートを指定します。
デフォルト
5555
構文
jagent.jmx.port=port_number
6.2.3.3 mgr.host
mgr.host
では、Oracle GoldenGate Managerが実行されているコンピュータの名前またはIPアドレスを指定します。mgr.host
およびmgr.port
は、ともにOracle GoldenGate MonitorエージェントにOracle GoldenGateインスタンスを指定します。
このプロパティが入力されていないと、エージェントがOracle GoldenGateインスタンスに対してローカルであると判断され、デフォルトで値が決定されます。
ノート:
エージェントはOracle GoldenGateインスタンスに対してローカルである必要があるため、このプロパティは11.2.1以前のリリースには使用されません。
構文
mgr.host=ogg_host_name
6.2.3.4 mgr.port
mgr.port
プロパティを変更したときは必ずjagent.jmx.port
プロパティも変更してそれをMonitorサーバーに登録し、正しい結果が表示されるようにする必要があります。
mgr.port
では、Oracle GoldenGate Managerのポートを指定します。このプロパティが入力されていないと、エージェントがOracle GoldenGateインスタンスに対してローカルであると判断され、デフォルトで値が決定されます。
ノート:
エージェントはOracle GoldenGateインスタンスに対してローカルである必要があるため、このプロパティは11.2.1以前のリリースには使用されません。
構文
mgr.port=manager_port
6.2.3.5 monitor.host
monitor.host
では、Oracle GoldenGate Monitorサーバー・インストールのホスト・コンピュータ名を指定します。完全修飾のホスト名を使用します。これは、monitor.properties
ファイルのmonitor.jmx.server.host
のエントリに一致する必要があります。
このプロパティは必須です。有効値が入力されていないと、起動中にManagerがエラーをggserr.log
に書き込み、エージェントが正常に初期化されません。
構文
monitor.host=monitor_host_name
6.2.3.6 monitor.jmx.port
monitor.jmx.port
では、Oracle GoldenGate Monitorサーバー・インストールのJMXポートを指定します。これは、Oracle GoldenGate Monitorサーバーのインストール中に、「JMX Server Configuration」画面でポートに入力した値に初期設定されます。これは、monitor.propertiesファイル内のmonitor.jmx.server.port
エントリと一致している必要があります。
デフォルト
5502
構文
monitor.jmx.port=port_number
6.2.3.7 monitor.jmx.username
monitor.jmx.username
プロパティは、monitor.properties
ファイル内のmonitor.jmx.server.user
エントリと一致している必要があります。
monitor.jmx.username
では、Oracle GoldenGate MonitorサーバーのJMX接続のユーザー名を指定します。これは、Oracle GoldenGate Monitorのインストール中に、「JMX Server Configuration」画面でユーザー名に入力した値に初期設定されます。
このプロパティは必須です。有効値が入力されていないと、起動中にManagerがエラーをggserr.log
に書き込み、エージェントが正常に初期化されません。
構文
monitor.jmx.username=user_name
6.2.3.9 jagent.backward.compatibility
jagent.backward.compatibility
をtrue
に設定し、Oracle GoldenGate 11.1.1.1.1インスタンスの監視を可能にする下位互換性を有効にします。この値はfalse
に初期設定されています
。
ノート:
このプロパティは、agent.type.enabled=OGGMON
の場合にのみ適用されます。agent.type.enabled=OEM
の場合は無視されます。
jagent.backward.compatibility
は、IBM z/OSを除く、サポートされているすべてのプラットフォームで有効です。
jagent.backward.compatibility
がtrue
に設定されている場合、Oracle GoldenGate Monitorは、SSLが有効でないと判断し、jagent.ssl
が無視されます。
構文
jagent.backward.compatibility={true | false}
6.2.4 ポーリングのプロパティ
ポーリング間隔を設定できます。何も入力されない場合、これらのポーリング間隔プロパティは、指定されたデフォルトの秒数に設定されます。入力された秒数が負の値または2147483647よりも大きい場合には、エラー・メッセージが生成されます。
6.2.4.1 interval.quick
interval.quick
では、Quick Default Polling Group
に、監視ポイントに使用するポーリング間隔を指定します。値は秒単位です。
デフォルト
30秒
構文
interval.quick=seconds
6.2.4.3 instance.query.initial.interval
instance.query.initial.interval
では、Managerのみが実行中のプロセスである場合、Jagentが登録されるまで待機する間隔を指定します。この間隔の後でも他のプロセスが存在しない場合、エージェントにより登録が処理されます。
デフォルト
5秒
構文
instance.query.initial.interval=seconds
6.2.4.4 incremental.registration.quiet.interval
incremental.registration.quiet.interval
では、エージェントが新しいプロセスの登録まで待機する間隔を指定します。
デフォルト
5秒
構文
incremental.registration.quiet.interval=seconds
6.2.4.5 maximum.message.retrieval
maximum.message.retrieval
プロパティを使用して、開始時にコアのOracle GoldenGateインスタンスから取得される最大メッセージ数を指定します。
この数値をゼロまたは負の数値に設定すると、エージェントのメッセージ取得機能が無効になり、メッセージ監視が不要な場合にパフォーマンスを向上させることができます。
デフォルト
500メッセージ
構文
maximum.message.retrieval=number