Descrição dos campos de Telemetry - Alibaba Cloud Service Mesh: Central de Documentação do Alibaba Cloud

A CustomResourceDefinition (CRD) Telemetry define e configura políticas e comportamentos relacionados à observação e coleta de dados em uma instância do Service Mesh (ASM). Ela permite gerenciar os recursos de telemetria do Istio com alta granularidade, incluindo logs, métricas e rastreamento. Com a CRD Telemetry, você personaliza e ajusta os métodos de coleta e processamento de dados de telemetria conforme as necessidades do seu negócio. Este tópico descreve como configurar uma CRD Telemetry e detalha seus campos.

Exemplos de configuração

O Istio oferece suporte a configurações de observabilidade em três níveis, correspondentes às seguintes opções no console do ASM:

Configurações globais (aba Global no console do ASM)
Configurações específicas de namespace (aba Namespace no console do ASM)
Configurações específicas de workload (aba Custom no console do ASM)

Os arquivos YAML de exemplo a seguir demonstram como configurar a observabilidade em diferentes níveis:

Configurações globais

Show the YAML file

apiVersion: telemetry.istio.io/v1alpha1
kind: Telemetry
metadata:
  labels:
    provider: asm
  # When the name is default and the namespace is istio-system, the configurations take effect globally.
  name: default
  namespace: istio-system
spec:
  accessLogging:
  - disabled: false
    # This is the default configuration of ASM and cannot be modified.
    providers:
    - name: envoy
  metrics:
  # You need to configure each metric of the client and server.
  - overrides:
    - disabled: false
      match:
        metric: REQUEST_COUNT
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: REQUEST_COUNT
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: REQUEST_DURATION
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: REQUEST_DURATION
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: REQUEST_SIZE
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: REQUEST_SIZE
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: RESPONSE_SIZE
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: RESPONSE_SIZE
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: GRPC_REQUEST_MESSAGES
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: GRPC_REQUEST_MESSAGES
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: GRPC_RESPONSE_MESSAGES
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: GRPC_RESPONSE_MESSAGES
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_SENT_BYTES
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_SENT_BYTES
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_RECEIVED_BYTES
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_RECEIVED_BYTES
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_OPENED_CONNECTIONS
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_OPENED_CONNECTIONS
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_CLOSED_CONNECTIONS
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_CLOSED_CONNECTIONS
        mode: SERVER
      tagOverrides: {}
    # This is the default configuration of ASM and cannot be modified.
    providers:
    - name: prometheus
  tracing:
  - customTags:
    foo:
      literal:
        value: bar
    randomSamplingPercentage: 10

Configurações específicas de namespace

Show the YAML file

apiVersion: telemetry.istio.io/v1alpha1
kind: Telemetry
metadata:
  labels:
    provider: asm
  # When the name is default, the configurations take effect for the entire namespace.
  name: default
  # The configurations take effect for the default namespace.
  namespace: default
spec:
  accessLogging:
  - disabled: false
    providers:
    - name: accesslogging.default.default
  metrics:
  - overrides:
    - disabled: false
      match:
        metric: REQUEST_COUNT
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: REQUEST_COUNT
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: REQUEST_DURATION
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: REQUEST_DURATION
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: REQUEST_SIZE
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: REQUEST_SIZE
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: RESPONSE_SIZE
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: RESPONSE_SIZE
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: GRPC_REQUEST_MESSAGES
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: GRPC_REQUEST_MESSAGES
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: GRPC_RESPONSE_MESSAGES
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: GRPC_RESPONSE_MESSAGES
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_SENT_BYTES
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_SENT_BYTES
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_RECEIVED_BYTES
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_RECEIVED_BYTES
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_OPENED_CONNECTIONS
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_OPENED_CONNECTIONS
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_CLOSED_CONNECTIONS
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_CLOSED_CONNECTIONS
        mode: SERVER
      tagOverrides: {}
    providers:
    - name: prometheus

Configurações específicas de workload

Show the YAML file

apiVersion: telemetry.istio.io/v1alpha1
kind: Telemetry
metadata:
  labels:
    provider: asm
  # When the name is not set to default, the configurations take effect only for workloads whose label matches the one specified in the selector field.
  name: test
  # The configurations take effect for specified workloads in the default namespace.
  namespace: default
spec:
  accessLogging:
  - disabled: false
    providers:
    - name: accesslogging.default.test
  metrics:
  - overrides:
    - disabled: false
      match:
        metric: REQUEST_COUNT
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: REQUEST_COUNT
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: REQUEST_DURATION
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: REQUEST_DURATION
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: REQUEST_SIZE
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: REQUEST_SIZE
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: RESPONSE_SIZE
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: RESPONSE_SIZE
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: GRPC_REQUEST_MESSAGES
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: GRPC_REQUEST_MESSAGES
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: GRPC_RESPONSE_MESSAGES
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: GRPC_RESPONSE_MESSAGES
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_SENT_BYTES
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_SENT_BYTES
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_RECEIVED_BYTES
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_RECEIVED_BYTES
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_OPENED_CONNECTIONS
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_OPENED_CONNECTIONS
        mode: SERVER
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_CLOSED_CONNECTIONS
        mode: CLIENT
      tagOverrides: {}
    - disabled: false
      match:
        metric: TCP_CLOSED_CONNECTIONS
        mode: SERVER
      tagOverrides: {}
    providers:
    - name: prometheus
  # This field specifies the workloads for which the configurations take effect
  selector:
    matchLabels:
      foo: bar

Descrição dos campos

Telemetry

