View a markdown version of this page

AWSSupport-CollectSAPHANALogs - AWS Systems Manager オートメーションランブックリファレンス

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWSSupport-CollectSAPHANALogs

説明

AWSSupport-CollectSAPHANALogs ランブックは、 AWS デプロイ時の SAP の一部である Amazon Elastic Compute Cloud (Amazon EC2) インスタンス上の SAP HANA からシステムログを収集します。Amazon EC2 インスタンスは AWS Systems Manager (Systems Manager) によって管理される必要があります。ランブックは、必要なパッケージをチェックして不足している場合はインストールし、検出されたオペレーティングシステムに適したログ収集ツールを実行し、必要に応じて収集されたログを Amazon Simple Storage Service (Amazon S3) バケットにアップロードします。

重要

このランブックには、/var/logパーティションで使用可能なディスク容量が 200 MB 以上必要です。このランブックを実行すると、ターゲット Amazon EC2 インスタンスに追加のパッケージがインストールされる場合があります。これを確認するには、 Acknowledgementパラメータを に設定する必要がありますYes。Amazon S3 にログを保存すると、標準の Amazon S3 ストレージとリクエスト料金が発生します。

サポートされるオペレーティングシステム

  • Red Hat Enterprise Linux 8.4 以降

  • SUSE Linux Enterprise Server 12 SP5

  • SUSE Linux Enterprise Server 15 SP3 以降

パッケージがインストールされていない場合

SUSE Linux Enterprise Server:

  • supportutils

  • yast2-support

  • supportutils-plugin-suse-public-cloud

  • supportutils-plugin-ha-sap

  • crmsh

  • unzip

  • curl

  • aws-cli (オプション。 InstallAWSCLIが に設定されている場合にインストールされますYes)

Red Hat Enterprise Linux:

  • sos

  • crm_report

  • unzip

  • curl

  • aws-cli (オプション。 InstallAWSCLIが に設定されている場合にインストールされますYes)

このオートメーションを実行する (コンソール)

ドキュメントタイプ

オートメーション

[所有者]

Amazon

[Platforms] (プラットフォーム)

Linux

パラメータ

  • AutomationAssumeRole

    タイプ: 文字列

    説明: (オプション) Systems Manager Automation がユーザーに代わってアクションを実行できるようにする AWS Identity and Access Management (IAM) ロールの Amazon リソースネーム (ARN)。ロールを指定しない場合、Systems Manager Automation はこのランブックを開始するユーザーのアクセス許可を使用します。

  • InstanceID

    タイプ: AWS::EC2::Instance::Id

    説明: (必須) ログを収集する SAP ワークロードを実行している Amazon EC2 インスタンスの ID。

  • 確認

    タイプ: 文字列

    有効な値: はい

    説明: (必須) このランブックがログ収集のためにターゲット Amazon EC2 インスタンスに追加のパッケージをインストールする場合があることを確認します。

  • S3LogDestination

    タイプ: AWS::S3::Bucket::Name

    説明: (オプション) ログがアップロードされる Amazon S3 バケットの名前。バケットはパブリックではなく、同じ AWS アカウントに属している必要があります。指定しない場合、ログはインスタンスのローカルストレージに保存されます。

  • S3Prefix

    タイプ: 文字列

    デフォルト: AWSSupport-CollectSAPHANALogs

    許可されるパターン: ^$|^[a-zA-Z0-9][-./a-zA-Z0-9]{0,255}$

    説明: (オプション) ログが保存される Amazon S3 バケットプレフィックス。指定しない場合、デフォルトで になりますAWSSupport-CollectSAPHANALogs。

  • InstallAWSCLI

    タイプ: 文字列

    有効な値: はい | いいえ

    デフォルト: いいえ

    説明: (オプション) インスタンスに AWS CLI をインストールするかどうか。の場合Yes、ランブックは CLI AWS がまだ存在しない場合はインストールします。

必要な IAM アクセス許可

AutomationAssumeRole パラメータでは、ランブックを正常に使用するために、次のアクションが必要です。

  • ssm:DescribeInstanceInformation

  • ssm:SendCommand

  • ssm:GetCommandInvocation

  • s3:GetBucketPublicAccessBlock

  • s3:GetBucketAcl

  • s3:GetBucketLocation

  • s3:GetBucketOwnershipControls

  • s3:GetEncryptionConfiguration

  • s3:PutObject

