Opzioni di avvio di Extensible Service Proxy V2

Registra i valori delle intestazioni delle richieste specificate, separati da virgole, senza spazi. Ad esempio, imposta questo flag come:

--log_request_headers=foo,bar

Se i valori per "foo" e "bar" sono disponibili nella richiesta, il log di Endpoints contiene:

request_headers: foo=foo_value;bar=bar_value

Registra i valori delle intestazioni delle risposte specificate, separati da virgole, senza spazi. Ad esempio, imposta questo flag come:

--log_response_headers=baz,bing

Se i valori per "baz" e "bing" sono disponibili nella risposta, il log Endpoints contiene:

response_headers: baz=baz_value;bing=bing_value

Registra i valori dei campi primitivi del payload JWT specificati, separati da virgole, senza spazi. Ad esempio, imposta questo flag come:

--log_jwt_payload=sub,project_id,foo.foo_name

Se i valori sono disponibili nel payload JWT, il log Endpoints contiene:

jwt_payloads: sub=sub_value;project_id=project_id_value; foo.foo_name=foo.foo_name_value

I valori nel payload JWT devono essere campi primitivi (stringa, numero intero). Gli oggetti JSON e gli array non vengono registrati.

Se specificato, il percorso del file locale in cui verranno scritte le voci di log degli accessi.

Formato della stringa per specificare il formato del log degli accessi. Se il criterio non viene configurato, viene utilizzata la stringa di formato predefinita. Per informazioni dettagliate sulla grammatica del formato, consulta la documentazione di riferimento alle stringhe di formato.

Disattiva il tracciamento. Per impostazione predefinita, il monitoraggio è attivo.

Se abilitato, ESPv2 campiona un numero ridotto di richieste alla tua API ogni secondo per ottenere le tracce che invia a Stackdriver Trace. Per impostazione predefinita, 1 richiesta su 1000 è campionata. Utilizza il flag --tracing_sample_rate per modificare la frequenza di campionamento.

L'ID progetto Google per il tracciamento di Stackdriver.

Il tracciamento è un servizio a pagamento. Al progetto specificato verrà addebitato un costo per il tracciamento.

Per impostazione predefinita, viene fatturato l'ID progetto del servizio ESPv2 di cui è stato eseguito il deployment.

L'ID progetto viene determinato chiamando il server metadati dell'istanza Google Cloud all'avvio. Se il deployment di ESPv2 viene eseguito al di fuori di Google Cloud (utilizzando --non_gcp ), il tracciamento verrà disabilitato automaticamente a meno che questo flag non venga esplicitamente impostati.

Impostare la frequenza di campionamento della traccia su un valore compreso tra 0,0 e 1,0. Questo valore specifica la frazione di richieste campionate.

Il valore predefinito è 0,001, che equivale a 1 richieste su 1000.

Questo flag specifica quali intestazioni HTTP verificare per il contesto della traccia, con valori del flag separati da virgole senza spazi. Tieni presente che l'ordine è importante: il contesto della traccia verrà ricavato dalla prima intestazione corrispondente.

I valori possibili sono traceparent, x-cloud-trace-context e grpc-trace-bin.

Se ometti, le intestazioni traceparent e x-cloud-trace-context verranno controllate (in ordine).

Per ulteriori dettagli, consulta Tracciamento dell'API.

Imposta l'intestazione del contesto della traccia nella richiesta inviata al servizio di backend.

Questo flag specifica l'intestazione HTTP da impostare, con i valori del flag separati da virgole senza spazi.

I valori possibili includono traceparent, x-cloud-trace-context e grpc-trace-bin.

Se omesso, verranno inviate le intestazioni traceparent e x-cloud-trace-context.

Per ulteriori dettagli, consulta Tracciamento dell'API.

Specifica il file JSON della chiave dell'account di servizio per accedere ai servizi Google. Se l'opzione viene omessa, il proxy contatta il server di metadati di Google Cloud per recuperare un token di accesso.