Campo	Tipo	Obrigatório	Descrição
selector	WorkloadSelector	Não	Define os workloads aos quais a política de Telemetry se aplica.
tracing	Tracing[]	Não	Especifica o comportamento de rastreamento para todos os workloads selecionados.
metrics	Metrics[]	Não	Determina o comportamento das métricas para todos os workloads selecionados.
accessLogging	AccessLogging[]	Não	Indica o comportamento de log de acesso para todos os workloads selecionados.

Tracing

Campo	Tipo	Obrigatório	Descrição
randomSamplingPercentage	double	Não	Defina a taxa de tráfego selecionada para rastreamento. O valor 0 indica ausência de amostragem.
customTags	map<string, CustomTag>	Não	Especifica tags personalizadas adicionais para incluir nos spans de rastreamento gerados.

Metrics

Campo	Tipo	Obrigatório	Descrição
overrides	MetricsOverrides[]	Não	Defina o método de geração personalizado e a apresentação para uma métrica específica ou para todas as métricas padrão predefinidas.
providers	ProviderRef[]	Não	Indica o nome dos provedores aos quais a configuração se aplica. Defina o valor como prometheus.

AccessLogging

Campo	Tipo	Obrigatório	Descrição
disabled	bool	Não	Controla o comportamento de log.
providers	ProviderRef[]	Não	Especifica o nome dos provedores aos quais a configuração se aplica. Defina o valor como envoy.

WorkloadSelector

Campo	Tipo	Obrigatório	Descrição
matchLabels	map<string, string>	Não	Defina um ou mais rótulos que indicam o conjunto de pods ou máquinas virtuais (VMs) aos quais a política se aplica. A busca por rótulos restringe-se ao namespace de configuração onde o recurso reside.

CustomTag

Campo	Tipo	Obrigatório	Descrição
literal	Tracing.Literal	Não	Adiciona o mesmo valor codificado a cada span.
environment	Tracing.Environment	Não	Inclui o valor de uma variável de ambiente em cada span.
header	Tracing.RequestHeader	Não	Acrescenta o valor de um cabeçalho da requisição a cada span.

MetricsOverrides

Campo	Tipo	Obrigatório	Descrição
match	WorkloadSelector	Não	Corresponde às métricas a substituir. Adicione e configure todas as métricas de cliente e servidor.
disabled	bool	Não	Indica se o relatório de métricas deve ser desativado. Se definido como true, o sistema desativa o relatório de métricas.
tagOverrides	map<string, MetricsOverrides>	Não	Especifica uma coleção de nomes e expressões de tags a substituir na métrica selecionada.

MetricSelector

Campo	Tipo	Obrigatório	Descrição
metric	MetricSelector.IstioMetric	Não	Identifica uma métrica.
mode	WorkloadMode	Não	Defina o modo de geração de métricas. Valores válidos: CLIENT e SERVER.

ProviderRef

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Especifica o nome do provedor de Telemetry no MeshConfig.

Tracing.Literal

Campo	Tipo	Obrigatório	Descrição
value	string	Sim	Valor da tag a utilizar.

Tracing.Environment

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Nome da variável de ambiente da qual extrair o valor da tag.
defaultValue	string	Não	Valor padrão utilizado caso a variável de ambiente não seja encontrada.

Tracing.RequestHeader

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do cabeçalho do qual extrair o valor da tag.
defaultValue	string	Não	Valor padrão utilizado caso o cabeçalho não seja encontrado.

MetricsOverrides.TagOverride

Campo	Tipo	Obrigatório	Descrição
operation	MetricsOverrides.TagOverride.Operation	Não	Determina se uma tag deve ser atualizada, adicionada ou removida.
value	string	Não	Valor da tag, utilizado apenas quando `operation` estiver definido como `UPSERT`.

MetricSelector.IstioMetric

Nome	Descrição
REQUEST_COUNT	Contador de requisições HTTP, HTTP/2 e gRPC enviadas para ou recebidas de uma aplicação
REQUEST_DURATION	Duração das requisições HTTP, HTTP/2 e gRPC
REQUEST_SIZE	Tamanho do corpo das requisições HTTP, HTTP/2 e gRPC
RESPONSE_SIZE	Tamanho do corpo das respostas HTTP, HTTP/2 e gRPC
TCP_OPENED_CONNECTIONS	Contador de conexões TCP abertas durante o ciclo de vida de um workload
TCP_CLOSED_CONNECTIONS	Contador de conexões TCP fechadas durante o ciclo de vida de um workload
TCP_SENT_BYTES	Contador de bytes enviados durante uma resposta em uma conexão TCP
TCP_RECEIVED_BYTES	Contador de bytes recebidos durante uma resposta em uma conexão TCP
GRPC_REQUEST_MESSAGES	Contador de mensagens gRPC enviadas por um cliente
GRPC_RESPONSE_MESSAGES	Contador de mensagens gRPC enviadas por um servidor

MetricsOverrides.TagOverride.Operation

Nome	Descrição
UPSERT	Indica que a tag deve ser inserida ou atualizada.
REMOVE	Determina que a tag não deve ser incluída na métrica durante sua geração.

WorkloadMode

Nome	Descrição
CLIENT	Selecione este valor para cenários em que o workload é a origem do tráfego de rede.
SERVER	Utilize este valor para cenários em que o workload é o destino do tráfego de rede.

Precauções

Em princípio, os campos não descritos neste tópico mantêm compatibilidade entre o ASM e a versão correspondente do Istio. Como o console do ASM não oferece suporte à edição desses campos, atualize-os diretamente no recurso personalizado (CR) Telemetry correspondente por meio do kubectl ou de outros métodos. Para obter mais informações sobre os campos da CRD Telemetry, consulte Telemetry.