ログを使用したトラブルシューティング

デプロイメント・バックアップにあるOCIロギングおよびログを使用して一般的な問題をトラブルシューティングし、OCI GoldenGateデプロイメントから診断を収集する方法について学習します。

プロセス・ログとエラー・ログ

OCI LoggingとOCI GoldenGateを統合して、GoldenGateプロセスおよびエラー・ログを有効化、管理および検索できます。ロギング・サービスとの統合はオプションです。

OCIロギングの使用を開始する前に:

ノート: OCI GoldenGateによって自動的に作成されるログを含むログ・ライフサイクルを管理します。ジョブおよびジョブ実行が削除されて もログは削除されません。可観測性と管理の価格設定の詳細を参照してください。

OCI GoldenGateでOCIロギングを使用するポリシーの追加

サービス・ログを有効にするには、ログ・グループに対する管理アクセス権とリソースへのアクセス権をユーザーに付与する必要があります。ログおよびログ・グループでは、log-groupリソース・タイプが使用されますが、ログの内容を検索するには、log-contentリソース・タイプを使用する必要があります。次のポリシーを追加します:

allow group <group-name> to manage log-groups in compartment <compartment-name>
allow group <group-name> to manage log-content in compartment <compartment-name>

Learn more about policies.

Oracle Cloudコンソールを使用したロギングの有効化

  1. 「デプロイメント」ページで、ロギングを有効にするデプロイメントを選択します。

  2. 「デプロイメントの詳細」ページで、「モニタリング」を選択します。

  3. 「Monitoring」ページで、「Logs」まで下にスクロールします。

  4. 「ログ」表のログの1つの「アクション」メニューで、「ログの有効化」を選択します。

  5. 「ログの有効化」パネルの「コンパートメント」ドロップダウンで、コンパートメントを選択します。

  6. ログ・グループの場合、次のことができます。

    • ドロップダウンからグループを選択します。

    • 新規グループを作成します

    • 空白のままにすると、デフォルト・グループが自動的に割り当てられます。

  7. 「Log name」に、名前を入力します。

  8. ログ保存の場合、ドロップダウンから月数を選択します。

  9. 「ログの有効化」を選択します。

ステータスが「アクティブ」になるまで待ちます。アクティブになると、プロセス・ログおよびエラー・ログの診断ログ機能がオンになります。プロセス・ログとエラー・ログは、OCI GoldenGateなどのOracle Cloud Infrastructureネイティブ・サービスからのものであるため、技術的には「サービス・ログ」です。

