Configuración de actualizaciones automáticas

Usarappsettings.jsonPara permitir que se actualicen automáticamente el archivo de configuración de Amazon Kinesis Agent para Microsoft Windows y el archivo de configuración de Kinesis Agent para Windows. Para controlar el comportamiento de las actualizaciones, especifique el par clave-valor Plugins en el mismo nivel del archivo de configuración que Sources, Sinks y Pipes.

El par clave-valor Plugins especifica la funcionalidad general complementaria que no se incluye específicamente en las categorías de los orígenes, receptores y canalizaciones. Por ejemplo, hay un complemento para actualizar el agente de Kinesis para Windows y otro para actualizar el archivoappsettings.jsonArchivo de configuración de. Los complementos se representan como objetos JSON y siempre tienen el par clave-valor Type. Type determina qué otros pares clave-valor pueden especificarse en el complemento. Los tipos de complementos compatibles son los siguientes:

PackageUpdate

Especifica que Kinesis Agent para Windows debe comprobar periódicamente el archivo de configuración de una versión del paquete. Si el archivo de versión del paquete indica que debe instalarse una versión diferente de Kinesis Agent para Windows, Kinesis Agent para Windows descarga esa versión y la instala. El par clave-valor del complemento PackageUpdate incluye:

Type

El valor debe ser la cadena PackageUpdate y es obligatorio.

Interval

Especifica la frecuencia en minutos con la que debe comprobarse si el archivo de versión del paquete ha experimentado cambios utilizando un formato de cadena. Este par clave-valor es opcional. Si no se especifica, el valor predeterminado es 60 minutos. Si el valor es inferior a 1, no se realiza ninguna comprobación.

PackageVersion