ドキュメントステップ

  1. AssertInstanceIsSSMManaged - ターゲット Amazon EC2 インスタンスが Systems Manager によって管理され、 PingStatus が であることを確認しますOnline。インスタンスが管理されていない場合、ランブックはキャンセルされます。

  2. GetInstanceInformation - 適切なログ収集方法を決定するために使用されるプラットフォーム名を含む、指定された Amazon EC2 インスタンスに関する情報を取得します。

  3. CollectLogs - インスタンスでシェルスクリプトを実行してログを収集します。SUSE Linux Enterprise Server インスタンスの場合、スクリプトは を使用しますsupportconfig。Red Hat Enterprise Linux インスタンスの場合、 を使用しますsos report。HA クラスターの場合、スクリプトは crm report コマンドを使用して過去 7 日間の追加の HA ログも収集します。必要なパッケージがない場合はインストールされます。

  4. BranchOnS3BucketProvided - Amazon S3 バケットが で提供されたかどうかに基づいて実行を分岐しますS3LogDestination。バケットが指定されていない場合、ランブックは にスキップされますGenerateReport。それ以外の場合は、 に進みますCheckS3BucketPublicStatus。

  5. CheckS3BucketPublicStatus - で指定された Amazon S3 バケットS3LogDestinationがサーバー側の暗号化 (SSE) で設定されているかどうか、および匿名またはパブリックの読み取り/書き込みアクセス許可が許可されているかどうかを確認します。また、実際のバケット所有者が予想されるバケット所有者と同じであることを確認します。このステップが失敗した場合、ランブックはアップロードGenerateReportせずに続行されます。

  6. UploadLogsToS3 - 収集されたログを指定された Amazon S3 バケットにアップロードします。InstallAWSCLI が に設定Yesされていて CLI AWS がインストールされていない場合、スクリプトはアップロード前に AWS CLI をインストールします。

  7. GenerateReport - ログ収集プロセスのレポートを生成します。Amazon S3 バケットが指定されている場合は、ログがアップロードされた Amazon S3 バケット名とプレフィックスが含まれます。そうでない場合は、ログがインスタンスにローカルに保存されたことを示します。また、前のステップが失敗した理由もレポートされます。

[出力]

GenerateReport.Summary - ログ収集結果の概要。

GenerateReport.LogLocation - インスタンスのローカルパスまたは Amazon S3 URI のいずれかで、ログが保存された場所。

GenerateReport.Status - ログ収集実行の全体的なステータス。

指示

次の手順に従って自動化を設定します。

  1. ドキュメントの Systems Manager AWSSupport-CollectSAPHANALogsで に移動します。

  2. [Execute automation] (オートメーションを実行) を選択します。

  3. 入力パラメータには、次のように入力します。

    • AutomationAssumeRole（オプション):

      Systems Manager Automation がユーザーに代わってアクションを実行できるようにする IAM ロールの ARN。ロールが指定されていない場合、Systems Manager Automation は、このランブックを開始するユーザーのアクセス許可を使用します。

    • InstanceID (必須):

      SAP ワークロードを実行している Amazon EC2 インスタンスの ID。

    • 確認 (必須):

      Yes を入力して、ランブックがターゲット Amazon EC2 インスタンスに追加のパッケージをインストールできることを確認します。

    • S3LogDestination (オプション):

      ログをアップロードする Amazon S3 バケットの名前。指定しない場合、ログはインスタンスにローカルに保存されます。

    • S3Prefix (オプション):

      保存済みログの Amazon S3 バケットプレフィックス。デフォルトは AWSSupport-CollectSAPHANALogs です。

    • InstallAWSCLI (オプション):

      インスタンスに CLI AWS が存在しない場合は、 Yesを選択して自動的にインストールします。デフォルトは No です。

  4. [実行] を選択します。

  5. 自動化が開始されます。

  6. ドキュメントは以下のステップを実行します。

    • AssertInstanceIsSSMManaged

      ターゲット Amazon EC2 インスタンスが Systems Manager によって管理され、 PingStatus が であることを確認しますOnline。

    • GetInstanceInformation

      プラットフォーム名など、指定された Amazon EC2 インスタンスに関する情報を取得します。

    • CollectLogs

      シェルスクリプトを実行して、 の SLESまたは supportconfigの を使用してログを収集sos reportしますRHEL。HA クラスターの場合、 は を使用して過去 7 日間の HA ログも収集しますcrm report。

    • BranchOnS3BucketProvided

      Amazon S3 バケットが指定されGenerateReportていない場合は にスキップし、指定されていない場合は に進みますCheckS3BucketPublicStatus。

    • CheckS3BucketPublicStatus

      Amazon S3 バケットで SSE が有効になっており、パブリックアクセスが許可されておらず、同じ AWS アカウントによって所有されていることを確認します。

    • UploadLogsToS3

      収集されたログを指定された Amazon S3 バケットにアップロードします。InstallAWSCLI CLI が Yesであり、まだ存在しない AWS 場合はインストールします。

    • GenerateReport

      ログの場所やステップの失敗など、ログ収集結果の概要を生成します。

  7. 完了したら、出力セクションで実行の詳細な結果を確認します。

リファレンス

Systems Manager Automation