Referencia de operación y configuración de Edge Microgateway

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Información

Edge Microgateway v. 2.4.x

Descripción general

En este tema, se analiza cómo administrar y configurar Edge Microgateway, incluidos la supervisión, el registro y la depuración.

Cómo realizar cambios en la configuración

Entre los archivos de configuración que debes conocer, se incluyen los siguientes:

  • Archivo de configuración del sistema predeterminado
  • Archivo de configuración predeterminado para una instancia de Edge Microgateway recién inicializada
  • Archivo de configuración dinámico para instancias en ejecución

En esta sección, se analizan estos archivos y lo que debes saber para cambiarlos. Para obtener detalles sobre los parámetros de configuración del archivo de configuración, consulta la referencia de configuración de Edge Microgateway.

Archivo de configuración del sistema predeterminado

Cuando instalas Edge Microgateway, se coloca aquí un archivo de configuración predeterminado del sistema:

[prefix]/lib/node_modules/edgemicro/config/default.yaml

donde [prefix] es el directorio del prefijo npm. Consulta Dónde está instalado Edge Microgateway.

Si cambias el archivo de configuración del sistema, debes reiniciar, reconfigurar y reiniciar Edge Microgateway:

  1. Llamar a edgemicro init
  2. Llamar a edgemicro configure [params]
  3. Llamar a edgemicro start [params]

Archivo de configuración predeterminado para las instancias de Edge Microgateway recién inicializadas

Cuando ejecutas edgemicro init, el archivo de configuración del sistema (descrito anteriormente), default.yaml, se coloca en este directorio: ~/.edgemicro

Si cambias el archivo de configuración en aproximadamente /.edgemicro, debes volver a configurar y reiniciar Edge Microgateway:

  1. edgemicro stop
  2. edgemicro configure [params]
  3. edgemicro start [params]

Archivo de configuración dinámico para instancias en ejecución

Cuando ejecutas edgemicro configure [params], se crea un archivo de configuración dinámica en aproximadamente /.edgemicro. El archivo se llama según este patrón: [org]-[env]-config.yaml, en el que org y env son los nombres de la organización y del entorno de Apigee Edge. Puedes usar este archivo para realizar cambios en la configuración y, luego, volver a cargarlos sin tiempo de inactividad. Por ejemplo, si agregas y configuras un complemento, puedes volver a cargar la configuración sin generar tiempo de inactividad, como se explica a continuación.

Si Edge Microgateway se ejecuta (opción de tiempo de inactividad cero):

  1. Vuelve a cargar la configuración de Edge Microgateway: 
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    Donde:

    • org es el nombre de tu organización de Edge (debes ser administrador de la organización).
    • env es un entorno de tu organización (como prueba o producción).
    • key es la clave que mostró antes el comando de configuración.
    • secret es la clave que mostró antes el comando de configuración.

    Ejemplo

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d000723 -s 05c14356e42ed136b8dd35cf8a18531ff52d7299134677e30ef4e34ab0cc824

Si Edge Microgateway está detenido, haz lo siguiente:

  1. Reinicia Edge Microgateway: 
    edgemicro start -o [org] -e [env] -k [key] -s [secret]

    Donde:

    • org es el nombre de tu organización de Edge (debes ser administrador de la organización).
    • env es un entorno de tu organización (como prueba o producción).
    • key es la clave que mostró antes el comando de configuración.
    • secret es la clave que mostró antes el comando de configuración.

    Ejemplo

    edgemicro start -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d000723 -s 05c14356e42ed136b8dd35cf8a18531ff52d7299134677e30ef4e34ab0cc824

Este es un ejemplo de archivo de configuración. Para obtener detalles sobre los parámetros de configuración del archivo de configuración, consulta la referencia de configuración de Edge Microgateway.

edge_config:
  bootstrap: >-
    https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test
  jwt_public_key: 'https://docs-test.apigee.net/edgemicro-auth/publicKey'
  managementUri: 'https://api.enterprise.apigee.com'
  vaultName: microgateway
  authUri: 'https://%s-%s.apigee.net/edgemicro-auth'
  baseUri: >-
    https://edgemicroservices.apigee.net/edgemicro/%s/organization/%s/environment/%s
  bootstrapMessage: Please copy the following property to the edge micro agent config
  keySecretMessage: The following credentials are required to start edge micro
  products: 'https://docs-test.apigee.net/edgemicro-auth/products'