Specifica un percorso in modo che ESPv2 possa caricare la configurazione del servizio endpoint. Con questo flag, ESPv2 utilizzerà un valore "fisso" di lancio e le seguenti verranno ignorati:

• --service
• --version
• --rollout_strategy

Questo flag impedisce a ESPv2 di utilizzare la quota dell'API Service Management.

Gli indirizzi di backend possono essere specificati utilizzando il flag --backend oppure il campo backend.rule.address nella configurazione del servizio. Per gli utenti OpenAPI, tieni presente che il campo backend.rule.address viene impostato dal campo address nell'estensione x-google-backend.

La configurazione del servizio per operazione backend.rule.address viene solitamente specificata per il routing serverless. Per impostazione predefinita, backend.rule.address avrà la priorità su il flag --backend per ogni singola operazione.

Attiva questo flag se vuoi che sia il flag --backend ad avere la priorità. Questa opzione è utile se esegui lo sviluppo su una workstation locale. Quindi puoi utilizzare la stessa configurazione del servizio di produzione, ma eseguire l'override tramite il flag --backend per i test locali.

Nota: verrà sostituito solo l'indirizzo. Continueranno a essere applicati tutti gli altri componenti di backend.rule (scadenze, autenticazione di backend, traduzione dei percorsi e così via).

Per la configurazione di HttpConnectionManager di Envoy, consulta la documentazione di riferimento di Envoy per informazioni dettagliate. L'impostazione predefinita è off.

L'espressione regolare nell'esempio precedente consente un'origine con http o https e qualsiasi sottodominio di example.com.

Quando imposti questa opzione in un file di configurazione di Kubernetes, devi aggiungere Una barra rovesciata aggiuntiva per l'interpretazione letterale a entrambe le istanze di \. nella stringa, ad esempio:

Quando imposti questa opzione nello script gcloud_build_image per Cloud Run, cerca di evitare di utilizzare caratteri con caratteri di escape e barre diagonali, poiché potrebbero non essere trasmessi correttamente dallo script bash al proxy all'avvio. Utilizza le classi di caratteri anziché le meta sequenze. Ad esempio: Original: \d Recommended: [0-9]

Imposta il timeout in secondi per le richieste effettuate a servizi esterni, ad eccezione di Backend e Google Service Control. Sono inclusi Google ServiceManagement, il server di metadati e il server Google IAM. Deve essere > 0, mentre il valore predefinito è 30 secondi se non è impostato.

In caso di errori di rete durante la connessione a Google Service Control, le richieste saranno consentite se questo flag è attivato. L'impostazione predefinita è on.

Le condizioni in cui ESPv2 esegue un nuovo tentativo sui backend. Uno o più retryOn condizioni possono essere specificate utilizzando un elenco separato da virgole. Il valore predefinito è reset,connect-failure,refused-stream. Disattiva la riprova impostando questo flag su vuoto.

Per le condizioni accettate, fai riferimento ai seguenti link:

• x-envoy-retry-on
• x-envoy-retry-grpc-on

Specifica se stampare i campi primitivi per la transcodifica grpc-json. Per impostazione predefinita, i campi primitivi con verranno omessi nell'output JSON. Ad esempio, un set di campi int32 a 0 sarà omesso. Se imposti questo flag su true, verrà eseguito l'override delle comportamento predefinito e stampare i campi primitivi a prescindere dai loro valori. Il valore predefinito è false.

Consente di specificare se stampare le enum come int per la transcodifica grpc-json. Per impostazione predefinita, vengono visualizzati come stringhe. Il valore predefinito è false.

Se true, utilizza un nuovo delimitatore di riga per separare il flusso di risposte messaggi. Se il valore è false, tutti i flussi di risposta vengono transcodificati in un array JSON.

Normalmente, i valori di enum proto devono essere in maiuscolo se utilizzati in JSON. Imposta questo flag su true se la tua richiesta JSON utilizza valori enum non in maiuscolo.

