Cadeias de conexão no Application Insights

Artigo
10/30/2024

As cadeias de conexão especificam para qual recurso do Application Insights seu aplicativo instrumentado deve enviar dados de telemetria. Uma cadeia de conexão é composta por várias configurações, cada uma representada como um par chave-valor e separada por ponto e vírgula. Esse método de configuração consolidado simplifica o processo de configuração ao eliminar a necessidade de várias configurações de proxy.

Importante

A cadeia de conexão contém um iKey, que é um identificador exclusivo usado pelo serviço de ingestão para associar a telemetria a um recurso específico do Application Insights. Identificadores exclusivos Ikey não são tokens de segurança ou chaves de segurança e não são considerados segredos.

Se você deseja proteger seu recurso do Application Insights contra uso indevido, o ponto de extremidade de ingestão fornece opções de ingestão de telemetria autenticada com base no Microsoft Entra ID.

Observação

Em 31 de março de 31, 2025, o suporte à ingestão de chave de instrumentação será encerrado. A ingestão de chave de instrumentação continuará funcionando, mas não forneceremos mais atualizações ou suporte para o recurso. Transição para cadeias de conexão para aproveitar as novas funcionalidades.

Funcionalidades da cadeia de conexão

Confiabilidade: as cadeias de conexão tornam a ingestão de telemetria mais confiável removendo dependências de pontos de extremidade de ingestão global.
Segurança: as cadeias de conexão permitem a ingestão de telemetria autenticada usando a autenticação Microsoft Entra para Application Insights.
Pontos de extremidade personalizados (ambientes de nuvem híbrida ou soberana): as configurações de ponto de extremidade permitem enviar dados para uma região específica do Azure Governamental. (Veja exemplos.)
Privacidade (pontos de extremidade regionais): cadeias de conexão facilitam as preocupações de privacidade enviando dados para pontos de extremidade regionais, garantindo que os dados não saiam de uma região geográfica.

Encontrar sua cadeia de conexão

Sua cadeia de conexão aparece na seção Visão geral do recurso do Application Insights.

Esquema

Os elementos do esquema são explicados nas seções a seguir.

Comprimento máximo

A conexão tem um comprimento com suporte máximo de 4.096 caracteres.

Pares de chave-valor

Uma cadeia de conexão consiste em uma lista de configurações representadas como pares chave-valor separados por um ponto e vírgula: key1=value1;key2=value2;key3=value3

Dica

Os pares chave-valor configuráveis são abordados nesse documento. Alguns pares chave-valor não são configuráveis e são definidos automaticamente, como ApplicationId. Esses podem ser ignorados com segurança se forem observados no seu ambiente.

Sintaxe

