Substituições de amostragem (versão prévia) – Azure Monitor Application Insights para Java

  • Artigo

Observação

O recurso de substituição de amostragem está no GA, a partir da versão 3.5.0.

As substituições de amostragem permitem que você substitua a porcentagem de amostragem padrão, por exemplo:

  • Defina o percentual de amostragem como 0 (ou algum valor pequeno) para verificações de integridade com ruídos.
  • Defina o percentual de amostragem como 0 (ou algum valor pequeno) para chamadas de dependência com ruídos.
  • Defina o percentual de amostragem como 100 para um tipo de solicitação importante (por exemplo, /login), mesmo que você tenha a amostragem padrão configurada com um valor menor.

Terminologia

Antes de aprender sobre as substituições de amostragem, você deve entender o termo span. Span é um termo geral para:

  • Uma solicitação de entrada.
  • Uma dependência de saída (por exemplo, uma chamada remota para outro serviço).
  • Uma dependência em processo (por exemplo, trabalho sendo feito por subcomponentes do serviço).

Para substituições de amostragem, esses componentes de span são importantes:

  • Atributos

Atributos de span representam propriedades padrão e personalizadas de uma determinada solicitação ou dependência.

Introdução

Para começar, crie um arquivo de configuração chamado applicationinsights.jsem. Salve-o no mesmo diretório que applicationinsights-agent-*.jar. Use o modelo a seguir.

{
  "connectionString": "...",
  "sampling": {
    "percentage": 10
    "overrides": [
      {
        "telemetryType": "request",
        "attributes": [
          ...
        ],
        "percentage": 0
      },
      {
        "telemetryType": "request",
        "attributes": [
          ...
        ],
        "percentage": 100
      }
    ]
  }
}

Como ele funciona

telemetryType (telemetryKind no Application Insights 3.4.0) deve ser um de request, dependency, trace (log) ou exception.

Quando um span é iniciado, o tipo de span e os atributos presentes são usados para verificar se há correspondência de alguma das substituições de amostragem.

As correspondências podem ser strict ou regexp. Correspondências de expressão regular são executadas com base no valor do atributo inteiro, portanto, se você quiser corresponder a um valor que contenha abc em qualquer lugar, use .*abc.*. Uma substituição de amostragem pode especificar vários critérios de atributo, nesse caso, todos eles precisam corresponder para que a substituição de amostragem corresponda.

Se houver correspondência de uma das substituições de amostragem, o percentual de amostragem será usado para decidir se o span deve ser amostrado ou não.

Somente a primeira substituição de amostragem que corresponde é usada.

Se nenhuma substituição de amostragem corresponder:

Exemplo: suprimir coleta de telemetria para verificações de integridade

Esse exemplo suprime a coleta de telemetria para todas as solicitações de /health-checks.

Esse exemplo também suprime a coleta de todos os spans downstream (dependências) que normalmente seriam coletados como /health-checks.

{
  "connectionString": "...",
  "sampling": {
    "overrides": [
      {
        "telemetryType": "request",
        "attributes": [
          {
            "key": "url.path",
            "value": "/health-check",
            "matchType": "strict"
          }
        ],
        "percentage": 0
      }
    ]
  }
}

Exemplo: suprimir coleta de telemetria para uma chamada de dependência com ruídos

Esse exemplo suprime a coleta de telemetria para todas as chamadas GET my-noisy-key do Redis.

{
  "connectionString": "...",
  "sampling": {
    "overrides": [
      {
        "telemetryType": "dependency",
        "attributes": [
          {
            "key": "db.system",
            "value": "redis",
            "matchType": "strict"
          },
          {
            "key": "db.statement",
            "value": "GET my-noisy-key",
            "matchType": "strict"
          }
        ],
        "percentage": 0
      }
    ]
  }
}

Exemplo: coletar 100% da telemetria para um tipo de solicitação importante

Esse exemplo coleta 100% de telemetria para o /login.

Como os spans downstream (dependências) respeitam a decisão de amostragem do pai (na ausência de qualquer substituição de amostragem para esse span downstream), eles também serão coletados para todas as solicitações "/login".

{
  "connectionString": "...",
  "sampling": {
    "percentage": 10
  },
  "sampling": {
    "overrides": [
      {
        "telemetryType": "request",
        "attributes": [
          {
            "key": "url.path",
            "value": "/login",
            "matchType": "strict"
          }
        ],
        "percentage": 100
      }
    ]
  }
}

Atributos de span disponíveis para amostragem

Os nomes de atributo de span têm base nas convenções semânticas do OpenTelemetry. (HTTP, Mensagens, Banco de Dados, RPC)

https://github.com/open-telemetry/semantic-conventions/blob/main/docs/README.md

Observação

Para ver o conjunto exato de atributos capturados pelo Java do Application Insights para seu aplicativo, defina o nível de autodiagnóstico como depuração e procure mensagens de depuração que comecem com o texto "exportando span".

Observação

Somente os atributos definidos no início do intervalo estão disponíveis para amostragem, portanto, atributos como http.status_code, capturados posteriormente, não podem ser usados para amostragem.

Solução de problemas

Se você usar regexp e a substituição de amostragem não funcionar, tente com a expressão regular .*. Se a amostragem funcionar agora, isso significa que você tem um problema com a primeira expressão regular e deve ler essa documentação sobre expressões regulares.

Se isso não funcionar com .*, você poderá ter um problema de sintaxe em seu application-insights.json file. Examine os logs do Application Insights e veja se existem mensagens de aviso.