CSA: Clarity PPM の保守と監視

ccppmop1561
サービスの開始と停止、サーバ ポートのオープン、IGMP スヌーピングの無効化、ヘルス レポートの実行、ログ ファイルの確認、
Clarity PPM
インストールのバックアップと復元、Oracle データベース オブジェクトのコンパイル、ファイル ディレクトリ サイズの設定、GEL タグの制約の設定を行います。
2
サービスの開始と停止
以下の手順に従います。
  1. CSA にログインします。
  2. [ホーム]-[すべてのサービス]をクリックします。
  3. 開始または停止する各サービスの隣にあるチェック ボックスをオンにします。
  4. サービスを開始するには、[開始]をクリックします。
  5. サービスを停止するには、[停止]をクリックします。
サーバ ポートのオープン
Clarity PPM
では、クライアント対サーバおよびサーバ対サーバの通信用に複数の開いているネットワーク ポートが必要です。 多くの場合、セキュリティ上の理由で、ポートが既定で閉じられているか、またはファイアウォールによってブロックされています。 インストールまたは設定時に、選択したすべてのポートを開く必要があります。
オペレーティング システムまたはファイアウォール用に提供されているドキュメントを参照して、必要なポートを開いてください。 以下の情報は、
Clarity PPM
で使用される各ポートの既定値、タイプ、および説明を示しています。
UNIX システムでは、1024 未満のポート番号は通常、root ユーザ向けに予約されています。
ベスト プラクティス
: ソフトウェア ファイアウォールを使用している場合は、ポート レベルではなく実行可能レベルで例外を設定します。 この操作によって、割り当てられている動的ポートを正式なマルチキャスト通信用として確実に開くことができます。 詳細については、以下のリストの「エフェメラル ポート
」を参照してください。
  • 80 または 443
    既定の
    Clarity PPM
    アプリケーション(app)サービスで使用される HTTP または HTTPS ポート番号を定義します。
    タイプ:
    クライアント対
    Clarity PPM
    アプリケーション サーバ
  • 8090
    (Apache Tomcat アプリケーション サーバのみ) CSA で使用される HTTP ポート番号を定義します。
    タイプ
    : クライアント対
    Clarity PPM
    アプリケーション サーバ
  • 1433 (MS-SQL)または 1521 (Oracle)
    データベースとの通信に使用される JDBC ポート番号を定義します。
    タイプ:
    サーバ対データベース サーバ
  • 23791
    (Apache Tomcat アプリケーション サーバのみ)
    Clarity PPM
    アプリケーション(app)サービスで使用される RMI ポート番号を定義します。
    タイプ:
    サーバ対
    Clarity PPM
    アプリケーション サーバ
  • 23792
    (Apache Tomcat アプリケーション サーバのみ) CSA で使用される RMI ポート番号を定義します。
    タイプ:
    サーバ対
    Clarity PPM
    アプリケーション サーバ
  • 9090
    CSA で使用されるマルチキャスト ポート番号を定義します。
    タイプ:
    サーバ対
    Clarity PPM
    アプリケーション サーバ
  • 9091
    Beacon サービスで使用される RMI ポート番号を定義します。
    タイプ
    : サーバ対サーバ
  • エフェメラル ポート
    エフェメラル(一時的)ポートの範囲を定義します。 いずれのオペレーティング システムでも、既定でエフェメラル ポートの範囲が指定されています。 IANA では 49152 ~ 65535 を提案していますが、従来の BSD の範囲は 1024 ~ 4999 です。 この範囲はオペレーティング システムに応じて異なり、無効にすることができます。
    Clarity PPM
    では、任意の範囲の値を使用することができます。 ただし、範囲を有効にする必要があります。 このポートは主に、マルチキャスティングを機能させるために必要です。
    タイプ:
    サーバ対サーバ
