Připojovací řetězceConnection strings

PřehledOverview

Připojovací řetězce poskytují uživatelům přehledné aplikace s jediným nastavením konfigurace, což eliminuje nutnost více nastavení proxy serveru.Connection strings provide Application Insight users with a single configuration setting, eliminating the need for multiple proxy settings. Vysoce užitečné pro intranetové webové servery, svrchované nebo hybridní cloudové prostředí, které se pokouší odeslat data do monitorovací služby.Highly useful for intranet web servers, sovereign or hybrid cloud environments looking to send in data to the monitoring service.

Páry klíč-hodnota poskytují uživatelům snadný způsob, jak definovat kombinaci přípony předpony pro každou službu a produkt Application Insights (AI).The key value pairs provide an easy way for users to define a prefix suffix combination for each Application Insights (AI) service/ product.

Důležité

Nedoporučujeme nastavovat připojovací řetězec a klíč instrumentace.We don't recommend setting both Connection String and Instrumentation key. V případě, že uživatel nastavení nastavil, podle toho, co byl nastaven jako poslední, bude mít přednost.In the event that a user does set both, whichever was set last will take precedence.

Přehled scénářeScenario overview

Scénáře zákazníků, kde vizualizuji, že to má největší dopad:Customer scenarios where we visualize this having the most impact:

  • Výjimky brány firewall nebo přesměrování proxyFirewall exceptions or proxy redirects

    V případech, kdy je vyžadováno monitorování pro intranetový webový server, jsme naši starší řešení požádali o přidání jednotlivých koncových bodů služby do vaší konfigurace.In cases where monitoring for intranet web server is required, our earlier solution asked customers to add individual service endpoints to your configuration. Další informace najdete tady.For more information, see here. Připojovací řetězce nabízejí lepší alternativu tím, že se toto úsilí omezuje na jedno nastavení.Connection strings offer a better alternative by reducing this effort to a single setting. Jednoduchá předpona, změna přípony umožňuje automatické plnění a přesměrování všech koncových bodů do správných služeb.A simple prefix, suffix amendment allows automatic population and redirection of all endpoints to the right services.

  • Svrchovaná nebo hybridní cloudová prostředíSovereign or Hybrid cloud environments

    Uživatelé mohou odesílat data do definované oblasti Azure Government.Users can send data to a defined Azure Government Region. Připojovací řetězce umožňují definovat nastavení koncových bodů pro intranetové servery nebo nastavení hybridního cloudu.Connection strings allow you to define endpoint settings for your intranet servers or hybrid cloud settings.

ZačínámeGetting started

Hledáte připojovací řetězec?Finding my connection string?

Váš připojovací řetězec se zobrazí v okně Přehled prostředku Application Insights.Your connection string is displayed on the Overview blade of your Application Insights resource.

připojovací řetězec pro okno s přehledem

SchémaSchema

Maximální délkaMax length

Připojení má maximální podporovanou délku 4096 znaků.The connection has a maximum supported length of 4096 characters.

Páry klíč-hodnotaKey-value pairs

Připojovací řetězec se skládá ze seznamu nastavení reprezentovaného jako páry klíč-hodnota oddělených středníkem: key1=value1;key2=value2;key3=value3Connection string consists of a list of settings represented as key-value pairs separated by semicolon: key1=value1;key2=value2;key3=value3