edgemicro:
  port: 8000
  max_connections: 1000
  max_connections_hard: 5000
  config_change_poll_interval: 600
  logging:
    level: error
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24
  plugins:
    sequence:
      - oauth
headers:
  x-forwarded-for: true
  x-forwarded-host: true
  x-request-id: true
  x-response-time: true
  via: true
oauth:
  allowNoAuthorization: false
  allowInvalidAuthorization: false
  verify_api_key_url: 'https://docs-test.apigee.net/edgemicro-auth/verifyApiKey'
analytics:
  uri: >-
    https://edgemicroservices-us-east-1.apigee.net/edgemicro/axpublisher/organization/docs/environment/test

Configura variables de entorno

Los comandos de la interfaz de línea de comandos que requieren valores para la organización y el entorno de Edge, así como la clave y el secreto necesarios a fin de iniciar Edge Microgateway, se pueden almacenar en las siguientes variables de entorno:

  • EDGEMICRO_ORG
  • EDGEMICRO_ENV
  • EDGEMICRO_KEY
  • EDGEMICRO_SECRET

Configurar estas variables es opcional. Si los configuraste, no es necesario que especifiques sus valores cuando usas la interfaz de línea de comandos (CLI) para configurar y, luego, iniciar Edge Microgateway.

Configura SSL en el servidor de Edge Microgateway

Puedes configurar el servidor de Microgateway para que use SSL. Por ejemplo, con SSL configurado, puedes llamar a las API a través de Edge Microgateway con el protocolo "https", de la siguiente manera:

https://localhost:8000/myapi

Para configurar SSL en el servidor de Microgateway, sigue estos pasos:

  1. Obtén u obtén un certificado y una clave SSL con la utilidad openssl o el método que prefieras.
  2. Agrega el atributo edgemicro:ssl al archivo de configuración de Edge Microgateway. Para obtener una lista completa de las opciones, consulta la siguiente tabla. Para obtener detalles sobre cómo modificar la configuración de Edge Microgateway, consulta Realiza cambios en la configuración. Por ejemplo:
     edgemicro:
     ssl:
         key: <absolute path to the SSL key file>
         cert: <absolute path to the SSL cert file>
         passphrase: admin123 #option added in v2.2.2
         rejectUnauthorized: true #option added in v2.2.2
         requestCert: true
  3. Reinicia Edge Microgateway. Sigue los pasos descritos en Cómo realizar cambios en la configuración según el archivo de configuración que editaste: el predeterminado o el archivo de configuración del entorno de ejecución.

Este es un ejemplo de la sección perimetralmicro del archivo de configuración, con SSL configurada:

edgemicro:
  port: 8000
  max_connections: 1000
  max_connections_hard: 5000
  logging:
    level: error
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24
  plugins:
    sequence:
      - oauth
  ssl:
    key: /MyHome/SSL/em-ssl-keys/server.key
    cert: /MyHome/SSL/em-ssl-keys/server.crt
    passphrase: admin123 #option added in v2.2.2
    rejectUnauthorized: true #option added in v2.2.2

Esta es una lista de todas las opciones de servidor compatibles:

Opción Descripción
key Es la ruta de acceso a un archivo ca.key (en formato PEM).
cert Es la ruta de acceso a un archivo ca.cert (en formato PEM).
pfx Ruta de acceso a un archivo pfx que contiene la clave privada, el certificado y los certificados de CA del cliente en formato PFX.
passphrase Una string que contiene la frase de contraseña para la clave privada o PFX.
ca Es la ruta de acceso a un archivo que contiene una lista de certificados de confianza en formato PEM.
ciphers Es una string que describe los cifrados que se usarán separados por un “:”.
rejectUnauthorized Si es verdadero, el certificado del servidor se verifica con la lista de CA proporcionadas. Si la verificación falla, se mostrará un error.
secureProtocol Es el método SSL que se usará. Por ejemplo, SSLv3_method para forzar SSL a la versión 3.
servername El nombre del servidor de la extensión TLS de SNI (indicación de nombre del servidor).
requestCert Verdadero para SSL de 2 vías; falso para SSL unidireccional

