Propriétés de la section Configuration de composant

Sections de configuration de composant

Une configuration de composant comprend plusieurs sections majeures. Les sections d'une configuration de composant peuvent être listées dans n'importe quel ordre.

alarmMetrics (en option)

Liste des métriques à surveiller pour le composant. Tous les types de composant peuvent avoir une section alarmMetrics.
logs (en option)

Liste des journaux à surveiller pour le composant. Seules les instances EC2 peuvent avoir une section de journaux.
processes (facultatif)

Liste des processus à surveiller pour le composant. Seules les instances EC2 peuvent avoir une section relative aux processus.
sous-composants (en option)

Configuration d'instance imbriquée et du volume de subComponent pour le composant. Les types de composants suivants peuvent avoir des instances imbriquées et une section subComponents : ELB, ASG, les instances EC2 regroupées personnalisées et des instances EC2.
alertes (en option)

Liste des alertes à surveiller pour le composant. Tous les types de composant peuvent avoir une section alerte.
windowsEvents (en option)

Liste des événements Windows à surveiller pour le composant. Seul Windows dispose d'une section windowsEvents sur les instances EC2.
JMXPrometheusExporter (en option)

Configuration de JMXPrometheus Exporter.
Hana Prometheus Exporter (en option)

Configuration de l'exportateur SAP HANA Prometheus.
Hacluster Prometheus Exporter (en option)

Configuration de l'exportateur Prometheus Cluster HA.
netWeaverPrometheusExporter (facultatif)

Configuration de SAP NetWeaver Prometheus Exporter.
sapAsePrometheusExporter (facultatif)

Configuration de SAP ASE Prometheus Exporter.

L'exemple suivant montre la syntaxe du fragment de la section subComponents au format JSON.


[
  {
    "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
    ]
  }
]

Propriétés de la section Configuration de composant

Cette section décrit les propriétés de chaque section Configuration de composant.

Métrique

Définit une métrique à surveiller pour le composant.

JSON


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

Propriétés

alarmMetricName (obligatoire)

Le nom de la métrique à surveiller pour le composant. Pour les métriques prises en charge par Application Insights, consultez Journaux et métriques pris en charge par Amazon CloudWatch Application Insights.
monitor (en option)

Valeur booléenne pour indiquer s'il faut surveiller la métrique. La valeur par défaut est true.

Journal

Définit un journal à surveiller pour le composant.

JSON


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

Propriétés

logGroupName (obligatoire)

Nom du groupe de journaux CloudWatch à associer au journal surveillé. Pour les contraintes de nom de groupe de journaux, consultez CreateLogGroup.
logPath (requis pour les composants d'instance EC2 ; non requis pour les composants qui n'utilisent pas l'agent CloudWatch, par exemple AWS Lambda)

Chemin des journaux à surveiller. Le chemin d'accès au journal doit être un chemin absolu de fichier système Windows. Pour plus d'informations, consultez Fichier de configuration d'agent CloudWatch : section Journaux.
logType (obligatoire)

Le type de journal décide des modèles de journal par rapport auxquels Application Insights analyse le journal. Le type de journal est sélectionné parmi les éléments suivants :
- 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 (en option)

Type d'encodage des journaux à surveiller. L'encodage spécifié doit être inclus dans la liste des encodages pris en charge par l'agent CloudWatch. S'il n'est pas fourni, CloudWatch Application Insights utilise le type d'encodage par défaut de type utf-8, excepté pour :
- SQL_SERVER : encodage utf-16
- IIS : encodage ascii
surveiller (en option)

Valeur booléenne qui indique s'il faut surveiller les journaux. La valeur par défaut est true.

Processus

Définit un processus à surveiller pour le composant.

JSON


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

Propriétés

processName (obligatoire)

Le nom du processus à surveiller pour le composant. Le nom du processus ne doit pas contenir de tige de processus, tel que sqlservr ou sqlservr.exe.
alarmMetrics (obligatoire)

Une liste des métriques à surveiller pour ce processus. Pour afficher les métriques de processus prises en charge par CloudWatch Application Insights, veuillez consulter la rubrique Amazon Elastic Compute Cloud (EC2) .

JMX Prometheus Exporter

Définit les paramètres de JMX Prometheus Exporter.

JSON


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

Propriétés

jmxURL (en option)

Une URL JMX complète à laquelle se connecter.
hostPort (en option)

L'hôte et le port auquel se connecter par le biais du JMX distant. Seul un des jmxURL et hostPort peut être spécifié.
prometheusPort (en option)

Le port cible vers lequel envoyer les métriques Prometheus. S'il n'est pas spécifié, le port par défaut 9404 est utilisé.

Exportateur HANA Prometheus

Définit les paramètres de l'exportateur HANA Prometheus.

JSON


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

Propriétés

Hanasid

L'ID système SAP (SID) à trois caractères du système SAP HANA.
Port Hana

Port de base de données HANA par lequel l'exportateur interrogera les métriques HANA.
Hana Secret Nom

LeAWS Secrets Managersecret qui stocke les informations d'identification d'utilisateur de surveillance HANA. L'exportateur HANA Prometheus utilise ces informations d'identification pour se connecter à la base de données et interroger les métriques HANA.
prometheusPort (en option)

Le port cible vers lequel Prometheus envoie des métriques. S'il n'est pas spécifié, le port par défaut 9668 est utilisé.

Exportateur HA Cluster Prometheus

Définit les paramètres de l'exportateur HA Cluster Prometheus.

JSON


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

Propriétés

prometheusPort (en option)

Le port cible vers lequel Prometheus envoie des métriques. S'il n'est pas spécifié, le port par défaut 9664 est utilisé.

NetWeaver Prometheus Exporter

Définit les paramètres de 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"
}

