コンポーネント設定セクション - Amazon CloudWatch
コンポーネント設定セクションのプロパティ

コンポーネント設定セクション

コンポーネントの設定には、いくつかの主要なセクションがあります。コンポーネント設定のセクションは、任意の順序でリストできます。

  • alarmMetrics (オプション)

    コンポーネントでモニターリングするメトリクスのリスト。すべてのコンポーネントタイプに alarmMetrics セクションを設定できます。

  • logs (オプション)

    コンポーネントでモニターリングするログのリスト。logs セクションは EC2 インスタンスのみに設定できます。

  • プロセス (オプション)

    コンポーネントでモニターリングするプロセスのリスト。プロセスセクションは EC2 インスタンスのみに設定できます。

  • subComponents (オプション)

    コンポーネントのネストされたインスタンスおよびボリューム subComponent 設定。次のタイプのコンポーネントには、ネストされたインスタンスと subComponents セクションを含めることができます。ELB、ASG、カスタムグループ化された EC2 インスタンス、および EC2 インスタンス。

  • アラーム（オプション）

    コンポーネントでモニターリングするアラームのリスト。すべてのコンポーネントタイプにアラームセクションを設定できます。

  • windowsEvents (オプション)

    コンポーネントでモニターリングする Windows イベントのリスト。EC2 インスタンスの Windows にのみ windowsEvents セクションがあります。

  • JMXPrometheusExporter (オプション)

    JMXPrometheus Exporter の設定。

  • hanaPrometheusExporter (オプション)

    SAP HANA Prometheus Exporter の設定。

  • haClusterPrometheusExporter (オプション)

    HA Cluster Prometheus Exporter の設定。

  • netWeaverPrometheusExporter (オプション)

    SAP NetWeaver Prometheus Exporter の設定。

  • sapAsePrometheusExporter (オプション)

    SAP ASE Prometheus Exporter の設定。

次の例は、JSON 形式の subComponents セクションフラグメントの構文を示しています。

[
  {
    "subComponentType" : "AWS::EC2::Instance",
    "alarmMetrics" : [
      list of alarm metrics
    ],
    "logs" : [
      list of logs
    ],
    "processes": [
      list of processes
    ],
    "windowsEvents" : [
      list of windows events channels configurations
    ]
  },
  {
    "subComponentType" : "AWS::EC2::Volume",
    "alarmMetrics" : [
      list of alarm metrics
    ]
  }
]

コンポーネント設定セクションのプロパティ

このセクションでは、各コンポーネント設定セクションのプロパティについて説明します。

メトリクス

コンポーネントでモニターリングするメトリクスを定義します。

JSON 

{
  "alarmMetricName" : "monitoredMetricName",
  "monitor" : true/false
}

プロパティ

  • alarmMetricName (必須)

    コンポーネントでモニターリングされるメトリクスの名前。Application Insights でサポートされるメトリクスについては、「Amazon CloudWatch Application Insights でサポートされるログとメトリクス」を参照してください。

  • monitor (オプション)

    メトリクスをモニターリングするかどうかを示すブール値。デフォルト値は true です。

Log

コンポーネントでモニターリングするログを定義します。

JSON 

{
  "logGroupName" : "logGroupName",
  "logPath" : "logPath",
  "logType" : "logType",
  "encoding" : "encodingType",
  "monitor" : true/false
}