Usa opciones SSL/TLS del cliente

Puedes configurar Edge Microgateway para que sea un cliente TLS o SSL cuando te conectas a los extremos de destino. En el archivo de configuración de Microgateway, usa el elemento de destino para configurar las opciones de SSL/TLS.

En este ejemplo, se proporciona la configuración que se aplicará a todos los hosts:

targets:
   ssl:
     client:
       key: /Users/jdoe/nodecellar/twowayssl/ssl/client.key
       cert: /Users/jdoe/nodecellar/twowayssl/ssl/ca.crt
       passphrase: admin123
       rejectUnauthorized: true

En este ejemplo, la configuración solo se aplica al host especificado:

targets:
   host: 'myserver.example.com'
   ssl:
     client:
       key: /Users/myname/twowayssl/ssl/client.key
       cert: /Users/myname/twowayssl/ssl/ca.crt
       passphrase: admin123
       rejectUnauthorized: true

A continuación, se muestra un ejemplo de TLS:

targets:
   host: 'myserver.example.com'
   tls:
     client:
       pfx: /Users/myname/twowayssl/ssl/client.pfx
       passphrase: admin123
       rejectUnauthorized: true

A continuación, se muestra una lista de todas las opciones de cliente admitidas:

Opción Descripción
pfx Ruta de acceso a un archivo pfx que contiene la clave privada, el certificado y los certificados de CA del cliente en formato PFX.
key Es la ruta de acceso a un archivo ca.key (en formato PEM).
passphrase Una string que contiene la frase de contraseña para la clave privada o PFX.
cert Es la ruta de acceso a un archivo ca.cert (en formato PEM).
ca Es la ruta de acceso a un archivo que contiene una lista de certificados de confianza en formato PEM.
ciphers Es una string que describe los cifrados que se usarán separados por un “:”.
rejectUnauthorized Si es verdadero, el certificado del servidor se verifica con la lista de CA proporcionadas. Si la verificación falla, se mostrará un error.
secureProtocol Es el método SSL que se usará. Por ejemplo, SSLv3_method para forzar SSL a la versión 3.
servername El nombre del servidor de la extensión TLS de SNI (indicación de nombre del servidor).

Personaliza el proxy de Edgemicro-auth

De forma predeterminada, Edge Microgateway usa un proxy implementado en Apigee Edge para la autenticación de OAuth2. Este proxy se implementa cuando ejecutas edgemicro configure por primera vez. Puedes cambiar la configuración predeterminada de este proxy para agregar compatibilidad con reclamaciones personalizadas a un token web JSON (JWT), configurar el vencimiento del token y generar tokens de actualización. Para obtener más información, consulta la página edgemicro-auth en GitHub.

Usa un servicio de autenticación personalizado

De forma predeterminada, Edge Microgateway usa un proxy implementado en Apigee Edge para la autenticación de OAuth2. Este proxy se implementa cuando ejecutas edgemicro configure por primera vez. De forma predeterminada, la URL de este proxy se especifica en el archivo de configuración de Edge Microgateway de la siguiente manera:

authUri: https://myorg-myenv.apigee.net/edgemicro-auth

Si deseas usar tu propio servicio personalizado para manejar la autenticación, cambia el valor authUri en el archivo de configuración para que apunte a tu servicio. Por ejemplo, puedes tener un servicio que usa LDAP para verificar la identidad.

Cómo administrar archivos de registro

Edge Microgateway registra información sobre cada solicitud y respuesta. Los archivos de registro proporcionan información útil para depurar y solucionar problemas.

Dónde se almacenan los archivos de registro

De forma predeterminada, los archivos de registro se almacenan en /var/tmp.

Cómo cambiar el directorio de archivos de registro predeterminado

El directorio en el que se almacenan los archivos de registro se especifica en el archivo de configuración de Edge Microgateway. Para obtener detalles sobre cómo realizar cambios en la configuración, consulta Cómo realizar cambios en la configuración.

edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24

Cambia el valor dir para especificar un directorio de archivos de registro diferente.

Envía registros a la consola

Puedes configurar el registro para que la información de registro se envíe a la salida estándar en lugar de a un archivo de registro. Configura la marca to_console como verdadera de la siguiente manera:

edgemicro:
  logging:
    to_console: true

Con este parámetro de configuración, los registros se enviarán a la salida estándar. Por el momento, no puedes enviar registros a stdout y a un archivo de registro.

Cómo configurar el nivel de registro

Puedes configurar estos niveles de registro: info, warn y error. Se recomienda el nivel de información. Registra todas las solicitudes y respuestas de la API, y es la opción predeterminada.

Cómo cambiar los intervalos de registro

Puedes configurar estos intervalos en el archivo de configuración de Edge Microgateway. Para obtener detalles sobre cómo realizar cambios en la configuración, consulta Cómo realizar cambios en la configuración.

Los atributos configurables son los siguientes:

  • stats_log_interval: (Valor predeterminado: 60) Intervalo, en segundos, cuando el registro de estadísticas se escribe en el archivo de registro de la API.
  • rotate_interval: (valor predeterminado: 24) Intervalo, en horas, cuando se rotan los archivos de registro. Por ejemplo:
edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24

Nota: Los archivos de registro archivados no se comprimen. Cuando comienza el intervalo, se crea un archivo de registro nuevo con una marca de tiempo nueva.

Prácticas recomendadas para el mantenimiento de los archivos de registro

Debido a que los datos de los archivos de registro se acumulan con el tiempo, Apigee recomienda que adoptes las siguientes prácticas:

Convención de nomenclatura de archivos de registro

Cada instancia de Edge Microgateway produce tres tipos de archivos de registro:

  • api: Registra todas las solicitudes y respuestas que fluyen a través de Edge Microgateway. Los contadores (estadísticas) y los errores de la API también se registran en este archivo.
  • err: Registra todo lo que se envíe a stderr.
  • out: Registra todo lo que se envíe a stdout.

Esta es la convención de nomenclatura:

edgemicro-<Host Name>-<Instance ID>-<Log Type>.log

Por ejemplo:

edgemicro-mymachine-local-MTQzNTgNDMxODAyMQ-api.log
edgemicro-mymachine-local-MTQzNTg1NDMODAyMQ-err.log
edgemicro-mymachine-local-mtqzntgndmxodaymq-out.log

Información acerca del contenido de los archivos de registro

Se agregó en la versión 2.3.3.

De forma predeterminada, el servicio de registro omite el JSON de los proxies y productos descargados, y el token web JSON (JWT). Si deseas enviar estos objetos a los archivos de registro, configura DEBUG=* cuando inicies Edge Microgateway. Por ejemplo:

DEBUG=* edgemicro start -o docs -e test -k abc123 -s xyz456

Nota: En Windows, usa SET DEBUG=*.

Contenido del archivo de registro "api"

El archivo de registro “api” contiene información detallada sobre el flujo de solicitudes y respuestas a través de Edge Microgateway. Los archivos de registro "api" se nombran de la siguiente manera:

edgemicro-mymachine-local-MTQzNjIxOTk0NzY0Nw-api.log

Para cada solicitud realizada a Edge Microgateway, se capturan cuatro eventos en el archivo de registro “API”:

  • Solicitud entrante del cliente
  • Solicitud saliente enviada al destino
  • Respuesta entrante del destino
  • Respuesta saliente al cliente

Cada una de estas entradas separadas se representa con una notación abreviada para ayudar a que los archivos de registro sean más compactos. Aquí hay cuatro entradas de ejemplo que representan cada uno de los cuatro eventos. En el archivo de registro, se ven de la siguiente manera (los números de línea son solo de referencia en el documento, no aparecen en el archivo de registro).

(1) 1436403888651 info req m=GET, u=/, h=localhost:8000, r=::1:59715, i=0
(2) 1436403888665 info treq m=GET, u=/, h=127.0.0.18080, i=0
(3) 1436403888672 info tres s=200, d=7, i=0
(4) 1436403888676 info res s=200, d=11, i=0

Veámoslos uno por uno:

1. Ejemplo de solicitud entrante del cliente:

1436403888651 info req m=GET, u=/, h=localhost:8000, r=::1:59715, i=0
  • 1436403888651: Marca de fecha de Unix
  • info: Depende del contexto. Puede ser información, una advertencia o un error, según el nivel de registro. Pueden ser estadísticas para un registro estadístico, advertencias sobre advertencias o errores.
  • req: Identifica el evento. En este caso, se debe solicitar al cliente.
  • m: El verbo HTTP que se usa en la solicitud.
  • u: La parte de la URL que sigue a la ruta base.
  • h: El host y el número de puerto en los que Edge Microgateway escucha.
  • r: El host y el puerto remotos en los que se originó la solicitud del cliente.
  • i: El ID de la solicitud. Las cuatro entradas de eventos compartirán este ID. A cada solicitud se le asigna un ID único. La correlación de registros por ID de solicitud puede proporcionar estadísticas valiosas sobre la latencia del destino.
  • d: Es la duración en milisegundos desde que Edge Microgateway recibió la solicitud. En el ejemplo anterior, la respuesta del objetivo para la solicitud 0 se recibió después de 7 milisegundos (línea 3) y la respuesta se envió al cliente después de otros 4 milisegundos (línea 4). En otras palabras, la latencia total de la solicitud fue de 11 milisegundos, de los cuales 7 milisegundos la tomó el destino y 4 milisegundos por Edge Microgateway.

2. Ejemplo de solicitud saliente realizada al destino:

1436403888665 info treq m=GET, u=/, h=127.0.0.1:8080, i=0
  • 1436403888651: Marca de fecha de Unix
  • info: Depende del contexto. Puede ser información, una advertencia o un error, según el nivel de registro. Pueden ser estadísticas para un registro estadístico, advertencias sobre advertencias o errores.
  • treq: Identifica el evento. En este caso, es la solicitud de destino.
  • m: El verbo HTTP que se usa en la solicitud de destino.
  • u: La parte de la URL que sigue a la ruta base.
  • h: El host y el número de puerto del destino del backend.
  • i: El ID de la entrada de registro. Las cuatro entradas de eventos compartirán este ID.

3. Muestra de la respuesta entrante del destino

1436403888672 info tres s=200, d=7, i=0

1436403888651: Marca de fecha de Unix

  • info: Depende del contexto. Puede ser información, una advertencia o un error, según el nivel de registro. Pueden ser estadísticas para un registro estadístico, advertencias sobre advertencias o errores.
  • tres: Identifica el evento. En este caso, es la respuesta objetivo.
  • s: Es el estado de la respuesta HTTP.
  • d: Es la duración en milisegundos. Tiempo que tarda el objetivo en realizar la llamada a la API.
  • i: El ID de la entrada de registro. Las cuatro entradas de eventos compartirán este ID.

4. Muestra de respuesta saliente al cliente

1436403888676 info res s=200, d=11, i=0

1436403888651: Marca de fecha de Unix

  • info: Depende del contexto. Puede ser información, una advertencia o un error, según el nivel de registro. Pueden ser estadísticas para un registro estadístico, advertencias sobre advertencias o errores.
  • res: Identifica el evento. En este caso, es la respuesta al cliente.
  • s: Es el estado de la respuesta HTTP.
  • d: Es la duración en milisegundos. Este es el tiempo total que tarda la llamada a la API, incluido el tiempo que tarda la API de destino y el tiempo que tarda Edge Microgateway.
  • i: El ID de la entrada de registro. Las cuatro entradas de eventos compartirán este ID.

Programación del archivo de registro

Los archivos de registro se rotan en el intervalo especificado por el atributo de configuración rotate_interval. Se seguirán agregando entradas al mismo archivo de registro hasta que venza el intervalo de rotación. Sin embargo, cada vez que se reinicia Edge Microgateway, recibe un UID nuevo y crea un conjunto nuevo de archivos de registro con este UID. Consulta también Prácticas recomendadas para el mantenimiento de los archivos de registro.

Referencia de configuración de Edge Microgateway

Ubicación del archivo de configuración

Los atributos de configuración que se describen en esta sección se encuentran en el archivo de configuración de Edge Microgateway. Para obtener detalles sobre cómo realizar cambios en la configuración, consulta Cómo realizar cambios en la configuración.

Atributos de Edge_config