CLIを使用したOCIロギングの有効化

  1. ログ・グループの作成

    リクエスト

    oci --profile <profile_name> logging log-group create --compartment-id <compartment_ocid>  --display-name <display_name>

    応答

    { "opc-work-request-id": "<log-workrequest-ocid>" }
  2. ログ・グループIDの取得

    リクエスト

    oci --profile <profile_name> logging work-request get --work-request-id <log-workrequest-ocid>

    応答

    {
        "data": {
        "compartment-id": "<compartment_ocid>",
        "id": "<log-workrequest-ocid>",
        "operation-type": "CREATE_LOG_GROUP",
        "percent-complete": 100.0,
        "resources": [
            {
                "action-type": "CREATED",
                "entity-type": "loggroup",
                "entity-uri": "/logGroups/<log-group-ocid>",
                "identifier": "<log-group-ocid>"
            }
        ],    "
        status": "SUCCEEDED",
        "time-accepted": "2023-05-09T05:57:09.641000+00:00",
        "time-finished": "2023-05-09T05:57:09.641000+00:00",
        "time-started": "2023-05-09T05:57:09.641000+00:00"
        }
    }
  3. ログ・オブジェクトの作成/有効化

    リクエスト

    oci --profile <profile-name> logging log create --display-name <display-name> --log-group-id  <log-group-ocid> --log-type SERVICE/CUSTOM --is-enabled true  --configuration file://path_to_json_file

    JSONリクエスト・ペイロード

    {
        "compartment-id": "<compartment-ocid>",
        "source":
            {
                "resource": "<GoldenGate-deployment-ocid>",
                "service": "goldengate",
                "source-type": "OCISERVICE",
                "category": "error_logs/process_logs"
            }
    }

    応答

    Response
    {
        "opc-work-request-id": "<log-workrequest-ocid>"
    }
  4. OCIロギングの無効化

    リクエスト

    oci --profile <profile_name> logging log update --is-enabled false --log-group-id <log-group-ocid> --log-id <log-ocid>

    応答

    {
        "opc-work-request-id": "<log-workrequest-ocid>"
    }
  5. OCIログの検索

    リクエスト

    oci --profile <profile_name> logging-search search-logs --search-query "search "<compartment_ocid>/<log-group-ocid>/<log-ocid>"" --time-start '2023-05-09 09:54' --time-end '2023-05-09 09:55'

    応答

    {
        "data": {
            "fields": null,
            "results": [
                {
                    "data": {
                    "datetime": 1683626095205,
                    "logContent": {
                        "data": {
                            "level": "INFO",
                            "message": "Executing command '{\n    "name": "report",\n    "reportType": "lag",\n    "thresholds": [\n        {\n            "type": "info",\n            "units": "seconds",\n           "value": 0\n        }\n    ]\n}'",
                            "processName": "adminsrvr",
                            "resourceId": "<GoldenGate-deployment-ocid>"
                        },
                        "id": "20230509095455.2051683626095",
                        "oracle": {
                            "compartmentid": "<compartment-ocid>",
                            "ingestedtime": "2023-05-09T09:55:05.889Z",
                            "loggroupid": "<log-group-ocid>",
                            "logid": "<log-ocid>",
                            "tenantid": "<tenant-ocid>"
                        },
                        "source": "<GoldenGate-deployment-ocid>",
                        "specversion": "1.0",
                        "time": "2023-05-09T09:54:55.205Z",
                        "type": "com.oraclecloud.goldengate.deployment.process_logs"
                    }
                }
            } ],
            "summary": {
                "field-count": null,
                "result-count": 1
            }
        }
    }
  6. ログ・ステータスの取得

    リクエスト

    oci --profile <profile_name> logging log get --log-group-id <log-group-ocid> --log-id <log-ocid>

    応答

    {
        "data": {
            "compartment-id": "<compartment-ocid>",
            "configuration": {
                "archiving": {
                    "is-enabled": false
                },
                "compartment-id": "<compartment-ocid>",
                "source": {
                    "category": "process_logs",
                    "parameters": {},
                    "resource": "<GoldenGate-deployment-ocid>",
                    "service": "goldengate",
                    "source-type": "OCISERVICE"
                }
            },
            "defined-tags": {
                "Oracle-Tags": {
                    "CreatedBy": "<creater_email_id>",
                    "CreatedOn": "2023-05-09T06:24:30.279Z"
                }
            },
            "display-name": "<display_name>",
            "freeform-tags": {},
            "id": "<log-ocid>",
            "is-enabled": false,    "
            lifecycle-state": "INACTIVE",
            "log-group-id": "<log-group-ocid>",
            "log-type": "SERVICE",
            "retention-duration": 30,
            "tenancy-id": "<tenancy-ocid>",
            "time-created": "2023-05-09T06:24:30.452000+00:00",
            "time-last-modified": "2023-05-09T06:30:17.345000+00:00"
        },
        "etag": "cb5bb295-9954-4949-b33f-67d6da50f83f"
    }
  7. ログの削除

    リクエスト

    oci --profile <profile_name> logging log delete --log-group-id <log-group-ocid> --log-id <log-ocid>

    応答

    {
        "opc-work-request-id": "<log-workrequest-ocid>"
    }
  8. ログ・グループの削除

    リクエスト

    oci --profile GGSTEST logging log-group delete --log-group-id <log-group-ocid>

    応答

    {
        "opc-work-request-id": "<log-workrequest-ocid>"
    }

OCIロギング・サービスでのOCI GoldenGateのロギングの有効化