Especifica la ubicación del archivo JSON de la versión del paquete. El archivo puede estar en un recurso compartido de archivos (file://), un sitio web (http://), o Amazon S3 (s3://). Por ejemplo, un valor des3://mycompany/config/agent-package-version.jsonindica que Kinesis Agent para Windows debe comprobar el contenido de laconfig/agent-package-version.jsonEn el archivomycompanyBucket de Amazon S3. Las actualizaciones deberían realizarse en función del contenido de ese archivo.

nota

El valor de la propiedadPackageVersionEl par clave-valor distingue entre mayúsculas y minúsculas en Amazon S3.

En el siguiente ejemplo, se muestra el contenido de un archivo de versión del paquete:

{
    "Name": "AWSKinesisTap",
    "Version": "1.0.0.106",
    "PackageUrl": "https://s3-us-west-2.amazonaws.com/kinesis-agent-windows/downloads/AWSKinesisTap.{Version}.nupkg"
}                     

LaVersionEspecifica qué versión de Kinesis Agent para Windows debe instalarse si aún no se ha instalado. La referencia a la variable {Version} de PackageUrl resuelve el valor que se especifica para el par clave-valor Version. En este ejemplo, la variable se resuelve en la cadena 1.0.0.106. Esta resolución de la variable se proporciona para que pueda haber un lugar específico en el archivo de versión del paquete en el que se almacene la versión deseada. Puede utilizar varios archivos de versión del paquete para controlar la velocidad de publicación de nuevas versiones de Kinesis Agent para Windows y validar una nueva versión antes de realizar una implementación de mayor tamaño. Para revertir una implementación de Kinesis Agent para Windows, modifique uno o varios archivos de versión del paquete y especifique una versión anterior de Kinesis Agent para Windows que sepa que funciona en su entorno.

El valor del par clave-valor PackageVersion se verá afectado por la sustitución de variables para facilitar la selección automática de diferentes archivos de versión de paquetes. Para obtener más información sobre la sustitución de variables, consulte Configuración de sustituciones de variables de receptor.

AccessKey

Especifica qué clave de acceso debe utilizarse para autenticar el acceso al archivo de versión del paquete en Amazon S3. Este par clave-valor es opcional. No se recomienda utilizar este par clave-valor. Para conocer otros enfoques de autenticación recomendados, consulte Configuración de la autenticación .

SecretKey

Especifica qué clave secreta debe utilizarse para autenticar el acceso al archivo de versión del paquete en Amazon S3. Este par clave-valor es opcional. No se recomienda utilizar este par clave-valor. Para conocer otros enfoques de autenticación recomendados, consulte Configuración de la autenticación .

Region

Especifica qué punto de enlace de la región debe utilizarse para obtener acceso al archivo de versión del paquete desde Amazon S3. Este par clave-valor es opcional.

ProfileName

Especifica qué perfil de seguridad debe utilizarse para autenticar el acceso al archivo de versión del paquete en Amazon S3. Para obtener más información, consulte Configuración de la autenticación . Este par clave-valor es opcional.

RoleARN

Especifica qué rol debe adoptarse para autenticar el acceso al archivo de versión del paquete en Amazon S3 en un escenario de acceso entre cuentas. Para obtener más información, consulte Configuración de la autenticación . Este par clave-valor es opcional.

Si no se especifica un complemento PackageUpdate, no se comprueba ningún archivo de versión del paquete para determinar si es necesario actualizarlo.

ConfigUpdate

Especifica que Kinesis Agent para Windows debe comprobar periódicamente si hay unappsettings.jsonArchivo de configuración guardado en un recurso compartido de archivos, un sitio web o Amazon S3. Si hay un archivo de configuración actualizado, lo descarga e instala el agente de Kinesis para Windows.ConfigUpdateEl par clave-valor incluye lo siguiente:

Type

El valor debe ser la cadena ConfigUpdate y es obligatorio.

Interval

Especifica la frecuencia en minutos con la que debe comprobarse si hay un nuevo archivo de configuración utilizando un formato de cadena. Este par clave-valor es opcional y, si no se especifica, el valor predeterminado es 5 minutos. Si el valor es inferior a 1, no se comprueba si hay un archivo de configuración actualizado.

Source

Especifica dónde debe buscarse un archivo de configuración actualizado. El archivo puede estar en un recurso compartido de archivos (file://), un sitio web (http://), o Amazon S3 (s3://). Por ejemplo, un valor des3://mycompany/config/appsettings.jsonindica que Kinesis Agent para Windows debe comprobar si hay actualizaciones en elconfig/appsettings.jsonEn el archivomycompanyBucket de Amazon S3.

nota

El valor de la propiedadSourceEl par clave-valor distingue entre mayúsculas y minúsculas en Amazon S3.

El valor del par clave-valor Source se verá afectado por la sustitución de variables para facilitar la selección automática de diferentes archivos de configuración. Para obtener más información sobre la sustitución de variables, consulte Configuración de sustituciones de variables de receptor.

Destination

Especifica dónde se va a almacenar el archivo de configuración en el equipo local. Puede ser una ruta relativa, una ruta completa o una ruta que contenga referencias a variables de entorno, como %PROGRAMDATA%. Si la ruta es relativa, lo es respecto a la ubicación en la que está instalado el agente de Kinesis para Windows. Normalmente, el valor debería ser .\appsettings.json. Este par clave-valor es obligatorio.

AccessKey

Especifica qué clave de acceso debe utilizarse para autenticar el acceso al archivo de configuración de Amazon S3. Este par clave-valor es opcional. No se recomienda utilizar este par clave-valor. Para conocer otros enfoques de autenticación recomendados, consulte Configuración de la autenticación .

SecretKey

Especifica qué clave secreta debe utilizarse para autenticar el acceso al archivo de configuración de Amazon S3. Este par clave-valor es opcional. No se recomienda utilizar este par clave-valor. Para conocer otros enfoques de autenticación recomendados, consulte Configuración de la autenticación .

Region

Especifica qué punto de enlace de la región debe utilizarse para obtener acceso al archivo de configuración de Amazon S3. Este par clave-valor es opcional.

ProfileName

Especifica qué perfil de seguridad debe utilizarse para autenticar el acceso al archivo de configuración de Amazon S3. Para obtener más información, consulte Configuración de la autenticación . Este par clave-valor es opcional.

RoleARN

Especifica qué rol debe adoptarse para autenticar el acceso al archivo de configuración de Amazon S3 en un escenario de acceso entre cuentas. Para obtener más información, consulte Configuración de la autenticación . Este par clave-valor es opcional.

Si no se especifica un complemento ConfigUpdate, no se comprueba ningún archivo de configuración para determinar si es necesario actualizarlo.

A continuación, se muestra un ejemplo de un archivo de configuración appsettings.json que ilustra el uso de los complementos PackageUpdate y ConfigUpdate. En este ejemplo, hay un archivo de versión del paquete que se encuentra en la carpetamycompanyBucket de Amazon S3 denominadoconfig/agent-package-version.json. Aproximadamente cada dos horas, se comprueba si esta archivo ha experimentado cambios. Si se especifica una versión diferente de Kinesis Agent para Windows en el archivo de versión del paquete, la versión del agente especificada se instala en la ubicación especificada en el archivo de versión del paquete.

Además, hay unappsettings.jsonalmacenado en el archivomycompanyBucket de Amazon S3 denominadoconfig/appsettings.json. Aproximadamente, cada 30 minutos ese archivo se compara con el archivo de configuración actual. Si son diferentes, el archivo de configuración actualizado se descarga de Amazon S3 y se instala en la ubicación local habitual deappsettings.jsonArchivo de configuración de.

{
  "Sources": [
    {
      "Id": "ApplicationLogSource",
      "SourceType": "DirectorySource",
      "Directory": "C:\\LogSource\\",
      "FileNameFilter": "*.log",
      "RecordParser": "SingleLine"
    }
  ],
  "Sinks": [
    {
       "Id": "ApplicationLogKinesisFirehoseSink",
       "SinkType": "KinesisFirehose",
       "StreamName": "ApplicationLogFirehoseDeliveryStream",
       "Region": "us-east-1"
    }  
    ],
  "Pipes": [
    {
      "Id": "ApplicationLogSourceToApplicationLogKinesisFirehoseSink",
      "SourceRef": "ApplicationLogSource",
      "SinkRef": "ApplicationLogKinesisFirehoseSink"
    }
  ],
  "Plugins": [
    {
      "Type": "PackageUpdate"
      "Interval": "120",
      "PackageVersion": "s3://mycompany/config/agent-package-version.json"
    },
    {
      "Type": "ConfigUpdate",
      "Interval": "30", 
      "Source": "s3://mycompany/config/appsettings.json",
      "Destination": ".\appSettings.json"      
    }
  ]
}