Esta configuración se usa para configurar la interacción entre la instancia de Edge Microgateway y Apigee Edge.

  • Boot: (predeterminado: none) Es una URL que apunta a un servicio específico de Edge Microgateway que se ejecuta en Apigee Edge. Edge Microgateway usa este servicio para comunicarse con Apigee Edge. Esta URL se muestra cuando ejecutas el comando para generar el par de claves pública/privada: edgemicro genkeys. Consulta Configura y configura Edge Microgateway para obtener más detalles.
  • jwt_public_key: (configuración predeterminada: none) Es una URL que apunta al proxy de Edge Microgateway que se implementa en Apigee Edge. Este proxy sirve como un extremo de autenticación para emitir tokens de acceso firmados a los clientes. Se muestra esta URL cuando ejecutas el comando para implementar el proxy: edgemicro configure. Consulta Configura y configura Edge Microgateway para obtener más detalles.

atributos de Edgemicro

Con esta configuración, se configura el proceso de Edge Microgateway.

  • port: (valor predeterminado: 8000) Es el número de puerto en el que escucha el proceso de Edge Microgateway.
  • max_connections: Especifica la cantidad máxima de conexiones entrantes simultáneas que puede recibir Edge Microgateway (valor predeterminado: -1). Si se supera este número, se muestra el siguiente estado:

    res.statusCode = 429; // Too many requests
  • max_connections_hard: (valor predeterminado: -1) Es la cantidad máxima de solicitudes simultáneas que puede recibir Edge Microgateway antes de cerrar la conexión. Esta configuración está diseñada para frustrar ataques de denegación del servicio. Por lo general, establece un número mayor que max_connections.
  • logging:
    • level: (valor predeterminado: error)
      • info: Registra todas las solicitudes y respuestas que fluyen a través de una instancia de Edge Microgateway.
      • warn: Registra solo los mensajes de advertencia.
      • error: Registra solo los mensajes de error.
    • dir: (predeterminado: /var/tmp) Es el directorio en el que se almacenan los archivos de registro.
    • stats_log_interval: (Valor predeterminado: 60) Intervalo, en segundos, cuando el registro de estadísticas se escribe en el archivo de registro de la API.
    • rotate_interval: (valor predeterminado: 24) Intervalo, en horas, cuando se rotan los archivos de registro.
  • dir: Una ruta de acceso relativa desde el directorio ./gateway al directorio ./plugins o una ruta absoluta.
  • secuencia: Una lista de módulos de complementos para agregar a la instancia de Edge Microgateway. Los módulos se ejecutarán en el orden en el que se especifiquen aquí.
  • debug: Agrega la depuración remota al proceso de Edge Microgateway.
    • port: Es el número de puerto en el que se escuchará. Por ejemplo, configura tu depurador del IDE para que escuche en este puerto.
    • args: Argumentos para el proceso de depuración Por ejemplo: args --nolazy
  • config_change_poll_interval: (configuración predeterminada: 600 segundos) Edge Microgateway carga una configuración nueva de forma periódica y ejecuta una recarga si algo cambió. El sondeo recoge los cambios realizados en Edge (cambios en los productos, proxies compatibles con micropuertas de enlace, etc.) y en el archivo de configuración local.
  • disable_config_poll_interval: (valor predeterminado: false) Configúralo en true para desactivar el sondeo de cambios automáticos.
  • request_timeout: Establece un tiempo de espera para las solicitudes de destino. El tiempo de espera se establece en segundos. Si se agota el tiempo de espera, Edge Microgateway responde con un código de estado 504. (Se agregó la versión 2.4.x).

atributos de encabezados

Esta configuración establece la manera en que se tratan ciertos encabezados HTTP.

  • x-forwarded-for: (predeterminado: true) Se establece en falso para evitar que los encabezados x-forwarded-for se pasen al destino. Ten en cuenta que, si la solicitud contiene un encabezado x-forward-for, su valor se establecerá en el valor de client-ip en Edge Analytics.
  • x-forwarded-host: (predeterminado: true) Se establece como falso para evitar que se pasen los encabezados x-forwarded-host al destino.
  • x-request-id: (valor predeterminado: verdadero). Configúralo como falso para evitar que los encabezados x-request-id se pasen al destino.
  • x-response-time: (predeterminado: true) Se establece en falso para evitar que los encabezados de x-response-time se pasen al objetivo.
  • via: (valor predeterminado: true) Configúralo como falso para evitar que se pasen los encabezados al destino.

