

# Seções de configuração do componente
<a name="component-config-sections"></a>

Uma configuração do componente contém várias seções principais. As seções de uma configuração de componente podem estar listadas em qualquer ordem.
+ **alarmMetrics (opcional)**

  Uma lista de [métricas](#component-config-metric) a serem monitoradas para o componente. Todos os tipos de componentes podem ter uma seção alarmMetrics. 
+ **logs (opcional)**

  Uma lista de [logs](#component-configuration-log) a serem monitorados para o componente. Somente as instâncias do EC2 podem ter uma seção logs. 
+ **processos (opcional)**

  Uma lista de [processos](#component-configuration-process) a serem monitorados para o componente. Somente as instâncias do EC2 podem ter uma seção de processos. 
+ **subComponents (opcional)**

  Configuração de instância aninhada de subComponent do volume para o componente. Os tipos de componentes a seguir podem ter instâncias aninhadas e uma seção subComponent: ELB, ASG, instâncias do EC2 agrupadas personalizadas e instâncias do EC2.
+ **alarmes (opcional)**

  Uma lista de [alarmes](#component-configuration-alarms) a serem monitorados para o componente. Todos os tipos de componentes podem ter uma seção de alarmes.
+ **windowsEvents (opcional)**

  Uma lista de [eventos do Windows](#windows-events) a serem monitorados para o componente. Somente o Windows em instâncias do EC2 tem uma seção `windowsEvents`.
+ **JMXPrometheusExporter (opcional)**

  Configuração do JMX Protheus Exporter.
+ **hanaPrometheusExporter (opcional)**

  Configuração do SAP HANA Prometheus Exporter.
+ **haClusterPrometheusExporter (opcional)**

  Configuração do HA Cluster Prometheus Exporter.
+ **netWeaverPrometheusExporter (opcional) **

  Configuração do exportador do Prometheus para SAP NetWeaver.
+ **sapAsePrometheusExporter (opcional)**

  Configuração do SAP ASE Prometheus Exporter.

O exemplo a seguir mostra a sintaxe para o **fragmento da seção subComponents** no formato 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
    ]
  }
]
```

## Propriedades da seção de configuração de componentes
<a name="component-config-properties"></a>

Esta seção descreve as propriedades de cada seção de configuração do componente

**Topics**
+ [Métrica](#component-config-metric)
+ [Log](#component-configuration-log)
+ [Processar](#component-configuration-process)
+ [JMX Prometheus Exporter](#component-configuration-prometheus)
+ [HANA Prometheus Exporter](#component-configuration-hana-prometheus)
+ [HA Cluster Prometheus Exporter](#component-configuration-ha-cluster-prometheus)
+ [Exportador do Prometheus para NetWeaver](#component-configuration-netweaver-prometheus)
+ [SAP ASE Prometheus Exporter](#component-configuration-sap-ase-prometheus)
+ [Eventos do Windows](#windows-events)
+ [Alarme](#component-configuration-alarms)

### Métrica
<a name="component-config-metric"></a>

Define uma métrica a ser monitorada para o componente.

**JSON** 

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

**Propriedades**
+ **alarmMetricName (obrigatório)**

  O nome da métrica a ser monitorada para o componente. Para saber sobre as métricas com suporte pelo Application Insights, consulte [Logs e métricas compatíveis com o Amazon CloudWatch Application Insights](appinsights-logs-and-metrics.md). 
+ **monitor (opcional)**

  Booliano para indicar se a métrica deve ser monitorada. O valor padrão é `true`.

### Log
<a name="component-configuration-log"></a>

Define um log a ser monitorado para o componente.

**JSON** 

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

**Propriedades**
+ **logGroupName (obrigatório)**

  O nome do grupo de logs do CloudWatch a ser associado ao log monitorado. Para obter as restrições de nome do grupo de logs, consulte [CreateLogGroup](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogGroup.html).
+ **logPath (necessário para componentes de instância do EC2; não necessário para componentes que não usam o CloudWatch Agent, como o AWS Lambda)**

  O caminho dos logs a serem monitorados. O caminho do log deve ser um caminho de arquivo absoluto do sistema Windows. Para obter mais informações, consulte [Arquivo de configuração do atendente do CloudWatch: seção Logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-Configuration-File-Details.html#CloudWatch-Agent-Configuration-File-Logssection). 
+ **logType (obrigatório)**

  O tipo de log decide os padrões de log em relação aos quais o Application Insights analisa o log. O tipo de log é selecionado a partir de:
  + `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 (opcional)**

  O tipo de codificação dos logs a serem monitorados. A codificação especificada deve ser incluída na lista de [codificações compatíveis com atendentes do CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AgentReference.html). Se não for fornecida, o CloudWatch Application Insights usará o tipo de codificação padrão utf-8, exceto: 
  +  `SQL_SERVER`: codificação utf-16
  +  `IIS`: codificação ascii
+ **monitor (opcional)**

  Booliano que indica se os logs devem ser monitorados. O valor padrão é `true`.

### Processar
<a name="component-configuration-process"></a>

Define um processo a ser monitorado para o componente.

**JSON** 

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

**Propriedades**
+ **processName (obrigatório)**

  O nome do processo a ser monitorado para o componente. O nome do processo não deve conter uma raiz de processo, como `sqlservr` ou `sqlservr.exe`.
+ **alarmMetrics (obrigatório)**

  Uma lista de [métricas](#component-config-metric) a serem monitoradas para esse processo. Para visualizar as métricas de processo compatíveis com o CloudWatch Application Insights, consulte [Amazon Elastic Compute Cloud (EC2)](appinsights-metrics-ec2.md).

### JMX Prometheus Exporter
<a name="component-configuration-prometheus"></a>

Define as configurações do JMX Prometheus Exporter.

**JSON** 

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

**Propriedades**
+ **jmxURL (opcional)**

  Uma URL completa do JMX para se conectar.
+ **hostPort (opcional)**

  O host e a porta à qual se conectar por meio de JMX remoto. Apenas um de `jmxURL` e `hostPort` pode ser especificado.
+ **prometheusPort (opcional)**

  A porta de destino para a qual enviar métricas do Prometheus. Se não for especificada, será usadaa porta padrão 9404.

### HANA Prometheus Exporter
<a name="component-configuration-hana-prometheus"></a>

Define as configurações do HANA Prometheus Exporter.

**JSON** 

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

**Propriedades**
+ **hanaSid**

  O ID do sistema SAP (SID) de três caracteres do sistema SAP HANA.
+ **hanaPort**

  A porta de banco de dados HANA pela qual o exportador consultará métricas HANA.
+ **hanaseCretName**

  O segredo do AWS Secrets Manager que armazena credenciais de usuário de monitoramento HANA. O exportador HANA Prometheus usa essas credenciais para se conectar ao banco de dados e consultar métricas HANA.
+ **prometheusPort (opcional)**

  A porta de destino para a qual o Prometheus envia métricas. Se não for especificada, será usada a porta padrão 9668.

### HA Cluster Prometheus Exporter
<a name="component-configuration-ha-cluster-prometheus"></a>

Define as configurações do HA Cluster Prometheus Exporter

**JSON** 

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

**Propriedades**
+ **prometheusPort (opcional)**

  A porta de destino para a qual o Prometheus envia métricas. Se não for especificada, será usada a porta padrão 9664.

### Exportador do Prometheus para NetWeaver
<a name="component-configuration-netweaver-prometheus"></a>

Define as configurações do exportador Prometheus do NetWeaver.

**JSON** 

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

**Propriedades**
+ **sapSid**

  O ID do sistema SAP (SID) de três caracteres do sistema SAP NetWeaver.
+ **instanceNumbers**

  Matriz dos números de instância do sistema SAP NetWeaver.

  **Exemplo da: **`"instanceNumbers": [ "00", "01"]`
+ **prometheusPort (opcional)**

  A porta de destino para a qual enviar as métricas do Prometheus. Se não for especificada, a porta padrão `9680` será usada.

### SAP ASE Prometheus Exporter
<a name="component-configuration-sap-ase-prometheus"></a>

Define as configurações do 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
}
```

**Propriedades**
+ **sapAseSid**

  O ID do sistema SAP (SID) de três caracteres do sistema do SAP ASE.
+ **sapAsePort**

  A porta do banco de dados do SAP ASE pela qual o exportador consultará as métricas do ASE.
+ **sapAseSecretName**

  O segredo do AWS Secrets Manager que armazena as credenciais de usuário de monitoramento do ASE. O SAP ASE Prometheus Exporter usa essas credenciais para se conectar ao banco de dados e consultar as métricas do ASE.
+ **prometheusPort (opcional)**

  A porta de destino para a qual o Prometheus envia métricas. Se não for especificada, será usada a porta padrão 9399. Se houver outro banco de dados ASE que esteja usando a porta padrão, usaremos 9499.

### Eventos do Windows
<a name="windows-events"></a>

Define os eventos do Windows a serem registrados em log.

**JSON** 

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

**Propriedades**
+ **logGroupName (obrigatório)**

  O nome do grupo de logs do CloudWatch a ser associado ao log monitorado. Para obter as restrições de nome do grupo de logs, consulte [CreateLogGroup](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogGroup.html).
+ **eventName (obrigatório)**

  O tipo de eventos do Windows a serem registrados em log. É equivalente ao nome do canal de log de eventos do Windows. Por exemplo, System, Security, CustomEventName etc. Esse campo é necessário para cada tipo de evento do Windows a ser registrado em log. 
+ **eventLevels (obrigatório)**

  Os níveis de evento a serem registrados. Você deve especificar cada nível a ser registrado em log. Os valores possíveis incluem `INFORMATION`, `WARNING`, `ERROR`, `CRITICAL` e `VERBOSE`. Esse campo é necessário para cada tipo de evento do Windows a ser registrado em log.
+ **monitor (opcional)**

  Booliano que indica se os logs devem ser monitorados. O valor padrão é `true`.

### Alarme
<a name="component-configuration-alarms"></a>

Define um alarme do CloudWatch a ser monitorado para o componente.

**JSON** 

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

**Propriedades**
+ **alarmName (obrigatório)**

  O nome do alarme do CloudWatch a ser monitorado para o componente.
+ **gravidade (opcional)**

  Indica o grau de interrupção quando o alarme dispara. 