ログ・グループを作成し、ロギング・サービスでサービス・ログを構成します(まだ存在しない場合)。

  1. ナビゲーション・メニューを開き、「監視および管理」を選択します。「ログ・アナリティクス」で、「管理」を選択します。

  2. 「管理の概要」ページの「リソース」で、「ログ・グループ」を選択します。

  3. 作業する権限があるコンパートメントを選択し、「ログ・グループの作成」を選択します。

    「ログ・グループの作成」パネルが表示されます。

  4. 次を完了します:

    • コンパートメント: ログ・グループの作成先となるコンパートメント。このフィールドは、コンパートメントの選択に基づいて事前入力されます。

    • 名前: このログ・グループの名前。ログ・グループ名の最初のキャラクタは、文字にする必要があります。詳細は、ログ名およびログ・グループ名を参照してください。機密情報を入力しないでください。

    • 説明: わかりやすい説明。

    • (オプション)タグ付け情報を入力してください。

  5. 「作成」を選択します。

    「ログ・グループの詳細」ページが表示されます。

  6. 「ログ」を選択します。

  7. 「サービス・ログの有効化」を選択します。

  8. 「リソースの選択」で、次の手順を実行します。

    1. 「リソース・コンパートメント」で、リソースのコンパートメントを選択します。

    2. 「サービス」で、ドロップダウンから「GoldenGate」を選択します。

    3. 「リソース」で、ドロップダウンからデプロイメントを選択します。

  9. 「ログの構成」で、次の手順を実行します。

    1. 「ログ・カテゴリ」で、ドロップダウンから値を選択します。

    2. 「ログ名」に、名前を入力します。

  10. 「拡張オプションの表示」を選択し、「ログの場所」で次のようにします。

    1. 「コンパートメント」で、ログを保存するコンパートメントを選択します。

    2. 「ログ・グループ」で、ドロップダウンからログ・グループを選択するか、新しいグループを作成します。

  11. 「ログの保持」で、ログを保持する月数を選択します。

  12. 「ログの有効化」を選択します。

デプロイメント・バックアップ・ログ

OCI GoldenGateデプロイメントを手動でOracle Object Storageにバックアップしてから、そのバックアップをローカルにダウンロードできます。その後、デプロイメント・ログを検索して、ヘルスの問題をトラブルシューティングできます。

手動バックアップを作成する方法について学習するには、デプロイメント・バックアップの管理を参照してください。

手動デプロイメント・バックアップには、GoldenGateデプロイメントの完全なディレクトリ構造とファイル(ログ・ファイルおよびトレイル・ファイルを含む)が含まれます。トラブルシューティングに役立つディレクトリおよびファイルは次のとおりです:

診断の収集

診断を収集して、OCI GoldenGateデプロイメントに関する情報を分析または共有します。問題が発生した場合は、収集した情報をMy Oracle Supportと共有できます。

ノート:この機能は、データ・レプリケーション・デプロイメントにのみ適用されます。

診断を収集する前に、Oracleオブジェクト・ストレージ・バケットを作成してください。

デプロイメント診断を収集するには:

  1. 「デプロイメント」ページで、診断を収集するデプロイメントを選択します。

  2. デプロイメントの「詳細」ページで、「アクション」メニューから「診断収集」を選択します。

  3. 「診断収集」パネルで、次のフィールドに入力します。次に、「診断収集」を選択します。

    1. 「バケット」ドロップダウンから、診断ファイルを保存するバケットを選択します。別のコンパートメントのバケットを選択する場合は、「コンパートメントの変更」を選択します。

    2. 「診断名接頭辞」に、診断ファイル名の接頭辞となる短縮名または数文字を入力します。

    3. (オプション)システム・ログを収集する開始日を選択します。

    4. (オプション)システム・ログを収集する終了日を選択します。

      ノート: OCI GoldenGateデプロイメント用に収集される診断では、デプロイメントの存続期間全体のGoldenGoldenGateログが含まれます。これは選択した開始日および終了日とは関係ありません。

「診断の収集」を選択すると、「デプロイメント情報」カードのGoldenGateセクションの下に「診断」という名前の新しいフィールドが表示されます。診断zipファイルはダウンロード可能になるまで数分かかることがあります。使用可能になると、「ダウンロード」リンクが表示されます。

ダウンロードが完了したら、ファイルを解凍し、その内容を確認します。