atributos de OAuth

Esta configuración configura cómo Edge Microgateway aplica la autenticación del cliente.

  • allowNoAuthorization: (valor predeterminado: false). Si se configura como verdadero, las llamadas a la API pueden pasar por Edge Microgateway sin encabezado de autorización. Configúralo como falso para requerir un encabezado de autorización (predeterminado).
  • allowInvalidAuthorization: (valor predeterminado: false) Si se configura como verdadero, se permite que se pasen las llamadas a la API si el token que se pasó en el encabezado de autorización no es válido o venció. Establece esto como false para requerir tokens válidos (predeterminado).
  • Authorization-header: (valor predeterminado: Autorización: Bearer). Es el encabezado que se usa para enviar el token de acceso a Edge Microgateway. Es posible que desees cambiar el valor predeterminado en los casos en que el destino necesite usar el encabezado de autorización para algún otro propósito.
  • api-key-header: (valor predeterminado: x-api-key) Es el nombre del encabezado o del parámetro de consulta que se usa para pasar una clave de API a Edge Microgateway. Consulta también Cómo usar una clave de API.
  • keepAuthHeader: (valor predeterminado: false). Si se configura como verdadero, el encabezado de autorización enviado en la solicitud se pasa al destino (se conserva).
  • allowOAuthOnly: Si se configura como verdadera, cada API debe llevar un encabezado de autorización con un token de acceso del portador. Te permite permitir solo el modelo de seguridad OAuth (y mantener la retrocompatibilidad). (Se agregó la versión 4.2.x)
  • allowAPIKeyOnly: Si se configura como verdadera, cada API debe llevar un encabezado x-api-key (o una ubicación personalizada) con una clave de API.Te permite permitir solo el modelo de seguridad de la clave de API (y, al mismo tiempo, mantener la retrocompatibilidad). (Se agregó la versión 4.2.x)

Atributos específicos del complemento

Consulta la sección Uso de complementos para obtener detalles sobre los atributos configurables de cada complemento.

Filtra proxies

Puedes filtrar qué proxies compatibles con micropuertas de enlace procesará una instancia de Edge Microgateway. Cuando se inicia Edge Microgateway, se descargan todos los proxies compatibles con micropuertas de enlace de la organización a la que está asociado. Usa la siguiente configuración para limitar los proxies que procesará la micropuerta de enlace. Por ejemplo, esta configuración limita los proxies que procesará la micropuerta de enlace a tres: edgemicro_proxy-1, edgemicro_proxy-2 y edgemicro_proxy-3:

proxies:
  - edgemicro_proxy-1
  - edgemicro_proxy-2
  - edgemicro_proxy-3

Enmascara datos de estadísticas

La siguiente configuración evita que se muestre la información de la ruta de la solicitud en Edge Analytics. Agrega el siguiente código a la configuración de la micropuerta de enlace para enmascarar el URI de la solicitud o la ruta de la solicitud. Ten en cuenta que el URI consta de las partes del nombre de host y la ruta de acceso de la solicitud.

analytics:
  mask_request_uri: 'string_to_mask'
  mask_request_path: 'string_to_mask'

Configura Edge Microgateway detrás de un firewall de la empresa

Compatible con v4.2.x

Si Edge Microgateway está instalado detrás de un firewall, es posible que la puerta de enlace no pueda comunicarse con Apigee Edge. En este caso, hay dos opciones que puedes considerar:

Opción 1:

La primera opción es configurar la opción Edgemicro: proxy_tunnel como verdadera en el archivo de configuración de microgateway:

edge_config:

    proxy: http://10.224.16.85:3128
    proxy_tunnel: true

Cuando proxy_tunnel es true, Edge Microgateway usa el método HTTP CONNECT para hacer túneles las solicitudes HTTP en una sola conexión TCP. (Lo mismo ocurre si las variables de entorno para configurar el proxy tienen habilitado TLS).

Opción 2:

La segunda opción es especificar un proxy y establecer proxy_tunnel como falso en el archivo de configuración de micropuerta de enlace. Por ejemplo:

edge_config:
     proxy: http://10.224.16.85:3128
     proxy_tunnel: false

