Tracciamento delle richieste in arrivo con il middleware X-Ray SDK for Ruby

Puoi utilizzare l'SDK X-Ray per tracciare le richieste HTTP in entrata che la tua applicazione serve su un'istanza EC2 in Amazon EC2 o Amazon ECS. AWS Elastic Beanstalk

Se utilizzi Rails, utilizza il middleware Rails per analizzare le richieste HTTP in entrata. Quando aggiungi il middleware all'applicazione e configuri il nome di un segmento, X-Ray SDK for Ruby crea un segmento per ogni richiesta campionata. Tutti i segmenti creati da analisi aggiuntive diventano sottosegmenti del segmento a livello di richiesta che offre informazioni sulla richiesta e sulla risposta HTTP. Queste informazioni includono durata, metodo e conclusione della richiesta HTTP.

Ogni segmento ha un nome che identifica l'applicazione nella mappa del servizio. Il segmento può essere denominato staticamente oppure è possibile configurare l'SDK per denominarlo dinamicamente in base all'intestazione dell'host nella richiesta in entrata. La denominazione dinamica consente di raggruppare le tracce in base al nome di dominio nella richiesta e di applicare un nome predefinito se il nome non corrisponde a uno schema previsto (ad esempio, se l'intestazione dell'host è falsificata).

Richieste inoltrate

Se un sistema di bilanciamento del carico o un altro intermediario inoltra una richiesta all'applicazione, X-Ray prende l'IP del client dall'X-Forwarded-Forintestazione della richiesta anziché dall'IP di origine nel pacchetto IP. L'IP del client registrato per una richiesta inoltrata può essere falsificato, quindi non dovrebbe essere considerato attendibile.

Quando viene inoltrata una richiesta, l'SDK imposta un campo aggiuntivo nel segmento per indicarlo. Se il segmento contiene il campo x_forwarded_for impostato sutrue, l'IP del client è stato preso dall'X-Forwarded-Forintestazione della richiesta HTTP.

Il middleware crea un segmento per ogni richiesta in entrata con un blocco http che contiene le informazioni riportate qui di seguito:

• Metodo HTTP: GET, POST, PUT, DELETE, ecc.

• Indirizzo client: l'indirizzo IP del client che ha inviato la richiesta.

• Codice di risposta: il codice di risposta HTTP per la richiesta completata.

• Tempistica: l'ora di inizio (quando è stata ricevuta la richiesta) e l'ora di fine (quando è stata inviata la risposta).

• Agente utente: il user-agent codice della richiesta.

• Lunghezza del contenuto: il content-length risultato della risposta.

Utilizzo del middleware Rails

Per usare il middleware, aggiorna il tuo gemfile per includere il railtie necessario.

Esempio Gemfile - rails

gem 'aws-xray-sdk', require: ['aws-xray-sdk/facets/rails/railtie']

Per utilizzare il middleware, è inoltre necessario configurare il registratore con un nome che rappresenti l'applicazione nella mappa di traccia.

Esempio config/initializers/aws_xray.rb

Rails.application.config.xray = {
  name: 'my app'
}

Analisi manuale del codice

Se non utilizzi Rails, crea i segmenti manualmente. È possibile creare un segmento per ogni richiesta in arrivo o creare segmenti attorno ai client HTTP o AWS SDK con patch per fornire al registratore il contesto in cui aggiungere sottosegmenti.

# Start a segment
segment = XRay.recorder.begin_segment 'my_service'
# Start a subsegment
subsegment = XRay.recorder.begin_subsegment 'outbound_call', namespace: 'remote'

# Add metadata or annotation here if necessary
my_annotations = {
  k1: 'v1',
  k2: 1024
}
segment.annotations.update my_annotations

# Add metadata to default namespace
subsegment.metadata[:k1] = 'v1'

# Set user for the segment (subsegment is not supported)
segment.user = 'my_name'

# End segment/subsegment
XRay.recorder.end_subsegment
XRay.recorder.end_segment

Configurazione di una strategia di denominazione dei segmenti

AWS X-Ray utilizza un nome di servizio per identificare l'applicazione e distinguerla dalle altre applicazioni, database, API esterne e risorse utilizzate dall'applicazione. AWS Quando X-Ray SDK genera segmenti per le richieste in entrata, registra il nome del servizio dell'applicazione nel campo del nome del segmento.

L'X-Ray SDK può denominare i segmenti dopo il nome host nell'intestazione della richiesta HTTP. Tuttavia, questa intestazione può essere falsificata, il che potrebbe causare nodi imprevisti nella mappa dei servizi. Per evitare che l'SDK nomini i segmenti in modo errato a causa di richieste con intestazioni host contraffatte, è necessario specificare un nome predefinito per le richieste in entrata.

Se la tua applicazione soddisfa le richieste per più domini, puoi configurare l'SDK in modo che utilizzi una strategia di denominazione dinamica che rifletta questo aspetto nei nomi dei segmenti. Una strategia di denominazione dinamica consente all'SDK di utilizzare il nome host per le richieste che corrispondono a uno schema previsto e di applicare il nome predefinito alle richieste che non lo fanno.

Ad esempio, potresti avere una singola applicazione che serve le richieste a tre sottodomini:, e. www.example.com api.example.com static.example.com È possibile utilizzare una strategia di denominazione dinamica con lo schema *.example.com per identificare i segmenti per ogni sottodominio con un nome diverso, ottenendo tre nodi di servizio sulla mappa dei servizi. Se l'applicazione riceve richieste con un nome host che non corrisponde allo schema, sulla mappa dei servizi verrà visualizzato un quarto nodo con un nome di fallback specificato dall'utente.

Per utilizzare lo stesso nome per tutti i segmenti della richiesta, specifica il nome della tua applicazione quando configuri il registratore, come illustrato nelle sezioni precedenti.

Una strategia di denominazione dinamica definisce un modello al quale devono corrispondere i nomi degli host e un nome di default per l'utilizzo qualora il nome dell'host nella richiesta HTTP non corrisponda al modello. Per denominare segmenti in modo dinamico, specificare un modello di denominazione nel config hash.

Esempio main.rb — Denominazione dinamica

config = {
  naming_pattern: '*mydomain*',
  name: 'my app',
}

XRay.recorder.configure(config)

Puoi utilizzare '*' nel modello per una corrispondenza con qualsiasi stringa o '?' per una corrispondenza con qualsiasi carattere singolo.

Nota

È possibile sovrascrivere il nome di servizio predefinito definito nel codice con la variabile di ambiente. AWS_XRAY_TRACING_NAME