Definir cabeçalhos personalizados

O Media CDN permite especificar cabeçalhos de solicitação e resposta personalizados.

Os cabeçalhos personalizados permitem o seguinte:

  • Retorna dados geográficos sobre o cliente, como país, região ou cidade, que podem ser usados para mostrar conteúdo localizado.
  • determinar se uma resposta foi fornecida pelo cache (total ou parcialmente) e de qual local de cache foi veiculado.
  • Remova, substitua ou anexe aos cabeçalhos de solicitação e resposta.

Também é possível usar cabeçalhos para encaminhar solicitações para diferentes origens. Se você precisar configurar o Cross-Origin cabeçalhos de compartilhamento de recursos (CORS), configure um CORS política para cada rota.

Definir cabeçalhos personalizados

Os cabeçalhos são definidos em cada rota, o que permite adicionar e remover cabeçalhos para conteúdos diferentes, como manifestos ou segmentos de vídeo.

Por padrão, os valores de cabeçalho adicionados são separados por vírgula e anexados à resposta. ou cabeçalhos de solicitação com os mesmos nomes de campo.

Para substituir os valores atuais, defina replace como true.

O exemplo de .routing.pathMatchers[].routeRules[].headerAction a seguir mostra cabeçalhos adicionados e removidos em um recurso EdgeCacheService:

gcloud edge-cache services describe prod-media-service
routeRules:
  - priority: 1
    description: "video routes"
    matchRules:
      - prefixMatch: "/video/"
    headerAction:
      responseHeadersToAdd:
        # Return the country (or region) associated with the client's IP address.
        - headerName: "client-geo"
          headerValue: "{client_region}"
          replace: true
      requestHeadersToAdd:
        # Inform the upstream origin server the request is from Media CDN
        - headerName: "x-downstream-cdn"
          headerValue: "Media CDN"
      responseHeadersToRemove:
        - headerName: "X-User-ID"
        - headerName: "X-Other-Internal-Header"

Este exemplo faz o seguinte:

  • Adiciona um cabeçalho client-geo personalizado à resposta usando a variável {client_region}, que retorna o país (ou região) associado ao endereço IP do cliente.
  • Adiciona um cabeçalho x-downstream-cdn personalizado à solicitação usando uma string estática.
  • Remove dois cabeçalhos internos.

Variáveis de cabeçalho dinâmicas

Os cabeçalhos personalizados podem conter uma ou mais variáveis dinâmicas.

Cabeçalhos de solicitação que fazem parte da política de chave de cache (cacheKeyPolicy.includedHeaderNames) pode ter uma ou mais variáveis personalizadas. Cabeçalhos de solicitação que contêm outras variáveis dinâmicas não podem fazer parte da chave de cache.