SyntaxSyntax

  • InstrumentationKey (např.: 00000000-0000-0000-0000-000000000000) Připojovací řetězec je povinné pole.InstrumentationKey (ex: 00000000-0000-0000-0000-000000000000) The connection string is a required field.
  • Authorization (např.: ikey) (Toto nastavení je volitelné, protože dnes podporujeme jenom autorizaci ikey.)Authorization (ex: ikey) (This setting is optional because today we only support ikey authorization.)
  • EndpointSuffix (např.: applicationinsights.azure.cn) Nastavením přípony koncového bodu budete dát pokyn k sadě SDK, ke které se cloud Azure připojuje.EndpointSuffix (ex: applicationinsights.azure.cn) Setting the endpoint suffix will instruct the SDK which Azure cloud to connect to. Sada SDK bude sestavovat zbytek koncového bodu pro jednotlivé služby.The SDK will assemble the rest of the endpoint for individual services.
  • Explicitní koncové body.Explicit Endpoints. Jakoukoli službu lze explicitně přepsat v připojovacím řetězci.Any service can be explicitly overridden in the connection string.
    • IngestionEndpoint (např. https://dc.applicationinsights.azure.com )IngestionEndpoint (ex: https://dc.applicationinsights.azure.com)
    • LiveEndpoint (např. https://live.applicationinsights.azure.com )LiveEndpoint (ex: https://live.applicationinsights.azure.com)
    • ProfilerEndpoint (např. https://profiler.applicationinsights.azure.com )ProfilerEndpoint (ex: https://profiler.applicationinsights.azure.com)
    • SnapshotEndpoint (např. https://snapshot.applicationinsights.azure.com )SnapshotEndpoint (ex: https://snapshot.applicationinsights.azure.com)

Schéma koncového boduEndpoint schema

<prefix>.<suffix>

  • Prefix: definuje službu.Prefix: Defines a service.
  • Přípona: definuje běžný název domény.Suffix: Defines the common domain name.
Platné příponyValid suffixes

Tady je seznam platných přípon.Here's a list of valid suffixes

  • applicationinsights.azure.cnapplicationinsights.azure.cn
  • applicationinsights.usapplicationinsights.us

Viz také: https://docs.microsoft.com/azure/azure-monitor/app/custom-endpoints#regions-that-require-endpoint-modificationSee also: https://docs.microsoft.com/azure/azure-monitor/app/custom-endpoints#regions-that-require-endpoint-modification

Platné předponyValid prefixes

Příklady připojovacího řetězceConnection string examples

Minimální platný připojovací řetězecMinimal valid connection string

InstrumentationKey=00000000-0000-0000-0000-000000000000;

V tomto příkladu se nastavil jenom klíč instrumentace.In this example, only the Instrumentation Key has been set.

  • Ve výchozím nastavení se schéma autorizace používá jako "ikey".Authorization scheme defaults to "ikey"
  • Klíč instrumentace: 00000000-0000-0000-0000-000000000000Instrumentation Key: 00000000-0000-0000-0000-000000000000
  • Identifikátory URI regionálních služeb jsou založené na výchozích hodnotách sady SDK a připojovat se k veřejnému globálnímu Azure:The regional service URIs are based on the SDK defaults and will connect to the public global Azure:
    • Ingestování https://dc.services.visualstudio.com/Ingestion: https://dc.services.visualstudio.com/
    • Živé metriky: https://rt.services.visualstudio.com/Live metrics: https://rt.services.visualstudio.com/
    • Modulu https://agent.azureserviceprofiler.net/Profiler: https://agent.azureserviceprofiler.net/
    • Ladění https://agent.azureserviceprofiler.net/Debugger: https://agent.azureserviceprofiler.net/

Připojovací řetězec s příponou koncového boduConnection string with endpoint suffix

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

V tomto příkladu tento připojovací řetězec Určuje příponu koncového bodu a sada SDK vytvoří koncové body služby.In this example, this connection string specifies the endpoint suffix and the SDK will construct service endpoints.

  • Ve výchozím nastavení se schéma autorizace používá jako "ikey".Authorization scheme defaults to "ikey"
  • Klíč instrumentace: 00000000-0000-0000-0000-000000000000Instrumentation Key: 00000000-0000-0000-0000-000000000000
  • Identifikátory URI regionálních služeb jsou založené na zadané příponě koncového bodu:The regional service URIs are based on provided endpoint suffix:
    • Ingestování https://dc.ai.contoso.comIngestion: https://dc.ai.contoso.com
    • Živé metriky: https://live.ai.contoso.comLive metrics: https://live.ai.contoso.com
    • Modulu https://profiler.ai.contoso.comProfiler: https://profiler.ai.contoso.com
    • Ladění https://snapshot.ai.contoso.comDebugger: https://snapshot.ai.contoso.com

Připojovací řetězec s explicitním přepsáním koncového boduConnection string with explicit endpoint overrides

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

V tomto příkladu tento připojovací řetězec Určuje Explicitní přepsání pro každou službu.In this example, this connection string specifies explicit overrides for every service. Sada SDK bude používat přesné koncové body, které jsou poskytovány beze změny.The SDK will use the exact endpoints provided without modification.

  • Ve výchozím nastavení se schéma autorizace používá jako "ikey".Authorization scheme defaults to "ikey"
  • Klíč instrumentace: 00000000-0000-0000-0000-000000000000Instrumentation Key: 00000000-0000-0000-0000-000000000000
  • Identifikátory URI regionálních služeb jsou založené na explicitních hodnotách přepsání:The regional service URIs are based on the explicit override values:
    • Ingestování https://custom.com:111/Ingestion: https://custom.com:111/
    • Živé metriky: https://custom.com:222/Live metrics: https://custom.com:222/
    • Modulu https://custom.com:333/Profiler: https://custom.com:333/
    • Ladění https://custom.com:444/Debugger: https://custom.com:444/

Nastavení připojovacího řetězceHow to set a connection string

Připojovací řetězce jsou podporovány v následujících verzích sady SDK:Connection Strings are supported in the following SDK versions:

  • .NET a .NET Core v 2.12.0.NET and .NET Core v2.12.0
  • Java v 2.5.1 a Java 3,0Java v2.5.1 and Java 3.0
  • JavaScript v 2.3.0JavaScript v2.3.0
  • NodeJS v 1.5.0NodeJS v1.5.0
  • Python v 1.0.0Python v1.0.0

Připojovací řetězec může být nastaven buď v kódu, v proměnné prostředí, nebo v konfiguračním souboru.A connection string can be set by either in code, environment variable, or configuration file.

Proměnná prostředíEnvironment variable

  • Připojovací řetězec: APPLICATIONINSIGHTS_CONNECTION_STRINGConnection String: APPLICATIONINSIGHTS_CONNECTION_STRING

TelemetryConfiguration. ConnectionString: https://github.com/microsoft/ApplicationInsights-dotnet/blob/add45ceed35a817dc7202ec07d3df1672d1f610d/BASE/src/Microsoft.ApplicationInsights/Extensibility/TelemetryConfiguration.cs#L271-L274TelemetryConfiguration.ConnectionString: https://github.com/microsoft/ApplicationInsights-dotnet/blob/add45ceed35a817dc7202ec07d3df1672d1f610d/BASE/src/Microsoft.ApplicationInsights/Extensibility/TelemetryConfiguration.cs#L271-L274

Explicitně nastavené rozhraní .NET:.NET Explicitly Set:

var configuration = new TelemetryConfiguration
{
    ConnectionString = "InstrumentationKey=00000000-0000-0000-0000-000000000000;"
};

Konfigurační soubor .NET:.NET Config File:

<?xml version="1.0" encoding="utf-8"?>
<ApplicationInsights xmlns="http://schemas.microsoft.com/ApplicationInsights/2013/Settings">
    <ConnectionString>InstrumentationKey=00000000-0000-0000-0000-000000000000</ConnectionString>
</ApplicationInsights>

Explicitně nastavené NetCore:NetCore Explicitly Set:

public void ConfigureServices(IServiceCollection services)
{
    var options = new ApplicationInsightsServiceOptions { ConnectionString = "InstrumentationKey=00000000-0000-0000-0000-000000000000;" };
    services.AddApplicationInsightsTelemetry(options: options);
}

NetCore config.js:NetCore config.json:

{
  "ApplicationInsights": {
    "ConnectionString" : "InstrumentationKey=00000000-0000-0000-0000-000000000000;"
    }
  }