Configurazione del demone AWS X-Ray

È possibile utilizzare le opzioni della riga di comando o un file di configurazione per personalizzare il comportamento del demone X-Ray. La maggior parte delle opzioni sono disponibili utilizzando entrambi i metodi, ma alcune sono disponibili solo per i file di configurazione e alcune solo utilizzando la riga di comando.

Per iniziare, l'unica opzione che devi conoscere è -n or--region, che usi per impostare la regione che il demone usa per inviare i dati di traccia a X-Ray.

~/xray-daemon$ ./xray -n us-east-2

Se esegui il daemon localmente, ovvero non su Amazon EC2, puoi aggiungere l'opzione di saltare il controllo delle credenziali -o del profilo, ad esempio, in modo che il daemon sia pronto più rapidamente.

~/xray-daemon$ ./xray -o -n us-east-2

Il resto delle opzioni della riga di comando consentono di configurare le opzioni di log, ascoltare su una porta diversa, limitare la quantità di memoria che il daemon può utilizzare o assumere un ruolo per l'invio dei dati di tracciamento a un altro account.

È possibile passare un file di configurazione al demone per accedere a opzioni di configurazione avanzate e fare cose come limitare il numero di chiamate simultanee a X-Ray, disabilitare la rotazione dei log e inviare traffico a un proxy.

Variabili di ambiente supportate

Il demone X-Ray supporta le seguenti variabili di ambiente:

• AWS_REGION— specifica l'endpoint Regione AWSdel servizio X-Ray.

• HTTPS_PROXY— Speciifica un indirizzo proxy per il demone tramite il quale caricare i segmenti. Può trattarsi dei nomi di dominio DNS o degli indirizzi IP e dei numeri di porta utilizzati dai server proxy.

Utilizzo delle opzioni della riga di comando

Passa queste opzioni al daemon quando lo esegui in locale o tramite un script dati utente.

Opzioni della riga di comando

• -b, --bind — Ascolta i documenti dei segmenti su una porta UDP diversa.

  --bind "127.0.0.1:3000"

  Predefinito:2000.

• -t, --bind-tcp — Ascolta le chiamate al servizio X-Ray su una porta TCP diversa.

  -bind-tcp "127.0.0.1:3000"

  Predefinito:. 2000

• -c, --config — Carica un file di configurazione dal percorso specificato.

  --config "/home/ec2-user/xray-daemon.yaml"

• -f, --log-file — Registri di output nel percorso del file specificato.

  --log-file "/var/log/xray-daemon.log"

• -l, --log-level — Livello di log, dal più dettagliato al meno dettagliato: dev, debug, info, warn, error, prod.

  --log-level warn

  Predefinito: prod

• -m, --buffer-memory — Modifica la quantità di memoria in MB che i buffer possono utilizzare (minimo 3).

  --buffer-memory 50

  Impostazione predefinita: 1% della memoria disponibile.

• -o, --local-mode — Non controllare i metadati delle istanze EC2.

• -r, --role-arn — Assumi il ruolo IAM specificato per caricare i segmenti su un altro account.

  --role-arn "arn:aws:iam::123456789012:role/xray-cross-account"

• -a, --resource-arn — Amazon Resource Name (ARN) della AWS risorsa che esegue il daemon.

• -p, --proxy-address — Carica i segmenti tramite un proxy. AWS X-Ray È necessario specificare il protocollo del server proxy.

  --proxy-address "http://192.0.2.0:3000"

• -n, --region — Invia segmenti al servizio X-Ray in una regione specifica.

• -v, --version — Mostra la versione del AWS X-Ray demone.

• -h, --help — Mostra la schermata di aiuto.

Utilizzo di un file di configurazione

Per configurare il daemon puoi anche utilizzare un file in formato YAML. Trasferisci il file di configurazione al daemon utilizzando l'opzione -c.

~$ ./xray -c ~/xray-daemon.yaml

Opzioni file di configurazione

• TotalBufferSizeMB— Dimensione massima del buffer in MB (minimo 3). Scegli 0 per utilizzare l'1% della memoria dell'host.

• Concurrency— Numero massimo di chiamate simultanee per caricare documenti AWS X-Ray di segmento.

• Region— Invia segmenti al AWS X-Ray servizio in una regione specifica.

• Socket— Configura l'associazione del demone.

  • UDPAddress— Cambia la porta su cui il demone ascolta.

  • TCPAddress— Ascolta le chiamate al servizio X-Ray su una porta TCP diversa.

• Logging— Configura il comportamento di registrazione.

  • LogRotation— Impostato per false disabilitare la rotazione dei log.

  • LogLevel— Modifica il livello di registro, dal più dettagliato al meno:dev,debug, info oprod, warnerror,prod. L'impostazione predefinita èprod, che è equivalente ainfo.

  • LogPath— Registri di output nel percorso del file specificato.

• LocalMode— Impostato per true ignorare il controllo dei metadati delle istanze EC2.

• ResourceARN— Amazon Resource Name (ARN) della AWS risorsa che esegue il daemon.

• RoleARN— Assumi il ruolo IAM specificato per caricare i segmenti su un altro account.

• ProxyAddress— Carica i segmenti AWS X-Ray tramite un proxy.

• Endpoint— Modificare l'endpoint del servizio X-Ray a cui il demone invia i documenti del segmento.

• NoVerifySSL— Disabilita la verifica del certificato TLS.

• Version— Versione del formato del file di configurazione del demone. La versione del formato del file è un campo obbligatorio.

Esempio Xray-daemon.yaml

Questo file di configurazione modifica la porta di ascolto del daemon a 3000, disattiva i controlli dei metadati dell'istanza, imposta un ruolo da utilizzare per il caricamento dei segmenti e modifica regione e opzioni di logging.

Socket:
  UDPAddress: "127.0.0.1:3000"
  TCPAddress: "127.0.0.1:3000"
Region: "us-west-2"
Logging:
  LogLevel: "warn"
  LogPath: "/var/log/xray-daemon.log"
LocalMode: true
RoleARN: "arn:aws:iam::123456789012:role/xray-cross-account"
Version: 2