Variável Descrição Suporte para cabeçalhos de solicitação Suporte a cabeçalhos de solicitação em uma chave de cache Suporte para cabeçalhos de resposta
cdn_cache_status Uma lista separada por vírgulas dos locais (código IATA do aeroporto mais próximo) e dos status de cada nó de cache no caminho de solicitação/resposta, em que o valor mais à direita representa o cache mais próximo do usuário.
client_city O nome da cidade de origem da solicitação. Por exemplo, Mountain View para Mountain View, Califórnia. Não há uma lista canônica de valores válidos para essa variável. Os nomes das cidades podem conter letras US-ASCII, números, espaços e os seguintes caracteres: !#$%&'*+-.^_`|~:
client_city_lat_long A latitude e a longitude da cidade de origem da solicitação. Por exemplo, 37.386051,-122.083851 para uma solicitação de Mountain View.
client_region O país (ou região) associado ao endereço IP do cliente. Esse é um código de região Unicode CLDR, como US ou FR. Na maioria dos países, esses códigos correspondem diretamente a códigos ISO-3166-2.
client_region_subdivision A subdivisão (por exemplo, a província ou o estado) do país associadas ao endereço IP do cliente. Este é um ID de subdivisão Unicode CLDR, como USCA ou CAON. Esses códigos Unicode são derivados das subdivisões definidas pelo padrão ISO-3166-2.
client_rtt_msec O tempo estimado de retorno para transmissão entre o CDN e o cliente HTTP(S), em milissegundos. É o parâmetro de tempo de retorno suavizado (SRTT, na sigla em inglês) medido pela pilha TCP do CDN de acordo com a RFC 2988.
device_request_type O tipo de dispositivo que o cliente está usando. Essas são as métricas válidas valores: DESKTOP, MOBILE, TABLET, SMART_TV, GAME_CONSOLE, WEARABLE, e UNDETERMINED.
original_request_id O identificador exclusivo atribuído à solicitação que gerou essa resposta. Preenchido apenas se for diferente de request_id para respostas armazenadas em cache.
origin_name O recurso EdgeCacheOrigin do qual a resposta foi enviado por proxy.
origin_request_header Reflete o valor do cabeçalho Origin na solicitação de Cross-Origin Casos de uso do Compartilhamento de recursos (CORS).
proxy_status Uma lista de proxies HTTP intermediários no caminho de resposta. O valor é definido pela RFC 9209. Um recurso EdgeCacheService é representado Google-Edge-Cache. Se a resposta foi buscada na origem, um(a) EdgeCacheOrigin recurso é representado por Google-Edge-Cache-Origin.
tls_sni_hostname A indicação do nome do servidor (conforme definido na RFC 6066), caso fornecido pelo cliente durante o handshake do TLS ou do QUIC. O nome do host é convertido em letras minúsculas, e qualquer ponto à direita é removido.
tls_version A versão de TLS negociada entre o cliente e o balanceador de carga durante o handshake de SSL. Os valores possíveis incluem TLSv1, TLSv1.1, TLSv1.2 e TLSv1.3. Se o cliente se conectar usando QUIC em vez de TLS, o valor será QUIC.
tls_cipher_suite O pacote de criptografia negociado durante o handshake de TLS. O valor é definido pela IANA, Registro do pacote de criptografia TLS, por exemplo, TLS_RSA_WITH_AES_128_GCM_SHA256 Esse valor fica em branco para QUIC e conexões de cliente não criptografadas.
user_agent_family A família de navegadores que o cliente está usando. Essas são as métricas válidas valores: APPLE, APPLEWEBKIT, BLACKBERRY, DOCOMO e GECKO. GOOGLE, KHTML, KOREAN, MICROSOFT, MSIE, NOKIA NETFRONT, OBIGO, OPENWAVE OPERA, OTHER, POLARIS, TELECA, SEMC, SMIT e USER_DEFINED.

As seguintes considerações se aplicam às variáveis personalizadas:

  • Os cabeçalhos de solicitação e resposta atuais são preservados, exceto os seguintes, que são removidos:

    • X-User-IP
    • Todos os cabeçalhos com X-Google ou X-GFE
  • As chaves e os valores do cabeçalho precisam estar em conformidade com a RFC 7230, com os formulários obsoletos não permitidos.

  • Todas as chaves de cabeçalho são convertidas em letras minúsculas (de acordo com o HTTP/2).

  • Alguns cabeçalhos são agrupados. Quando houver várias instâncias da mesma chave de cabeçalho (por exemplo, Via), o balanceador de carga combinará os valores delas em uma lista separada por vírgulas para uma chave de cabeçalho. Serão agrupados somente cabeçalhos com valores que possam ser representados como uma lista separada por vírgulas. Outros cabeçalhos, como Set-Cookie, nunca são agrupados.

  • Alguns cabeçalhos são adicionados ou têm valores anexados a eles. O Media CDN sempre adiciona ou modifica determinados cabeçalhos, como Via e X-Forwarded-For.

  • O Media CDN expande qualquer cabeçalho de resposta com uma variável compatível, mesmo que definida pelo cliente ou pela origem. Isso permite você define cabeçalhos dinâmicos de seu cliente (como um player de vídeo) ou origem infraestrutura, além de configurar cabeçalhos personalizados. O Media CDN não expande variáveis no caminho da solicitação.

  • Como exemplo, de acordo com as regras descritas anteriormente, X-Goog- e Os cabeçalhos X-Amz- são preservados e estão em letras minúsculas.

