Configurazione delle regole di AWS X-Ray campionamento per le API API Gateway

Puoi utilizzare la AWS X-Ray console o l'SDK per configurare le regole di campionamento per la tua API Amazon API Gateway. Una regola di campionamento specifica le richieste che X-Ray deve registrare per l'API. Personalizzando le regole di campionamento è possibile controllare la quantità di dati da registrare e modificare immediatamente il campionamento senza dover cambiare o ridistribuire il codice.

Prima di specificare le regole di campionamento di X-Ray, leggere i seguenti argomenti nella Guida per gli sviluppatori di X-Ray:

• Configurazione delle regole di campionamento nella console AWS X-Ray

• Utilizzo delle regole di campionamento con l'API X-Ray

Valori delle opzioni delle regole di campionamento di X-Ray per le API di API Gateway

Le seguenti opzioni di campionamento di X-Ray sono rilevanti per API Gateway. I valori di stringa possono utilizzare caratteri jolly per corrispondere a un solo carattere (?) o a zero o più caratteri (*). Per ulteriori dettagli, inclusa una spiegazione dettagliata di come vengono utilizzate le impostazioni Reservoir e Rate, vedere Configurazione delle regole di campionamento nella console. AWS X-Ray

• Nome regola (stringa): un nome univoco per la regola.

• Priorità (numero intero compreso tra 1 e 9999): la priorità della regola di campionamento. I servizi valutano le regole in ordine crescente di priorità e prendono una decisione sul campionamento in base alla prima regola corrispondente.

• Riserva (numero intero non negativo): un numero fisso di richieste che rispettano il filtro da analizzare ogni secondo, prima di applicare la percentuale fissa. Il reservoir non viene utilizzato direttamente dai servizi, ma si applica a tutti i servizi che utilizzano la regola nel loro complesso.

• Percentuale (numero tra 0 e 100): la percentuale di richieste che rispettano il filtro da analizzare dopo l'esaurimento della riserva.

• Nome servizio (stringa): nome della fase API, nel formato {api-name}/{stage-name}. Ad esempio, se dovessi distribuire l'API di PetStoreesempio in una fase denominatatest, il valore del nome del servizio da specificare nella regola di campionamento sarebbe. pets/test

• Tipo servizio (stringa): per un'API di API Gateway è possibile specificare sia AWS::ApiGateway::Stage che AWS::ApiGateway::*.

• Host (stringa): il nome host ricavato dall'intestazione HTTP host. Per la corrispondenza a tutti i nome host, va impostato su *. Si può anche specificare un nome host completo o parziale di corrispondenza, ad esempio api.example.com o *.example.com.

• Resource ARN (ARN risorsa) (stringa): l'ARN della fase API, ad esempio arn:aws:apigateway:region::/restapis/api-id/stages/stage-name.

  Il nome di fase si può ricavare dalla console, dall'interfaccia a riga di comando o dall'API di API Gateway. Per ulteriori informazioni sui formati degli ARN, consulta Riferimenti generali di Amazon Web Services.

• Metodo HTTP (stringa): il metodo da campionare, ad esempio GET.

• URL path (Percorso URL) (stringa): il percorso dell'URL della richiesta.

• (opzionale) Attributi (chiave e valore): intestazioni provenienti dalla richiesta HTTP originale, ad esempio Connection, Content-Length o Content-Type. Ogni valore dell'attributo può contenere fino a 32 caratteri.

Esempi di regole di campionamento di X-Ray

Esempio 1 di regola di campionamento

Questa regola campiona tutte le richieste GET per l'API testxray nella fase test.

• Nome regola — test-sampling

• Priorità — 17

• Dimensioni riserva — 10

• Percentuale fissa — 10

• Nome servizio — testxray/test

• Tipo servizio — AWS::ApiGateway::Stage

• Metodo HTTP — GET

• ARN risorsa — *

• Host — *

Esempio 2 di regola di campionamento

Questa regola campiona tutte le richieste testxray per l'API nella fase prod.

• Nome regola — prod-sampling

• Priorità — 478

• Dimensioni riserva — 1

• Percentuale fissa — 60

• Nome servizio — testxray/prod

• Tipo servizio — AWS::ApiGateway::Stage

• Metodo HTTP — *

• ARN risorsa — *

• Host — *

• Attributi — {}