IGMP スヌーピング
Cisco Catalyst Ethernet スイッチを使用してマルチキャスト トラフィックを適切に配信するには、
Clarity PPM
サーバが属している VLAN で IGMP スヌーピングを無効化します(または、IGMP スヌーピングと IGMP クエリアの両方を有効化します)。 以前は、IP マルチキャストは、IP ブロードキャストとほぼ同様に処理され、イーサネット スイッチは、すべてのインターフェースにマルチキャスト トラフィックを流し込んでいました。 既定では、Cisco Catalyst スイッチでは逆の方法を使用し、すべてのインターフェースにマルチキャスト トラフィックを流入させません。
IGMP スヌーピングにより、レイヤ 2 スイッチは、各フレーム レイヤ 3 IP ヘッダのコンテンツを検査して、インテリジェントなマルチキャスト転送を決定できます。 スイッチはマルチキャスト グループのリストを保持しているため、特定のグループに属するインターフェースにのみマルチキャスト パケットを配信できます。
ヘルス レポートの実行
リリース 15.3 では、レガシー CSA ヘルス レポートのタブ、ボタン、およびオプションは削除されました。 「ヘルス レポートの実行」を参照してください。
ログ ファイルの確認
インストール、アップグレード、または使用に関する問題が発生した場合は、ログ ファイルを参照して問題の説明を発見し、問題を解決します。 既定では、
Clarity PPM
は、ログ ファイルにエラー メッセージのみを書き込みます。 CA テクニカル サポートが問題解決を支援している場合、詳細なデバッグ メッセージを表示するようにシステムを設定するよう求められることがあります。 既定では、ログ ファイルは、
Clarity PPM
ホーム ディレクトリの下の logs ディレクトリに格納されます。 各サーバには固有のログ ディレクトリがあります。 CSA で別のログ ディレクトリを選択することもできます。
テキスト エディタを使用して、ログ ファイルを表示できます。
Clarity PPM
サーバのクラスタがある場合、各サーバのログ ファイルはそのサーバにのみ適用されます。 ログを設定して、さらに詳細を追加したり、エントリを更新または削除したりすることができます。 ログ ファイルの設定変更は直ちに有効にすることができます。 それ以外の場合は、
Clarity PPM
アプリケーション(app)サービスと
Clarity PPM
バックグラウンド(bg)サービスを再起動して、変更を有効にする必要があります。
以下の表に、既定値および一般的なログ ファイルのリストを示します。 各ログ ファイルのファイル名、形式、および内容が一覧表示されています。
サービスのクローン作成された各インスタンスには、独自のログ ファイルがあります。 たとえば、app2、bg3 など、id で表されるログ ファイルのセットがあります。 初期の app および bg インスタンスには、id はありません。
ログ ファイル名
Format
コンテンツ
admin.log
プレーン テキスト
管理アクティビティのレコードです。 これらのアクティビティは、
admin
コマンドまたは同等の CSA 操作によって実行されます。
app{id}-access-{date}.log
プレーン テキスト
フォアグラウンド サービスのセッション アクティビティ(http/s 要求)です。
app{id}-bootstrap-ca.log
プレーン テキスト
ODF ブートストラップ アクティビティです。これは通常、アップグレードおよびパッチ操作中に発生します。
app{id}-ca.log
プレーン テキスト
フォアグラウンド サービスのすべてのアクティビティ用のプライマリ ログです。
app{id}-dwh.log
プレーン テキスト
フォアグラウンド サービスのデータ ウェアハウス固有のアクティビティです。
app{id}-process-engine.log
プレーン テキスト
フォアグラウンド サービスのプロセス エンジン モニタによって記録されるイベントです。
app{id}-system.log
プレーン テキスト
フォアグラウンド サービスのコンソール(STDOUT)に直接書き込まれるシステム レベルの出力です。 この出力は通常、サービス スタートアップ メッセージまたは OS メッセージです。
beacon-system.log
プレーン テキスト
beacon サービスのコンソール(STDOUT)に直接書き込まれるシステム レベルの出力です。 この出力は通常、サービス スタートアップ メッセージまたは OS メッセージです。
bg{id}-bootstrap-ca.log
このファイルは自動的に生成されますが、通常は空です。
bg{id}-ca.log
プレーン テキスト
バックグラウンド サービスからのすべてのアクティビティ用のプライマリ ログです。
bg{id}-dwh.log
プレーン テキスト
バックグラウンド サービスのデータ ウェアハウス固有のアクティビティです。
bg{id}-process-engine.log
プレーン テキスト
バックグラウンド サービスのプロセス エンジン モニタによって記録されるイベントです。
bg{id}-system.log
プレーン テキスト
バックグラウンド サービスのコンソール(STDOUT)に直接書き込まれるシステム レベルの出力です。 この出力は通常、サービス スタートアップ メッセージまたは OS メッセージです。
completion.log
プロパティ
各コンポーネントの完了したインストールまたはアップグレード手順のレコードです。 CA サポートから指示があった場合のみ、このログを変更してください。
dbtools-bootstrap-ca.log
このファイルは自動的に生成されますが、通常は空です。
dbtools-ca.log
プレーン テキスト
DBTools からのアクティビティです。 DBTools は、アップグレードまたはパッチ処理中にデータベースのエンティティとデータを変更するツールです。
dbtools-dwh.log
このファイルは自動的に生成されますが、通常は空です。
dbtools-process-engine.log
このファイルは自動的に生成されますが、通常は空です。
nsa-access-{date}.log
プレーン テキスト
システム管理サービスのセッション アクティビティ(http/s 要求)です。
nsa-bootstrap-ca.log
このファイルは自動的に生成されますが、通常は空です。
nsa-ca.log
プレーン テキスト
システム管理サービスからのすべてのアクティビティ用のプライマリ ログです。
nsa-dwh.log
このファイルは自動的に生成されますが、通常は空です。
nsa-process-engine.log
このファイルは自動的に生成されますが、通常は空です。
nsa-system.log
プレーン テキスト
システム管理サービスのコンソール(STDOUT)に直接書き込まれるシステム レベルの出力です。 この出力は通常、サービス スタートアップ メッセージまたは OS メッセージです。
odf-bootstrap-bootstrap-ca.log
このファイルは自動的に生成されますが、通常は空です。
odf-bootstrap-ca.log
このファイルは自動的に生成されますが、通常は空です。
odf-bootstrap-dwh.log
このファイルは自動的に生成されますが、通常は空です。
odf-bootstrap-process-engine.log
このファイルは自動的に生成されますが、通常は空です。
upgrade-bootstrap-ca.log
このファイルは自動的に生成されますが、通常は空です。
upgrade-ca.log
プレーン テキスト
アップグレード プロセス中に実行される個々の
Clarity PPM
アップグレード スクリプトからのメッセージです。
update-dwh.log
このファイルは自動的に生成されますが、通常は空です。
upgrade-process-engine.log
このファイルは自動的に生成されますが、通常は空です。
xogAdmin-bootstrap-ca.log
このファイルは自動的に生成されますが、通常は空です。
xogAdmin-ca.log
プレーン テキスト
XOG 管理クライアントからのアクティビティです。 XOG 管理クライアントは、アップグレードまたはパッチ処理中にデータを挿入または変更するツールです。
xogAdmin-dwh.log
このファイルは自動的に生成されますが、通常は空です。
xogAdmin-process-engine.log
このファイルは自動的に生成されますが、通常は空です。
ロガー設定の編集
プライマリ ログ ファイルは、
ca
ログ ファイルです。 製品が記録する情報のほとんどは、これらのファイルのいずれかに書き込まれます。 この情報には、システム エラーや、デバッグ メッセージなどの情報メッセージも含まれます。 ca ログ ファイルにどのログ メッセージを入れるかを設定することができます。
2 つの重要なログ メッセージ属性を以下に示します。
  • カテゴリ
    ログ記録されたメッセージが生成された製品内の場所を示します。
  • レベル
    メッセージの重大度を示します。
