Configurazione degli SDK X-Ray per. NET

È possibile configurare X-Ray SDK per. NETcon plugin per includere informazioni sul servizio su cui viene eseguita l'applicazione, modificare il comportamento di campionamento predefinito o aggiungere regole di campionamento che si applicano alle richieste su percorsi specifici.

Per. NETapplicazioni web, aggiungi le chiavi alla appSettings sezione del tuo Web.config file.

<configuration>
  <appSettings>
    <add key="AWSXRayPlugins" value="EC2Plugin"/>
    <add key="SamplingRuleManifest" value="sampling-rules.json"/>
  </appSettings>
</configuration>

Per. NETCore, crea un file denominato appsettings.json con una chiave di primo livello denominataXRay.

{
  "XRay": {
    "AWSXRayPlugins": "EC2Plugin",
    "SamplingRuleManifest": "sampling-rules.json"
  }
}

Quindi, nel codice dell'applicazione, create un oggetto di configurazione e utilizzatelo per inizializzare il registratore X-Ray. Esegui questa operazione prima di inizializzare il registratore.

using Amazon.XRay.Recorder.Core;
...
AWSXRayRecorder.InitializeInstance(configuration);

Se stai strumentando un. NETApplicazione web principale, puoi anche passare l'oggetto di configurazione al UseXRay metodo quando configuri il gestore dei messaggi. Per le funzioni Lambda, usa il InitializeInstance metodo illustrato sopra.

Per ulteriori informazioni su. NETConfigurazione di baseAPI, vedere Configurare unASP. NETApp principale su docs.microsoft.com.

Plug-in

Utilizza i plug-in per aggiungere i dati sul servizio che ospita l'applicazione.

Per utilizzare un plugin, configura X-Ray SDK per. NETclient aggiungendo l'AWSXRayPluginsimpostazione. Se si applicano più plugin all'applicazione, specificarli tutti nella stessa impostazione, separati da virgole.

<configuration>
  <appSettings>
    <add key="AWSXRayPlugins" value="EC2Plugin,ElasticBeanstalkPlugin"/>
  </appSettings>
</configuration>

{
  "XRay": {
    "AWSXRayPlugins": "EC2Plugin,ElasticBeanstalkPlugin"
  }
}

Regole di campionamento

SDKUtilizza le regole di campionamento definite nella console X-Ray per determinare quali richieste registrare. La regola predefinita tiene traccia della prima richiesta ogni secondo e del cinque percento di eventuali richieste aggiuntive su tutti i servizi che inviano tracce a X-Ray. Crea regole aggiuntive nella console X-Ray per personalizzare la quantità di dati registrati per ciascuna delle tue applicazioni.

SDKApplica le regole personalizzate nell'ordine in cui sono definite. Se una richiesta corrisponde a più regole personalizzate, si SDK applica solo la prima regola.

È inoltre possibile configurare SDK per caricare le regole di campionamento da un documento. JSON SDKPossono utilizzare le regole locali come backup per i casi in cui il campionamento a raggi X non è disponibile o utilizzare esclusivamente regole locali.

{
  "version": 2,
  "rules": [
    {
      "description": "Player moves.",
      "host": "*",
      "http_method": "*",
      "url_path": "/api/move/*",
      "fixed_target": 0,
      "rate": 0.05
    }
  ],
  "default": {
    "fixed_target": 1,
    "rate": 0.1
  }
}

Questo esempio definisce una regola personalizzata e una regola predefinita. La regola personalizzata applica una frequenza di campionamento del cinque percento senza alcun numero minimo di richieste da tracciare per i percorsi. /api/move/ La regola predefinita tiene traccia della prima richiesta ogni secondo e del 10% delle richieste aggiuntive.

Lo svantaggio della definizione locale delle regole è che l'obiettivo fisso viene applicato da ciascuna istanza del registratore in modo indipendente, anziché essere gestito dal servizio X-Ray. Man mano che si installano più host, la tariffa fissa si moltiplica, rendendo più difficile il controllo della quantità di dati registrati.