プロパティ

  • logGroupName (必須)

    モニターリングされたログに関連付けられる CloudWatch Logs グループ名。ロググループ名の制約については、「CreateLogGroup」を参照してください。

  • logPath (EC2 インスタンスのコンポーネントでは必須、AWS Lambda などの CloudWatch エージェントを使用しないコンポーネントでは不要)

    モニターリングするログのパス。ログパスは、Windows システムファイルの絶対パスである必要があります。詳細については、「CloudWatch エージェント設定ファイル: ログセクション」を参照してください。

  • logType (必須)

    ログタイプは、Application Insights がログを分析するログパターンを決定します。ログの種類は以下から選択します。

    • SQL_SERVER

    • MYSQL

    • MYSQL_SLOW_QUERY

    • POSTGRESQL

    • ORACLE_ALERT

    • ORACLE_LISTENER

    • IIS

    • APPLICATION

    • WINDOWS_EVENTS

    • WINDOWS_EVENTS_ACTIVE_DIRECTORY

    • WINDOWS_EVENTS_DNS

    • WINDOWS_EVENTS_IIS

    • WINDOWS_EVENTS_SHAREPOINT

    • SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP

    • SQL_SERVER_FAILOVER_CLUSTER_INSTANCE

    • DEFAULT

    • CUSTOM

    • STEP_FUNCTION

    • API_GATEWAY_ACCESS

    • API_GATEWAY_EXECUTION

    • SAP_HANA_LOGS

    • SAP_HANA_TRACE

    • SAP_HANA_HIGH_AVAILABILITY

    • SAP_NETWEAVER_DEV_TRACE_LOGS

    • PACEMAKER_HIGH_AVAILABILITY

  • encoding (オプション)

    モニターリングするログのエンコードのタイプ。指定するエンコードは、CloudWatch エージェントでサポートされているエンコードのリストに含まれている必要があります。指定しない場合、CloudWatch Application Insights は、以下を除き、デフォルトのエンコーディング タイプ utf-8 を使用します。

    • SQL_SERVER: UTF-16 エンコード

    • IIS: ASCII エンコード

  • monitor (オプション)

    ログをモニターリングするかどうかを示すブール値。デフォルト値は true です。

プロセス

コンポーネントでモニターリングするプロセスを定義します。

JSON 

{
  "processName" : "monitoredProcessName",
  "alarmMetrics" : [
      list of alarm metrics
  ] 
}

プロパティ

  • processName (必須)

    コンポーネントでモニターリングされるプロセスの名前。プロセスの名前には、sqlservr または sqlservr.exe のようなプロセスステムを含めることはできません。

  • alarmMetric (必須)

    このプロセスをモニターするメトリクスのリスト。CloudWatch Application Insights でサポートされるプロセスメトリクスを表示するには、「 Amazon Elastic Compute Cloud (EC2) 」を参照してください。

JMX Prometheus Exporter

JMX Prometheus Exporter の設定を定義します。

JSON 

"JMXPrometheusExporter": {
  "jmxURL" : "JMX URL",
  "hostPort" : "The host and port",
  "prometheusPort" : "Target port to emit Prometheus metrics"
}

プロパティ

  • jmxURL (オプション)

    接続する完全な JMX URL。

  • hostPort (オプション)

    リモート JMX 経由で接続するホストとポート。jmxURL と hostPort のいずれかのみを指定できます。

  • prometheusPort (オプション)

    Prometheus メトリクスを送信するターゲットポート。指定しない場合は、デフォルトのポート 9404 が使用されます。

HANA Prometheus Exporter

HANA Prometheus Exporter の設定を定義します。

JSON 

"hanaPrometheusExporter": {
    "hanaSid": "SAP HANA  SID",
    "hanaPort": "HANA database port",
    "hanaSecretName": "HANA secret name",
    "prometheusPort": "Target port to emit Prometheus metrics"
}

プロパティ

  • hanaSid

    SAP HANA システムの 3 文字の SAP システム ID (SID)。

  • hanaPort

    エクスポーターが HANA メトリクスをクエリするために使用する HANA データベースのポート。

  • hanaSecretName

    HANA のモニターリングにおけるユーザー認証情報を格納する AWS Secrets Manager シークレット。HANA Prometheus Exporter では、これらの認証情報を使用してデータベースに接続し、HANA メトリクスをクエリします。

  • prometheusPort (オプション)

    Prometheus によるメトリクスの送信先となるターゲットポート。指定しない場合は、デフォルトのポート 9668 が使用されます。