ロガー設定を調節し、カテゴリとレベルに基づいてログ メッセージをフィルタすることができます。 com.ca カテゴリに該当する、エラー以上(深刻)のレベルのメッセージがすべてレポートされます。 問題をトラブルシューティングする際は、別のカテゴリに情報を追加したり、デバッグ レベルを追加して詳細情報を取得したりすることができます。
複数の
Clarity PPM
バックグラウンド(bg)サービスを実行しており、
Clarity PPM
バックグラウンド(bg)サービスの問題のトラブルシューティングを行うためにデバッグを有効にする場合は、1 つのサービスをデバッグ用に設定して、他のサービスをすべて停止すると便利です。 この方法によって、すべてのジョブまたはプロセスがこの
Clarity PPM
バックグラウンド(bg)サービスを通過し、必要なデバッグ メッセージが生成されます。
Clarity PPM
バックグラウンド(bg)サービスを再起動して変更を有効にし、ログ ファイル(bg-ca.log)を確認します。
以下の手順に従います。
  1. CSA にログインします。
  2. [ホーム]-[サーバ]をクリックします。
  3. ログ情報を編集するには、サーバの[プロパティ]アイコンをクリックします。
  4. [Logs]タブをクリックします。
  5. [設定の編集]サブタブをクリックします。
  6. [プロパティ]セクションで、以下のフィールドを指定します。
    • ログ構成の変更を自動検出
      ログ設定の変更を直ちに有効にするかどうかを指定します。 行った変更を直ちに有効にするには、このチェック ボックスをオンにします。 このオプションは、Apache Tomcat で実行されている
      Clarity PPM
      バックグラウンド(bg)サービスと
      Clarity PPM
      アプリケーション(app)サービスに適用されます。
      このオプションを選択する場合は、変更が有効になるように、影響を受けるすべてのサービスを再起動してください。
    • 代替ログ ディレクトリ
      このサーバ用の代替ログ ディレクトリを定義します。 このパスは、サーバ上のディレクトリへの有効な絶対パスである必要があります。 例: /niku//logs(UNIX)、または E:\logs (Windows)。
    • 既定のトレースしきい値(秒)
      特定のリクエストのトレース情報を書き込む、基本的なしきい値を指定します。 この値は logger.xml カテゴリ レベルを上書きします。
  7. [システム ログの記録]セクションで、以下のフィールドに値を入力します。
    • システム ログの最大数 (1 サービスあたり)
      各サービスで保持するシステム ログ ファイルの数を示します。 この値を変更するには、サービスを再起動する必要があります。 既定値は 5 です。
    • 各システム ログの最大サイズ
      各サービスに対するログ ファイルのサイズをメガバイトで指定します。 この値を変更するには、サービスを再起動する必要があります。 既定値は 5 MB です。
  8. [Kettle ログ記録]セクションで、以下のフィールドに値を入力します。
    • Kettle ログ レベル
      ロード データ ウェアハウスおよびロード データ ウェアハウス アクセス権のジョブが実行されているときに参照するログ アクティビティのレベルを示します。 ログ データは、CSA のデータ ウェアハウス ログに格納されます。
      : なし、エラー、最小、基本、詳細、または行レベル。
  9. [プロセス エンジンの持続性ログ]セクションで、以下のフィールドに値を入力します。
    • プロセス エンジンの持続性ログ レベル
      プロセス GEL スクリプトに <gel:log> タグを含めた場合に表示されるログ アクティビティのレベルを示します。 以下の値から選択して、[ホーム]-[オーガナイザ]-[開始したプロセス]ページに表示するメッセージのタイプを設定します。
      • エラー。 デフォルト値は、<gel:log level=ERROR> があるメッセージのみが UI にメッセージとして表示されることを示します。 この設定では、BPM_ERRORS テーブルのサイズを小さいまま保持することをお勧めします。
      • 警告。 値は、<gel:log level=ERROR> または <gel:log level=WARN> があるメッセージが UI にメッセージとして表示されることを示します。
      • 情報。 値は、ログ レベルのないものも含めて、すべてのメッセージが UI にメッセージとして表示されることを示します。
  10. [トレースしきい値]セクションで、[しきい値の追加]をクリックし、以下のフィールドに入力します。
    • しきい値(秒)
      アクション パターンによって識別されたアクションをトレースするまでの秒数を指定します。 値 -1 は、特定のアクションに対してしきい値が設定されていないことを意味します。 この値は、長期的アクションに対してしきい値を無効にする場合に役立ちます。
    • パターン
      しきい値を超過したときにトレースするアクションを識別します。 カンマ区切り形式でパターンを入力します。 例:webRequest/npt.overview, xogRequest/XOG::project::read, or serviceRequest/*。
  11. [カテゴリ]セクションで、以下のフィールドに入力します。
    • 名前/別名
      追加または変更用のカテゴリを定義します。 ドロップダウンから選択してください。 このリストに表示されていないカテゴリを有効にするには、[別名]テキスト フィールドにカテゴリを入力します。
    • Appender
      ログ出力を別の宛先に向けます。 あるカテゴリを個別のファイルに振り分けるには、一意のファイル名を持つ STDOUT アペンダを追加し、カテゴリを新しいアペンダに関連付けます。
    • 優先度
      デバッグ レベルを定義します。 レベルが高いほど、優先度が高くなります。
      値:
      • 深刻。 重要なサービスが実行していないことを示します。
      • エラー。 システムの機能が制限される可能性のある問題を示します。
      • 警告。
        Clarity PPM
        で問題が検出されたが、実行が続行されることを示します。
      • 情報。 システムの状態(サービスの開始など)を示すもので、問題を示しているとは限りません。
      • デバッグ ユーザまたは CA テクニカル サポートが問題を解決できるように、詳細情報を表示します。
      • トレース。 低レベルの技術情報が表示されます。 このレベルでは、大量のデータが生成されます。 CA テクニカル サポートから要求された場合にのみ、この値を使用してください。
      • すべて。 すべてのメッセージを表示します。
    • 追加
      新しいメッセージをログに追加するかどうかを指定します。 メッセージを追加するには、このチェック ボックスをオンにします。 このチェック ボックスをオフにすると、ログに新しい情報が上書きされることがあります。
  12. 変更を保存します。
  13. 影響を受けるサービスを再起動します。
ログ記録は、特にデバッグやトレースなどの高い優先度を使用すると、システム パフォーマンスに悪影響を与える可能性があります。 必要な場合、または CA テクニカル サポートから指示があった場合にのみ、追加のログ記録を有効にします。 不要になったらすぐに、追加のログ記録を無効にしてください。
ユーザ固有のログ記録
特定のユーザに対し、一部のログ カテゴリを有効にすることができます。 特定のユーザのログ記録を有効にするには、標準的なログ記録のカテゴリの最後にユーザ名を追加します。 たとえば、
trace.server.user.jsmith
の場合、ユーザ jsmith のサーバ側パフォーマンスのログ記録が有効になります。 ユーザ キーワードは、最後のカテゴリ セグメントがユーザ名であることを示します。 ユーザ名は、カテゴリでのイベントのログ記録のフィルタとして使用されます。 この場合は、trace.server カテゴリです。 特定のユーザに対する SQL ログ記録設定を変更すると、ユーザがログインしたときにのみ変更が有効になります。 そのため、それぞれのユーザ固有のログ記録設定を変更した後に、該当するユーザは再度ログインする必要があります。
アクション トレース
アクション トレース(以前は SQL trace と呼ばれていました)は、
Clarity PPM
テクニカル サポートから求められたときにのみ、その指示に従って実行します。 このアクティビティは、特定のアクションのトラブルシューティングを行うために短時間で実行してください。 実行後、アクション トレースを無効にする必要があります。
ビデオ: SQL トレースの有効化
以下のビデオは、CA Technologies によって提供されます。

このビデオを全画面で再生するには、ビデオ下部の[設定]の右の YouTube ロゴをクリックします。
Clarity PPM
インストールのバックアップ
実稼働システムに対する重要な更新を計画している場合は、復元できるように、常に現在のシステムをバックアップしてください。 データベースのバックアップを保存するには、バックアップ ディレクトリを使用します。
以下の手順に従います。
  1. CSA にログインし、データベース以外のすべてのサービスが停止していることを確認します。 データベース サービスがインストールされていない場合、確認は不要です。
  2. CSA アプリケーション サーバのコマンド ラインを開き、以下のコマンドを発行します。
    admin backup
  3. 既定値を受け入れるには、Enter キーを押します。
    バックアップ コマンドによって、
    Clarity PPM
    インストール ディレクトリがバックアップ ディレクトリにコピーされます。
Oracle データベースのバックアップ
以下の手順に従います。
  1. データベース サーバのコマンド ラインから、Oracle データベースのエクスポート ユーティリティ
    expdp
    を使用します。
    このユーティリティを使用する詳細な手順については、Oracle のマニュアルを参照してください。 以下の例は、エクスポート コマンドを示しています。
    expdp clarity/password FULL=y DIRECTORY=data_pump_dir DUMPFILE=clarity.dmp LOGFILE=myclarityexp.log SCHEMAS=clarity
  2. バックアップ コマンドによって作成されたバックアップ ディレクトリに、.dmp と init<SID>.ora ファイルをコピーします。
Microsoft SQL Server データベースのバックアップ
SQL Server Enterprise Manager を使用して Microsoft SQL データベースをバックアップします。 詳細については、Microsoft のドキュメントを参照してください。
Clarity PPM
インストールの復元
インストールの復元操作では、アップグレード プロセスが開始する前に行われたファイル システムとデータベースのバックアップを使用します。
ベスト プラクティス:
Clarity PPM
インストールの復元は、他の選択肢をすべて試みた後に行います。
以下の手順に従います。
  1. コマンド ラインから、すべてのサービスを停止します。
    service stop all
  2. 標準的なデータベース管理ツールと、アップグレード プロセスを開始する前に作成されたバックアップを使用して、データベースを復元します。
  3. バックアップ ディレクトリの restore スクリプトを使用して、
    Clarity PPM
    を復元します。
    Windows
    restore.bat
    UNIX
    restore.sh
    Clarity PPM
    インストールのバックアップ
    」を参照してください。
  4. 完了したら、すべてのサービスを再起動します。
    service start all
  5. (オプション)古いレポートを再インストールします。
    レポートをインストールしたバージョンに対応する「インストールおよびアップグレード
    」を参照してください。
既存の Oracle データベース オブジェクトのコンパイルと分析
以下の状況で、データベースをコンパイルおよび分析します。
  • 別のサーバにデータベースをエクスポートまたはインポートして、テスト アップグレードを実行する場合
  • 実稼働サーバ上でデータベースを再編成する場合
コンパイルと分析によって、すべてのデータベース オブジェクトが確実に有効になります。
Clarity PPM
スキーマをアップグレードする前にデータベース オブジェクトをコンパイルしないと、アップグレード障害が発生することがあります。
以下の手順に従います。
CSA アプリケーション サーバのコマンド ラインを開き、以下のコマンドを発行します。
admin db compile admin db analyze
データベース オブジェクトがコンパイルされ分析されます。
ファイル ディレクトリのサイズの設定
CSA では、ファイル ストレージのサイズ制限をディレクトリ レベルで指定できます。 制限を指定すると、限度に達したときに、後続ファイルの格納用として新しい兄弟ディレクトリが自動的に作成されます。 サイズ制限は、XML Open Gateway (XOG)を使用して
Clarity PPM
にインポートされるドキュメントにも適用されます。
ディレクトリ サイズの制限の設定は、以前から存在するフォルダのサイズに影響しません。
以下の手順に従います。
  1. CSA にログインします。
  2. [ホーム]を開き、[サーバ]をクリックします。
  3. シナリオ名をクリックします。
  4. [ドキュメントと検索]サブタブをクリックします。
  5. [ファイル保管ディレクトリのサイズの制限]フィールドの[ドキュメント マネージャ オプション]セクションで、ディレクトリに対するファイル ストレージ サイズの制限を指定します。
GEL タグの制限を設定します。
GEL タグの制限を制御するには、以下のコマンドを使用します。
admin general restrict-gel-tags
gelTagRestriction プロパティの値を
on
に設定します。
admin general allow-gel-tags
gelTagRestriction プロパティの値を
off
に設定します。
gel タグが制限されているかどうかを確認するために、gelTagRestriction プロパティが参照されます。 このプロパティは、システム要素です。 この要素はオプションです。
環境に対して GEL タグ制限を設定するには、
on
または
off
の値を使用します。
off
以外の任意の値を指定すると、GEL タグ制限が有効になります。 GEL タグの制限は既定では off です。
GEL タグの制限を変更すると、app および bg サービスの再起動が必要になります。
GEL タグが制限されていない Properties.xml ファイル。
<system online="true" multiCurrency="false" licenseTypes="old" singleTenantMode="true"/>
<system online="true" multiCurrency="false" licenseTypes="old" singleTenantMode="true" gelTagRestriction="off"/>
GEL タグが制限されている Properties.xml ファイル。
<system online="true" multiCurrency="false" licenseTypes="old" singleTenantMode="false" gelTagRestriction="on"/>