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 a coleta dessas métricas padrão incluídas. No entanto, os usuários podem controlar a coleção 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 coleção de métricas. O usuário precisa atualizar o recurso para habilitar ou desabilitar essa coleção 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 na restauração do conjunto padrão de métricas.

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

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

Criando uma configuração de métricas

Use o comando para criar a configuração de métricas para o az network cluster metricsconfiguration create 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 de 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 dentro <> por suas informações específicas.
  • Consulte o recurso de cluster e localize o valor de <CLUSTER-EXTENDED-LOCATION-ID> no properties.clusterExtendedLocation
  • O collection-interval campo é obrigatório e enabled-metrics opcional.

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

Exemplo: arquivo enabled-metrics.json

[
   "metric_1",
   "metric_2"
]

Exemplo: arquivo enabled-metrics.yaml

- "metric_1"
- "metric_2"

Exemplo de comando para usar o arquivo json/yaml enabled-metrics:

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, <o 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 sua descrição, 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
LOCATION A Região do Azure onde o Cluster está 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 padrão
RESOURCE_GROUP O nome do grupo de recursos do cluster
TAG_KEY1 Tag1 opcional para passar para MetricsConfiguration create
TAG_VALUE1 Valor opcional tag1 a ser passado para MetricsConfiguration create
TAG_KEY2 Tag2 opcional para passar para MetricsConfiguration create
TAG_VALUE2 Valor tag2 opcional a ser passado para MetricsConfiguration create
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 controlar 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. A alteração do collectionInterval também afetará a frequência de coleta das métricas padrão 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 para um cluster específico usando az networkcloud cluster metricsconfiguration list o comando:

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

Recuperando uma configuração de métricas

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

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 para esse comando.

Atualizando 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 enabled-metrics lista. Omitir 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 controlar operações assíncronas.

Excluindo uma configuração de métricas

A exclusão da configuração de métricas retorna o cluster para uma configuração inalterada. Para excluir uma configuração de métrica, 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 controlar operações assíncronas.