Sì AWS Lambda, non è possibile modificare la frequenza di campionamento. Se la funzione viene chiamata da un servizio strumentato, le chiamate che hanno generato richieste campionate da quel servizio verranno registrate da Lambda. Se il tracciamento attivo è abilitato e non è presente alcuna intestazione di tracciamento, Lambda prende la decisione di campionamento.

Per configurare le regole di backup, comunica a X-Ray forSDK. NETper caricare le regole di campionamento da un file con l'SamplingRuleManifestimpostazione.

<configuration>
  <appSettings>
    <add key="SamplingRuleManifest" value="sampling-rules.json"/>
  </appSettings>
</configuration>

{
  "XRay": {
    "SamplingRuleManifest": "sampling-rules.json"
  }
}

Per utilizzare solo regole locali, crea un registratore con una LocalizedSamplingStrategy. Se si dispone di regole di backup configurate, rimuovere tale configurazione.

var recorder = new AWSXRayRecorderBuilder().WithSamplingStrategy(new LocalizedSamplingStrategy("samplingrules.json")).Build();
AWSXRayRecorder.InitializeInstance(recorder: recorder);

var recorder = new AWSXRayRecorderBuilder().WithSamplingStrategy(new LocalizedSamplingStrategy("sampling-rules.json")).Build();
AWSXRayRecorder.InitializeInstance(configuration,recorder);

Registrazione (. NET)

X-Ray SDK per. NETutilizza lo stesso meccanismo di registrazione di. AWS SDK for .NET Se hai già configurato l'applicazione per registrare l' AWS SDK for .NET output, la stessa configurazione si applica all'output dell'X-Ray forSDK. NET.

Per configurare il log, aggiungi una sezione di configurazione denominata aws al tuo file App.config o al tuo file Web.config.

...
<configuration>
  <configSections>
    <section name="aws" type="Amazon.AWSSection, AWSSDK.Core"/>
  </configSections>
  <aws>
    <logging logTo="Log4Net"/>
  </aws>
</configuration>

Per ulteriori informazioni, consulta Configurazione dell'applicazione AWS SDK for .NET nella Guida per gli sviluppatori di AWS SDK for .NET .

Registrazione (. NETNucleo)

X-Ray SDK per. NETutilizza le stesse opzioni di registrazione di. AWS SDK for .NET Per configurare la registrazione per. NETApplicazioni principali, passate l'opzione di registrazione al AWSXRayRecorder.RegisterLogger metodo.

Ad esempio, per utilizzare log4net, è necessario creare un file di configurazione che definisca il logger, formato di output e la posizione del file.

<?xml version="1.0" encoding="utf-8" ?>
<log4net>
  <appender name="FileAppender" type="log4net.Appender.FileAppender,log4net">
    <file value="c:\logs\sdk-log.txt" />
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%date [%thread] %level %logger - %message%newline" />
    </layout>
  </appender>
  <logger name="Amazon">
    <level value="DEBUG" />
    <appender-ref ref="FileAppender" />
  </logger>
</log4net>

Quindi creare il logger e applicare la configurazione al codice del programma.

using log4net;
using Amazon.XRay.Recorder.Core;

class Program
{
  private static ILog log;
  static Program()
  {
    var logRepository = LogManager.GetRepository(Assembly.GetEntryAssembly());
    XmlConfigurator.Configure(logRepository, new FileInfo("log4net.config"));
    log = LogManager.GetLogger(typeof(Program));
    AWSXRayRecorder.RegisterLogger(LoggingOptions.Log4Net);
  }
  static void Main(string[] args)
  {
  ...
  }
}

Per ulteriori informazioni sulla configurazione di log4net, vedere Configurazione su logging.apache.org.

Variabili di ambiente

È possibile utilizzare le variabili di ambiente per cui configurare X-RaySDK. NET. SDKSupporta le seguenti variabili.