En este caso, puedes configurar las siguientes variables para controlar los hosts de cada proxy HTTP que desees usar o qué hosts no deben controlar los proxies de Edge Microgateway: HTTP_PROXY, HTTPS_PROXY y NO_PROXY.

Puedes configurar NO_PROXY como una lista delimitada por comas de dominios a los que Edge Microgateway no debe usar como proxy. Por ejemplo:

export NO_PROXY='localhost,localhost:8080'

Configura HTTP_PROXY y HTTPS_PROXY en el extremo del proxy HTTP que Edge Microgateway puede enviarle mensajes. Por ejemplo:

export HTTP_PROXY='http://localhost:3786'

export HTTPS_PROXY='https://localhost:3786'

Para obtener más información sobre estas variables, consulta lo siguiente:

https://www.npmjs.com/package/request#controlling-proxy-behaviour-using-environment-variables


Consulta también

Cómo configurar Edge Microgateway detrás de un firewall de la empresa en la comunidad de Apigee.

Usa comodines en proxies compatibles con Microgateway

Puedes usar uno o más comodines "*" en la ruta base de un proxy edgemicro_* (Microgateway-aware). Por ejemplo, una ruta base de /team/*/members permite a los clientes llamar a https://[host]/team/blue/members y https://[host]/team/green/members sin necesidad de crear proxies de API nuevos para brindar asistencia a equipos nuevos. Ten en cuenta que /**/ no es compatible.

Importante: Apigee NO admite el uso de un comodín “*” como el primer elemento de una ruta base. Por ejemplo, NO se admite la búsqueda de /*/.


Depuración y solución de problemas

Conéctate a un depurador

Puedes ejecutar Edge Microgateway con un depurador, como node-inspector. Esto es útil para solucionar problemas y depurar complementos personalizados.

  1. Reinicia Edge Microgateway en modo de depuración. Para ello, agrega DEBUG=* al comienzo del comando de inicio. Por ejemplo:

    DEBUG=* edgemicro start -o myorg -e test -k db4e9e8a95aa7fabfdeacbb1169d0a8cbe42bec19c6b98129e02 -s 6e56af7c1b26dfe93dae78a735c8afc9796b077d105ae5618ce7ed

    Nota: En Windows, usa SET DEBUG=*.

  2. Inicia el depurador y configúralo para que detecte el número de puerto del proceso de depuración.
  3. Ahora puedes recorrer el código de Edge Microgateway, establecer puntos de interrupción, observar expresiones, etcétera.

Puedes especificar marcas estándar de Node.js relacionadas con el modo de depuración. Por ejemplo, --nolazy ayuda a depurar código asíncrono.

Verifica los archivos de registro

Si tienes problemas, asegúrate de examinar los archivos de registro en busca de detalles de ejecución e información de errores. Para obtener detalles, consulta Cómo administrar archivos de registro.

Cómo usar la seguridad de las claves de API

Las claves de API proporcionan un mecanismo simple para autenticar a los clientes que realizan solicitudes a Edge Microgateway. Para obtener una clave de API, copia el valor de la clave de consumidor (también llamado ID de cliente) de un producto de Apigee Edge que incluye el proxy de autenticación de Edge Microgateway.

Almacenamiento en caché de claves

Las claves de API se intercambian por tokens del portador, que se almacenan en caché. Puedes inhabilitar el almacenamiento en caché si configuras el encabezado Cache-Control: no-cache en las solicitudes entrantes a Edge Microgateway.

Usa la seguridad del token de OAuth2

Para obtener detalles sobre el uso de un token de OAuth con solicitudes de proxy, consulta Secure Edge Microgateway.

Cómo usar una clave de API

Para obtener detalles sobre el uso de claves de API con solicitudes de proxy, consulta Secure Edge Microgateway.

.

Cómo configurar el nombre de la clave de API

De forma predeterminada, x-api-key es el nombre que se usa para el encabezado de la clave de API o el parámetro de consulta. Puedes cambiar este valor predeterminado en el archivo de configuración, como se explica en Cómo realizar cambios en la configuración. Por ejemplo, para cambiar el nombre a apiKey:

oauth:
 allowNoAuthorization: false
 allowInvalidAuthorization: false
 api-key-header: apiKey