Specifica se conservare i nomi dei campi proto per la transcodifica grpc-json. Per impostazione predefinita, protobuf genera i nomi dei campi JSON utilizzando il parametro json_name o una custodia a cammello inferiore, in quest'ordine. L'impostazione di questo flag di conservare i nomi dei campi originali. Il valore predefinito è false.

Un elenco di parametri di ricerca separati da virgole da ignorare per mappatura del metodo di transcodifica nella transcodifica grpc-json. Per impostazione predefinita, il filtro dello strumento di transcodifica non transcodifica una richiesta con parametri di ricerca sconosciuti/non validi.

Specifica se ignorare parametri di ricerca che non possono essere mappati a una campo protobuf corrispondente nella transcodifica grpc-json. Da utilizzare se controllare i parametri di ricerca e non conoscerli in anticipo. Altrimenti, usa --transcoding_ignore_query_parameters. Il valore predefinito è false.

Per impostazione predefinita, i segni più "+" nei parametri di ricerca non vengono inseriti in caratteri di escape nello spazio " " nella transcodifica grpc-json. in modo da supportare HTML 2.0. Se non lo desideri, imposta questo flag su true per disabilitare questa funzionalità.

Aggiungi un'intestazione HTTP alla richiesta prima di inviarla al backend upstream. Se l'intestazione è già presente nella richiesta, il suo valore verrà sostituito con quello nuovo.

Supporta le variabili personalizzate di Envoy.

Questo argomento può essere ripetuto più volte per specificare più intestazioni. Ad esempio:
--add_request_header=key1=value1
--add_request_header=key2=value2.

Aggiungere un'intestazione HTTP alla richiesta prima di inviarla al backend a monte. Se l'intestazione è già presente nella richiesta, il nuovo valore verrà aggiunto.

Supporta le variabili personalizzate di Envoy.

Questo argomento può essere ripetuto più volte per specificare più intestazioni. Ad esempio:
--append_request_header=key1=value1
--append_request_header=key2=value2.

Aggiungi un'intestazione HTTP alla risposta prima di inviarla al client downstream. Se l'intestazione è già presente nella risposta, verrà sostituita con quella nuova.

Supporta le variabili personalizzate Envoy.

Questo argomento può essere ripetuto più volte per specificare più intestazioni. Ad esempio:
--add_response_header=key1=value1
--add_response_header=key2=value2.

Aggiungi un'intestazione HTTP alla risposta prima di inviarla al client a valle. Se l'intestazione è già presente nella risposta, verrà aggiunta quella nuova.

Supporta le variabili personalizzate di Envoy.

Questo argomento può essere ripetuto più volte per specificare più intestazioni. Ad esempio:
--append_response_header=key1=value1
--append_response_header=key2=value2.

Consente il passaggio dei nomi delle intestazioni che contengono trattini bassi. Il valore predefinito è false.

Il trattino basso è consentito nei nomi delle intestazioni da: RFC-7230. Tuttavia, questo comportamento viene implementato come misura di sicurezza perché alcuni sistemi considerano _ e - intercambiabili.

Configura la quantità massima di dati memorizzati nel buffer per ogni corpo della richiesta/risposta, in byte. Se non viene configurato, il valore predefinito viene stabilito Envoy. Vedi Configurazione del listener di Envoy.

Disabilita la normalizzazione dell'intestazione HTTP path in base a RFC 3986. Ti consigliamo di mantenere questa opzione abilitata se il tuo backend esegue la normalizzazione del percorso per impostazione predefinita.

La tabella seguente fornisce esempi della richiesta path che il backend riceverà da ESPv2 in base alla configurazione di questo flag.

        -----------------------------------------------------------------
        | Request Path     | Without Normalization | With Normalization |
        -----------------------------------------------------------------
        | /hello/../world  | Rejected              | /world             |
        | /%4A             | /%4A                  | /J                 |
        | /%4a             | /%4a                  | /J                 |
        -----------------------------------------------------------------
     

Per impostazione predefinita, ESPv2 normalizza i percorsi. Disattiva la funzionalità solo se questo comportamento influisce sul traffico.