Propriétés

sapSid

L'ID système SAP (SID) à trois caractères du système SAP NetWeaver.
instanceNumbers

Tableau des numéros d'instance du système SAP NetWeaver.

Exemple : "instanceNumbers": [ "00", "01"]
prometheusPort (en option)

Le port cible vers lequel envoyer les métriques Prometheus. S'il n'est pas spécifié, le port par défaut 9680 est utilisé.

SAP ASE Prometheus Exporter

Définit les paramètres de 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
}

Propriétés

sapAseSid

L'ID système SAP (SID) à trois caractères du système SAP ASE.
sapAsePort

Le port de base de données SAP ASE par lequel l'exportateur interrogera les métriques ASE.
sapAseSecretName

Le secret AWS Secrets Manager qui stocke les informations d'identification de l'utilisateur de surveillance ASE. L'exportateur SAP ASE Prometheus utilise ces informations d'identification pour se connecter à la base de données et interroger les métriques ASE.
prometheusPort (en option)

Le port cible vers lequel Prometheus envoie des métriques. S'il n'est pas spécifié, le port par défaut 9399 est utilisé. S'il existe une autre base de données ASE qui utilise le port par défaut, le port 9499 est utilisé.

Événements Windows

Définit les événements Windows à journaliser.

JSON


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

Propriétés

logGroupName (obligatoire)

Nom du groupe de journaux CloudWatch à associer au journal surveillé. Pour les contraintes de nom de groupe de journaux, consultez CreateLogGroup.
eventName (obligatoire)

Type des événements Windows à consigner. Ceci est équivalent au nom du canal du journal des événements de Windows. Par exemple, System, Security, CustomEventName, etc. Ce champ est obligatoire pour chaque type d'événement Windows à consigner.
eventLevels (obligatoire)

Niveaux d'événement à consigner. Vous devez spécifier chaque niveau à consigner. Les valeurs possibles incluent INFORMATION, WARNING, ERROR, CRITICAL et VERBOSE. Ce champ est obligatoire pour chaque type d'événement Windows à consigner.
monitor (en option)

Valeur booléenne qui indique s'il faut surveiller les journaux. La valeur par défaut est true.

alerte

Définit une alerte CloudWatch à surveiller pour le composant.

JSON


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

Propriétés

alarmName (obligatoire)

Le nom de l'alerte CloudWatch à surveiller pour le composant.
gravité (en option)

Indique le degré de panne lorsque l'alerte se déclenche.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Fragment de modèle

Exemples de configurations pour les services pertinents