HA Cluster Prometheus Exporter

HA Cluster Prometheus Exporter の設定を定義します。

JSON 

"haClusterPrometheusExporter": {
    "prometheusPort": "Target port to emit Prometheus metrics"
}

プロパティ

  • prometheusPort (オプション)

    Prometheus によるメトリクスの送信先となるターゲットポート。指定しない場合は、デフォルトのポート 9664 が使用されます。

NetWeaver Prometheus Exporter

NetWeaver Prometheus Exporter の設定を定義します。

JSON 

"netWeaverPrometheusExporter": {
    "sapSid": "SAP NetWeaver  SID",
    "instanceNumbers": [ "Array of instance Numbers of SAP NetWeaver system "],
"prometheusPort": "Target port to emit Prometheus metrics"
}

プロパティ

  • sapSid

    SAP Netweaver システムの 3 文字の SAP システム ID (SID)。

  • instanceNumbers

    SAP NetWeaver システムのインスタンス番号の配列。

    例: "instanceNumbers": [ "00", "01"]

  • prometheusPort (オプション)

    Prometheus メトリクスの送信先となるターゲットポート。指定しない場合、デフォルトのポート 9680 が使用されます。

SAP ASE Prometheus Exporter

SAP ASE Prometheus Exporter の設定を定義します。

JSON 

"sapASEPrometheusExporter": {
    "sapAseSid": "SAP ASE SID",
    "sapAsePort": "SAP ASE database port",
    "sapAseSecretName": "SAP ASE secret name",
    "prometheusPort": "Target port to emit Prometheus metrics",
    "agreeToEnableASEMonitoring": true
}

プロパティ

  • sapAseSid

    SAP ASE システムの 3 文字の SAP システム ID (SID)。

  • sapAsePort

    エクスポーターが ASE メトリクスをクエリするために使用する SAP ASE データベースのポート。

  • sapAseSecretName

    ASE のモニタリングにおけるユーザー認証情報を格納する AWS Secrets Manager シークレット。SAP ASE Prometheus Exporter では、これらの認証情報を使用してデータベースに接続し、ASE メトリクスをクエリします。

  • prometheusPort (オプション)

    Prometheus によるメトリクスの送信先となるターゲットポート。指定しない場合は、デフォルトのポート 9399 が使用されます。デフォルトのポートを使用している別の ASE DB がある場合は、9499 を使用します。

Windows イベント

ログに記録する Windows イベントを定義します。

JSON 

{
  "logGroupName" : "logGroupName",
  "eventName" : "eventName",
  "eventLevels" : ["ERROR","WARNING","CRITICAL","INFORMATION","VERBOSE"],
  "monitor" : true/false
}

プロパティ

  • logGroupName (必須)

    モニターリングされたログに関連付けられる CloudWatch Logs グループ名。ロググループ名の制約については、「CreateLogGroup」を参照してください。

  • eventName (必須)

    ログ記録する Windows イベントのタイプ。これは Windows イベントログのチャネル名と同等です。たとえば、System、Security、CustomEventName などです。このフィールドは、ログ記録する Windows イベントのタイプごとに必要です。

  • eventLevels (必須)

    ログ記録するイベントのレベル。ログ記録する各レベルを指定する必要があります。指定できる値には、INFORMATION、WARNING、ERROR、CRITICALおよび VERBOSE などがあります。このフィールドは、ログ記録する Windows イベントのタイプごとに必要です。

  • monitor (オプション)

    ログをモニターリングするかどうかを示すブール値。デフォルト値は true です。

アラーム

コンポーネントでモニターリングする CloudWatch アラームを定義します。

JSON 

{
  "alarmName" : "monitoredAlarmName",
  "severity" : HIGH/MEDIUM/LOW
}

プロパティ

  • alarmName（必須）

    コンポーネントでモニターリングする CloudWatch アラームの名前。

  • 重大度（オプション）

    アラームが鳴ったときの停止の程度を示します。