Valores de status do cache

A variável de cabeçalho {cdn_cache_status} pode retornar vários valores correspondentes ao nível de cache que forneceu a resposta. Considere as seguintes diretrizes para interpretar a variável de cabeçalho {cdn_cache_status}:

  • Se o cabeçalho tiver hit, o conteúdo solicitado foi recuperado do cache.
  • Se o cabeçalho tiver miss, significa que o conteúdo solicitado não foi encontrado em um nó de cache e teve que ser recuperado de um nó upstream.
  • Se o cabeçalho contiver fetch, o conteúdo solicitado foi recuperado da origem.
  • Se o cabeçalho tiver uncacheable, o conteúdo solicitado foi considerados não armazenáveis em cache por alguns ou todos os componentes do armazenamento do Google Cloud.

    • Se o cabeçalho também contiver hit ou miss, o conteúdo solicitado será considerado não armazenável em cache por alguns componentes de armazenamento em cache e armazenável em cache por outros.
    • Se o cabeçalho não contiver hit ou miss, o conteúdo solicitado será considerado não armazenável em cache por todos os componentes de armazenamento em cache, e todas as solicitações desse conteúdo serão buscadas na origem. Para garantir que seu conteúdo seja armazenado em cache de maneira adequada, consulte os requisitos de origem do Media CDN.

Cabeçalhos padrão

O Media CDN adiciona os seguintes cabeçalhos de solicitação e resposta às solicitações de origem e respostas do cliente, respectivamente.

Cabeçalho Descrição Request Resposta
x-request-id Identificador exclusivo da solicitação em questão. Esse valor também é adicionado ao registro de solicitação como jsonPayload.requestId, o que permite correlacionar uma solicitação/resposta do cliente a uma entrada de registro.
age

Retorna a idade do objeto armazenado em cache (número de segundos em que no cache). A idade é normalmente calculada com base no momento em que o objeto foi armazenado em cache inicialmente em um local de cache de cauda longa (escudo).

As respostas sem um cabeçalho age não são exibidas no cache.

via

Identifica o Google como o proxy intermediário.

Esse valor é definido como 1.1 google e não pode ser alterado.

server Está definida como Google-Edge-Cache.
cdn-loop

Identifica loops, por exemplo, quando o host de origem é o mesmo que o host voltado ao usuário (de borda).

Um token de google é anexado ao cabeçalho conforme a RFC 8586. O token não pode ser alterado.

forwarded

A versão estruturada do cabeçalho x-forwarded-for. O cabeçalho forwarded é definido no RFC 7239.

Esses cabeçalhos permitem identificar o endereço IP do endereço IP cliente quando um proxy (ou proxies) estiverem no caminho. Por exemplo, se um cliente com endereço IP 192.0.2.60 se conecta CDN de mídia sobre HTTPS, o forwarded é preenchido da seguinte forma:

forwarded: [for=192.0.2.60;proto=https]

No caso de vários proxies do lado do cliente, o cliente que se conectou O Media CDN é o último endereço anexado ao cabeçalho .

x-forwarded-for

A versão padrão não estruturada e padrão do cabeçalho forwarded. Os valores normalmente são separados por vírgulas.

Ambos os cabeçalhos são enviados em uma solicitação para oferecer suporte a origens legados que talvez não estejam cientes do cabeçalho forwarded.

As chaves de cabeçalho estão em minúsculas nos cabeçalhos de solicitação e resposta porque o cabeçalho não diferenciam maiúsculas de minúsculas.

Outros cabeçalhos, incluindo o local do ponto de presença (PoP) e o status do cache, como hit e miss, podem ser adicionados usando variáveis de cabeçalho dinâmico.