Name:
interface
Value:
Amplify has re-imagined the way frontend developers build fullstack applications. Develop and deploy without the hassle.
Gen1 DocsLegacy

Page updated Jan 14, 2025

ロギングを有効にする

ロギングを有効にして、Amazon CloudWatch ログを使用して GraphQL API をデバッグできます。GraphQL API のログとモニタリング機能の詳細については、AWS AppSync のログとモニタリングに関するドキュメントを参照してください。

デフォルトロギング設定を有効にする

デフォルトロギングは、defineData の呼び出しで logging プロパティを true に設定することで有効にできます。例えば、以下のようにします:

amplify/data/resource.ts
export const data = defineData({
// ...
logging: true
});

logging: true を使用すると、以下のデフォルト設定が適用されます:

ロギング設定をカスタマイズする

DataLogConfig オブジェクトを提供することで、個別の設定値をカスタマイズできます。例えば、以下のようにします:

amplify/data/resource.ts
export const data = defineData({
// ...
logging: {
excludeVerboseContent: false,
fieldLogLevel: 'all',
retention: '1 month'
}
});

警告: excludeVerboseContentfalse に設定すると、機密データを含む可能性がある完全なクエリとユーザーパラメータがログに出力されます。CloudWatch ログへのアクセスを、IAM ポリシーを慎重にスコープすることで、実際に必要とするロールまたはユーザー(例えば DevOps または開発者)のみに限定することをお勧めします。

設定プロパティ

logging

  • true: デフォルトロギングを有効にします。
  • DataLogConfig オブジェクト: 1 つ以上のデフォルトフィールドをオーバーライドします。

DataLogConfig フィールド

  • excludeVerboseContent?: boolean

  • fieldLogLevel?: DataLogLevel

  • retention?: LogRetention

    • ログを保持する日数
    • デフォルト値は '1 week'
    • Enum RetentionDaysでサポートされている値:
      • '1 day'
      • '3 days'
      • '5 days'
      • '1 week'
      • '2 weeks'
      • '1 month'
      • '2 months'
      • '3 months'
      • '4 months'
      • '5 months'
      • '6 months'
      • '1 year'
      • '13 months'
      • '18 months'
      • '2 years'
      • '5 years'
      • '10 years'
      • 'infinite'