Compartilhar via

Configuração de métricas do cluster

  • Artigo

Quando o usuário implanta um Cluster, um conjunto padrão de métricas é habilitado para coleta. Para obter a lista de métricas, consulte Lista de Métricas Coletadas.

Os usuários não podem controlar o comportamento (habilitar ou desabilitar) para coleta dessas métricas padrão incluídas. No entanto, os usuários podem controlar a coleta de algumas métricas opcionais que não fazem parte do link para a lista. Para habilitar essa experiência, os usuários precisam criar e atualizar um recurso MetricsConfiguration para um cluster. Por padrão, a criação desse recurso MetricsConfiguration não altera a coleta de métricas. O usuário precisa atualizar o recurso para habilitar ou desabilitar essa coleta de métricas opcionais.

Observação

  • Para um cluster, no máximo, apenas um recurso MetricsConfiguration pode ser criado.
  • Os usuários precisam criar um recurso MetricsConfiguration para verificar uma lista de métricas opcionais que podem ser controladas.
  • A exclusão do recurso MetricsConfiguration resulta no conjunto padrão de métricas sendo restauradas.

Como gerenciar a configuração de métricas do cluster

Para dar suporte ao ciclo de vida das configurações de métricas do cluster, as interações a seguir permitem a criação e o gerenciamento das configurações de métricas de um cluster.

Criar uma configuração de métricas

Use o comando az network cluster metricsconfiguration create para criar a configuração de métricas para o cluster. Se você tiver várias assinaturas do Azure, o usuário deverá passar a ID da assinatura usando um sinalizador --subscription <SUBSCRIPTION_ID> para o comando da CLI ou selecionar a ID da assinatura apropriada usando o comando az account set.

az networkcloud cluster metricsconfiguration create \
 --cluster-name "<CLUSTER>" \
 --extended-location name="<CLUSTER_EXTENDED_LOCATION_ID>" type="CustomLocation" \
 --location "<LOCATION>" \
 --collection-interval <COLLECTION_INTERVAL (1-1440)> \
 --enabled-metrics "<METRIC_TO_ENABLE_1>" "<METRIC_TO_ENABLE_2>" \
 --tags <TAG_KEY1>="<TAG_VALUE1>" <TAG_KEY2>="<TAG_VALUE2>" \
 --resource-group "<RESOURCE_GROUP>"
  • Substitua os valores entre < > por suas informações específicas.
  • Consulte o recurso de cluster e localize o valor de <CLUSTER-EXTENDED-LOCATION-ID> no properties.clusterExtendedLocation
  • O campo collection-interval é obrigatório e enabled-metrics é um campo opcional.

Como alternativa, os operadores podem fornecer a lista de métricas habilitadas por meio de arquivo json ou yaml.

Exemplo: arquivo enabled-metrics.json

[
   "metric_1",
   "metric_2"
]

Exemplo: arquivo enabled-metrics.yaml

- "metric_1"
- "metric_2"

Comando de exemplo para usar o arquivo json/yaml de métricas habilitadas:

az networkcloud cluster metricsconfiguration create \
 --cluster-name "<CLUSTER>" \
 --extended-location name="<CLUSTER_EXTENDED_LOCATION_ID>" type="CustomLocation" \
 --location "<LOCATION>" \
 --collection-interval <COLLECTION_INTERVAL (1-1440)> \
 --enabled-metrics <path-to-yaml-or-json-file> \
 --tags <TAG_KEY1>="<TAG_VALUE1>" <TAG_KEY2>="<TAG_VALUE2>" \
 --resource-group "<RESOURCE_GROUP>"

Aqui, <path-to-yaml-or-json-file> pode ser ./enabled-metrics.json ou ./enabled-metrics.yaml (coloque o arquivo no diretório de trabalho atual) antes de executar a ação.

Para ver todos os parâmetros disponíveis e suas descrições, execute o comando:

az networkcloud cluster metricsconfiguration create --help

Elementos de configuração de métricas

Nome do Parâmetro Descrição
CLUSTER Nome do recurso do cluster
LOCALIZAÇÃO A região do Azure na qual o cluster é implantado
CLUSTER_EXTENDED_LOCATION_ID O Local estendido do Cluster do portal do Azure
COLLECTION_INTERVAL A frequência de coleta para métricas padrão
RESOURCE_GROUP O nome do grupo de recursos do cluster
TAG_KEY1 tag1 opcional para passar para a criação de MetricsConfiguration
TAG_VALUE1 Valor de tag1 opcional para passar para a criação de MetricsConfiguration
TAG_KEY2 tag2 opcional para passar para a criação de MetricsConfiguration
TAG_VALUE2 Valor de tag2 opcional para passar para a criação de MetricsConfiguration
METRIC_TO_ENABLE_1 Métrica opcional "METRIC_TO_ENABLE_1" habilitada além das métricas padrão
METRIC_TO_ENABLE_2 Métrica opcional "METRIC_TO_ENABLE_2" habilitada além das métricas padrão

Especificar --no-wait --debug opções no comando az resulta na execução desse comando de forma assíncrona. Para obter mais informações, consulte como rastrear operações assíncronas.

Observação

  • O intervalo de coleta de métricas padrão para o conjunto padrão de métricas é definido como a cada 5 minutos. Alterar o collectionInterval também afetará a frequência de coleta para métricas padrão.
  • Pode haver apenas um conjunto de configurações de métricas definido por cluster. O recurso é criado com o nome default.

Listar a configuração de métricas

Você pode verificar o recurso de configuração de métricas de um cluster específico usando o comando az networkcloud cluster metricsconfiguration list:

az networkcloud cluster metricsconfiguration list \
 --cluster-name "<CLUSTER>" \
 --resource-group "<RESOURCE_GROUP>"

Recuperar uma configuração de métricas

Depois que uma configuração de métricas é criada, os operadores podem verificar os detalhes do recurso usando o comando az networkcloud cluster metricsconfiguration show:

az networkcloud cluster metricsconfiguration show \
 --cluster-name "<CLUSTER>" \
 --resource-group "<RESOURCE_GROUP>"

Esse comando retorna uma representação JSON da configuração de métricas. Você pode observar a lista de métricas habilitadas e desabilitadas, além da frequência de coleta como uma saída desse comando.

Atualizar uma configuração de métricas

Assim como a criação de uma configuração de métricas, os operadores podem executar uma ação de atualização para alterar a configuração ou atualizar as marcas atribuídas à configuração de métricas.

az networkcloud cluster metricsconfiguration update \
 --cluster-name "<CLUSTER>" \
 --collection-interval <COLLECTION_INTERVAL (1-1440)> \
 --enabled-metrics "<METRIC_TO_ENABLE_1>" "<METRIC_TO_ENABLE_2>" \
 --tags <TAG_KEY1>="<TAG_VALUE1>" <TAG_KEY2>="<TAG_VALUE2>" \
 --resource-group "<RESOURCE_GROUP>"

Os operadores podem atualizar collection-interval independentemente da lista de enabled-metrics. Omite campos que não estão sendo alterados.

Especificar --no-wait --debug opções no comando az resulta na execução desse comando de forma assíncrona. Para obter mais informações, consulte como rastrear operações assíncronas.

Excluir uma configuração de métricas

A exclusão da configuração de métricas retorna o cluster para uma configuração sem alterações. Para excluir uma configuração de métricas, use o comando:

az networkcloud cluster metricsconfiguration delete \
 --cluster-name "<CLUSTER>" \
 --resource-group "<RESOURCE_GROUP>"

Especificar --no-wait --debug opções no comando az resulta na execução desse comando de forma assíncrona. Para obter mais informações, consulte como rastrear operações assíncronas.