Cadenas de conexión en Application Insights

Artículo
10/29/2024

Las cadenas de conexión especifican en qué recurso de Application Insights la aplicación instrumentada debe enviar datos de telemetría. Una cadena de conexión se compone de varias configuraciones, cada una representada como un par clave-valor y separadas por punto y coma. Este método de configuración consolidado simplifica el proceso de configuración eliminando la necesidad de varias opciones de proxy.

Importante

La cadena de conexión contiene una iKey, que es un identificador único que usa el servicio de ingesta para asociar la telemetría a un recurso específico de Application Insights. Los identificadores únicos ikey no son tokens ni claves de seguridad ni se consideran secretos.

Si desea proteger su recurso de Application Insights contra el uso indebido, el punto de conexión de ingesta proporciona opciones de ingesta de telemetría autenticadas basadas en Microsoft Entra ID.

Nota:

El 31 de marzo de 2025 finalizará la compatibilidad con la ingesta de claves de instrumentación. La ingesta de claves de instrumentación seguirá funcionando, pero la característica ya no recibirá actualizaciones ni soporte técnico. Transición a las cadenas de conexión para aprovechar las nuevas funcionalidades.

Funcionalidades de cadena de conexión

Fiabilidad: las cadenas de conexión hacen que la ingesta de telemetría sea más confiable mediante la eliminación de dependencias en los puntos de conexión de ingesta globales.
Seguridad: las cadenas de conexión permiten la ingesta de telemetría autenticada mediante la autenticación de Microsoft Entra para Application Insights.
Puntos de conexión personalizados (entornos de nube soberana o híbrida): la configuración del punto de conexión permite enviar datos a una región específica de Azure Government. (Ver ejemplos.)
Privacidad (puntos de conexión regionales): las cadenas de conexión facilitan los problemas de privacidad mediante el envío de datos a puntos de conexión regionales, lo que garantiza que los datos no salen de una región geográfica.

Búsqueda de la cadena de conexión

La cadena de conexión aparece en la sección de información general del recurso de Application Insights.

Schema

Los elementos de esquema se explican en las siguientes secciones.

Longitud máxima

La conexión tiene una longitud máxima admitida de 4,096 caracteres.

Pares de clave-valor

Una cadena de conexión consta de una lista de valores de configuración representados como pares de clave-valor separados por punto y coma: key1=value1;key2=value2;key3=value3

Sugerencia

Los pares clave-valor configurables se tratan en este documento. Algunos pares clave-valor no se pueden configurar y se establecen automáticamente, como ApplicationId. Estos se pueden omitir de forma segura si se observan en su entorno.

Sintaxis

InstrumentationKey (por ejemplo, 00000000-0000-0000-0000-000000000000). InstrumentationKey es un campo obligatorio.
Authorization (por ejemplo, ikey). Este valor es opcional porque actualmente no se admite la autorización mediante ikey.
EndpointSuffix (por ejemplo, applicationinsights.azure.cn). Al establecer el sufijo del punto de conexión, se indicará al SDK a qué nube de Azure se conectará. El SDK ensamblará el resto del punto de conexión para los servicios individuales.
Puntos de conexión explícitos. Cualquier servicio se puede invalidar explícitamente en la cadena de conexión:
- IngestionEndpoint (por ejemplo, https://dc.applicationinsights.azure.com)
- LiveEndpoint (por ejemplo, https://live.applicationinsights.azure.com)
- ProfilerEndpoint (por ejemplo, https://profiler.monitor.azure.com)
- SnapshotEndpoint (por ejemplo, https://snapshot.monitor.azure.com)

Esquema del punto de conexión

<prefix>.<suffix>

Prefijo: define un servicio.
Sufijo: define el nombre de dominio común.

Sufijos válidos

applicationinsights.azure.cn
applicationinsights.us

Para obtener más información, consulte Regiones que requieren modificación del punto de conexión.

Prefijos válidos

Ingesta de telemetría: dc
Live Metrics: live
Profiler: profiler
Instantánea: snapshot

Ejemplos de cadena de conexión

A continuación, se incluyen algunos ejemplos de cadenas de conexión.

Cadena de conexión con sufijo de punto de conexión

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

En este ejemplo, la cadena de conexión especifica el sufijo del punto final y el SDK construye los puntos finales del servicio:

El esquema de autorización tiene como valor predeterminado "ikey".
Clave de instrumentación: 00000000-0000-0000-0000-000000000000
Los identificadores uniformes de recursos (URI) del servicio regional se basan en el sufijo de punto de conexión proporcionado:
- Ingesta: https://dc.ai.contoso.com
- Live Metrics: https://live.ai.contoso.com
- Profiler: https://profiler.ai.contoso.com
- Depurador: https://snapshot.ai.contoso.com

Cadena de conexión con invalidaciones explícitas del punto de conexión

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/;

En este ejemplo, esta cadena de conexión especifica invalidaciones explícitas para cada servicio. El SDK usará los puntos de conexión exactos proporcionados sin modificaciones:

El esquema de autorización tiene como valor predeterminado "ikey".
Clave de instrumentación: 00000000-0000-0000-0000-000000000000
Los identificadores URI de servicio regional se basan en los valores de invalidación explícitos:
- Ingesta: https://custom.com:111/
- Live Metrics: https://custom.com:222/
- Profiler: https://custom.com:333/
- Depurador: https://custom.com:444/

Cadena de conexión con una región explícita

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

En este ejemplo, la cadena de conexión especifica la región Centro y Sur de EE. UU:

El esquema de autorización tiene como valor predeterminado "ikey".
Clave de instrumentación: 00000000-0000-0000-0000-000000000000
Los identificadores URI de servicio regional se basan en los valores de invalidación explícitos:
- Ingesta: https://southcentralus.in.applicationinsights.azure.com/

Para enumerar las regiones disponibles, ejecute el siguiente comando en la CLI de Azure:

az account list-locations -o table

Establezca una cadena de conexión

Todas nuestras ofertas de OpenTelemetry y las siguientes versiones del SDK admiten cadenas de conexión:

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

Puede establecer una cadena de conexión en el código o mediante una variable de entorno o un archivo de configuración.

Variable del entorno

Cadena de conexión: APPLICATIONINSIGHTS_CONNECTION_STRING

Ejemplos de código

Lenguaje	Classic API	OpenTelemetry
ASP.NET Core	SDK de Application Insights	AzMon OTel Distro
.NET Framework	SDK de Application Insights	AzMon Exporter
Java	N/D	Agente de Java
JavaScript	Script del cargador del SDK de JavaScript (Web)	N/D
Node.js	SDK de Application Insights	AzMon OTel Distro
Python	OpenCensus Python SDK	AzMon OTel Distro

Preguntas más frecuentes

Esta sección proporciona respuestas a preguntas comunes.

¿Es necesario usar cadenas de conexión en las nuevas regiones de Azure?

Las nuevas regiones de Azure requieren el uso de cadenas de conexión en lugar de claves de instrumentación. Una cadena de conexión identifica el recurso al que quiere asociar los datos de telemetría. También permite modificar los puntos de conexión que usa el recurso como destino de la telemetría. Copie la cadena de conexión y agregarla al código de la aplicación o a una variable de entorno.

¿Debo usar cadenas de conexión o claves de instrumentación?

Se recomienda usar cadenas de conexión en lugar de claves de instrumentación.

Pasos siguientes

Comience en el tiempo de ejecución con:

Comience en el tiempo de desarrollo con:

Compartir vía