Nota: secondo lo standard RFC 3986, questa opzione non consente di eliminare la sequenza di escape con la codifica percentuale barra, Vedi il flag --disallow_escaped_slashes_in_path a attivare questo comportamento non conforme.

Nota: normalizzazione della richiesta da RFC 3986 non è supportato, anche se è abilitata.

Per ulteriori dettagli, consulta la sezione Informazioni sui modelli di percorso.

Disattiva l'unione di barre adiacenti nell'intestazione HTTP path. Ti consigliamo di mantenere questa opzione abilitata se il tuo backend esegue l'unione per impostazione predefinita.

La tabella seguente fornisce esempi della richiesta path che il backend riceverà da ESPv2 in base alla configurazione di questo flag.

        -----------------------------------------------------------------
        | Request Path     | Without Normalization | With Normalization |
        -----------------------------------------------------------------
        | /hello//world    | Rejected              | /hello/world       |
        | /hello///        | Rejected              | /hello             |
        -----------------------------------------------------------------
     

Per impostazione predefinita, ESPv2 unisce le barre. Disattiva la funzionalità solo se questo comportamento influisce sul traffico.

Per ulteriori dettagli, consulta la sezione Informazioni sui modelli di percorso.

Non consentono le richieste con barre con codifica percentuale di escape:

• %2F o %2f viene considerato come un /
• %5C o %5c viene considerato come un \

Se questa opzione è abilitata, il comportamento dipende dal protocollo utilizzato:

• Per i backend OpenAPI, i percorsi delle richieste con codifica percentuale di escape Le barre verranno eliminate automaticamente tramite un carattere di escape tramite un reindirizzamento.
• Per i backend gRPC, i percorsi delle richieste con barre diagonali con codifica percentuale sfuggite verranno rifiutati (gRPC non supporta i reindirizzamenti).

Questa opzione non è conforme a RFC 3986, quindi è disattivata per impostazione predefinita. Se il backend non è conforme a RFC 3986 ed esegue l'escape delle barre, devi abilitare questa opzione in ESPv2. In questo modo si eviteranno attacchi di confusione nei percorsi che si traducono in problemi di sicurezza la loro applicazione.

Per ulteriori dettagli, consulta la sezione Informazioni sui modelli di percorso.

Specifica il numero di nuovi tentativi nel criterio per nuovi tentativi di recupero JWKS remoto. Il valore predefinito è 0, non riprova.

Specifica l'intervallo esponenziale dei tentativi di recupero JWKS fuori base, in millisecondi. Il valore predefinito è 200 ms, se non è impostato.

Specifica l'intervallo massimo del backoff esponenziale del nuovo tentativo di recupero JWKS, in millisecondi. Il valore predefinito è 32 secondi, se non è impostato.

Specifica la durata della cache della chiave pubblica JWT in secondi. Il valore predefinito è 5 minuti, se non è impostato.

Applica solo quando il flag --disable_jwks_async_fetch non è impostato. Questo flag determina se ESPv2 attenderà il recupero iniziale di jwks da completare prima di associare la porta del listener. Se è false, attenderà. Il valore predefinito è false.

Specifica il numero di token JWT univoci come dimensione massima della cache JWT. La cache memorizza solo i token verificati. Se il valore è 0, la cache JWT è disabilitata. Questo flag limita l'utilizzo della memoria per la cache JWT. La memoria utilizzata dalla cache è all'incirca (dimensione token + 64 byte) per token. Se non specificato, il valore predefinito è 100.000.

Normalmente il campo JWT aud viene controllato rispetto ai segmenti di pubblico specificati nel campo x-google-audiences OpenAPI. Questo flag modifica il comportamento quando il campo x-google-audiences non viene specificato. Se il campo x-google-audiences non è specificato e questo flag non viene utilizzato, il nome del servizio viene utilizzato per controllare il campo JWT aud. Se viene utilizzato questo flag, il campo JWT aud non verrà selezionato.