InstrumentationKey(por exemplo, 00000000-0000-0000-0000-000000000000). InstrumentationKey é um campo exigido.
Authorization (por exemplo, ikey). Essa configuração é opcional porque hoje só damos suporte à autorização ikey.
EndpointSuffix (por exemplo, applicationinsights.azure.cn). A definição do sufixo do ponto de extremidade informa ao SDK a qual nuvem do Azure deve se conectar. O SDK monta o restante do ponto de extremidade para serviços individuais.
Pontos de extremidade explícitos. Qualquer serviço pode ser explicitamente substituído na cadeia de conexão:
- IngestionEndpoint (por exemplo, https://dc.applicationinsights.azure.com)
- LiveEndpoint (por exemplo, https://live.applicationinsights.azure.com)
- ProfilerEndpoint (por exemplo, https://profiler.monitor.azure.com)
- SnapshotEndpoint (por exemplo, https://snapshot.monitor.azure.com)

Esquema do ponto de extremidade

<prefix>.<suffix>

Prefixo: Define um serviço.
Sufixo: Define o nome de domínio comum.

Sufixos válidos

applicationinsights.azure.cn
applicationinsights.us

Para obter mais informações, consulte as Regiões que exigem modificação de ponto de extremidade.

Prefixos válidos

Ingestão de telemetria: dc
Live Metrics: live
Profiler: profiler
Snapshot: snapshot

Exemplos de cadeia de conexão

Aqui estão alguns exemplos de cadeias de conexão.

Cadeia de conexão com um sufixo de ponto de extremidade

InstrumentationKey=00000000-0000-0000-0000-000000000000;EndpointSuffix=ai.contoso.com;

Neste exemplo, a cadeia de conexão especifica o sufixo do ponto de extremidade e o SDK constrói os pontos de extremidade do serviço:

O esquema de autorização assume como padrão "ikey"
Chave de instrumentação: 00000000-0000-0000-0000-000000000000
Os Identificadores Uniformes de Recurso (URIs) do serviço regional são baseados no sufixo de ponto de extremidade fornecido:
- Ingestão: https://dc.ai.contoso.com
- Live Metrics: https://live.ai.contoso.com
- Profiler: https://profiler.ai.contoso.com
- Depurador: https://snapshot.ai.contoso.com

Cadeia de conexão com sobreposição de pontos de extremidade explícitos

InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://custom.com:111/;LiveEndpoint=https://custom.com:222/;ProfilerEndpoint=https://custom.com:333/;SnapshotEndpoint=https://custom.com:444/;

Neste exemplo, a cadeia de conexão especifica substituições explícitas para cada serviço. O SDK utiliza os pontos de extremidade exatos fornecidos sem modificações:

O esquema de autorização assume como padrão "ikey"
Chave de instrumentação: 00000000-0000-0000-0000-000000000000
Os URIs de serviço regional baseiam-se nos valores de substituição explícitos:
- Ingestão: https://custom.com:111/
- Live Metrics: https://custom.com:222/
- Profiler: https://custom.com:333/
- Depurador: https://custom.com:444/

Cadeia de conexão com uma região explícita

InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://southcentralus.in.applicationinsights.azure.com/

Neste exemplo, a cadeia de conexão especifica a região Centro-Sul dos EUA:

O esquema de autorização assume como padrão "ikey"
Chave de instrumentação: 00000000-0000-0000-0000-000000000000
Os URIs de serviço regional baseiam-se nos valores de substituição explícitos:
- Ingestão: https://southcentralus.in.applicationinsights.azure.com/

Para listar as regiões disponíveis, execute o seguinte comando na CLI do Azure:

az account list-locations -o table

Definir uma cadeia de conexão

Todas as nossas ofertas do OpenTelemetry e as seguintes versões do SDK em diante dão suporte para cadeias de conexão:

.NET v2.12.0
JavaScript v2.3.0
NodeJS v1.5.0
Python v1.0.0

Você pode definir uma cadeia de conexão no código, usando uma variável de ambiente ou um arquivo de configuração.

Variável de ambiente

Cadeia de conexão: APPLICATIONINSIGHTS_CONNECTION_STRING

Exemplos de código

Idioma	API clássica	OpenTelemetry
ASP.NET Core	SDK do Application Insights	AzMon OTel Distro
.NET Framework	SDK do Application Insights	Exportador AzMon
Java	N/A	Agente de Java
JavaScript	Script do Carregador de SDK do JavaScript (Web)	N/A
Node.js	SDK do Application Insights	AzMon OTel Distro
Python	SDK do OpenCensus Python	AzMon OTel Distro

Perguntas frequentes

Esta seção fornece respostas para perguntas comuns.

As novas regiões do Azure exigem o uso de cadeias de conexão?

Novas regiões do Azure exigem o uso de cadeias de conexão em vez de chaves de instrumentação. Uma cadeia de conexão identifica o recurso com o qual você deseja associar os dados telemétricos. Ela também permite modificar os pontos de extremidade que o recurso usa como um destino para a telemetria. Copie a cadeia de conexão e adicione-a ao código do seu aplicativo ou a uma variável de ambiente.

Devo usar cadeias de conexão ou chaves de instrumentação?

Recomendamos usar cadeias de conexão em vez de chaves de instrumentação.

Próximas etapas

Introdução ao runtime com:

Introdução ao tempo de desenvolvimento com:

Compartilhar via