Configuração de atualizações automáticas

Usar aappsettings.jsonPara habilitar a atualização automática do Amazon Kinesis Agent para Microsoft Windows e do arquivo de configuração do Kinesis Agent para Windows. Para controlar o comportamento de atualização, especifique o par de chave/valor Plugins no mesmo nível no arquivo de configuração que Sources, Sinks e Pipes.

O par de chave/valor Plugins especifica a funcionalidade geral adicional a ser usada que não se insere especificamente nas categorias de origens, coletores e pipes. Por exemplo, há um plug-in para atualizar o Kinesis Agent para Windows e um plug-in para atualizar oappsettings.jsonArquivo de configuração. Os plug-ins são representados como objetos JSON e sempre têm um par de chave/valor Type. O Type determina quais outros pares de chave/valor podem ser especificados para o plug-in. Há suporte para os seguintes tipos de plug-in:

PackageUpdate

Especifica que o Kinesis Agent para Windows deve verificar periodicamente um arquivo de configuração da versão do pacote. Se o arquivo de versão do pacote indicar que uma versão diferente do Kinesis Agent para Windows deve ser instalada, o Kinesis Agent para Windows fará download dessa versão e a instalará. Os pares de chave/valor do plug-in PackageUpdate incluem:

Type

O valor deve ser a string PackageUpdate, e ele é obrigatório.

Interval

Especifica com que frequência é verificada a existência de alterações em minutos no arquivo de versão do pacote representadas como uma string. Esse par de chave/valor é opcional. Se não for especificado, o valor padrão será 60 minutos. Se o valor for inferior a 1, não ocorrerá nenhuma verificação de atualização.

PackageVersion

Especifica o local do arquivo JSON de versão do pacote. O arquivo pode residir em um compartilhamento de arquivos (file://), um site (http://) ou Amazon S3 (s3://). Por exemplo, um valor des3://mycompany/config/agent-package-version.jsonindica que o Kinesis Agent para Windows deve verificar o conteúdo doconfig/agent-package-version.jsonarquivomycompanyBucket do Amazon S3. Ele deve realizar atualizações com base no conteúdo desse arquivo.

nota

O valor da propriedadePackageVersionO par de chave/valor faz distinção de maiúsculas Amazon S3 minúsculas para

Veja a seguir um exemplo do conteúdo de um arquivo de versão do pacote:

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

OVersionEspecifica qual versão do Kinesis Agent para Windows deve ser instalada se ainda não estiver instalada. A referência de variável {Version} no PackageUrl resolve o valor que você especificar para o par de chave/valor Version. Neste exemplo, a variável é resolvida para a string 1.0.0.106. Essa resolução de variável é fornecida para que possa haver um único lugar no arquivo de versão do pacote no qual a versão desejada específica é armazenada. Você pode usar vários arquivos de versão do pacote para controlar o ritmo da implementação de novas versões do Kinesis Agent para Windows para validar uma nova versão antes de uma implantação maior. Para reverter uma implantação do Kinesis Agent para Windows, altere um ou mais arquivos de versão do pacote para especificar uma versão anterior do Kinesis Agent para Windows que funcione em seu ambiente.

O valor do par de chave/valor PackageVersion é afetado pela substituição de variáveis para facilitar a seleção automática de diferentes arquivos de versão do pacote. Para obter mais informações sobre substituição de variáveis, consulte Configuração de substituições de variáveis de coletor.

AccessKey

Especifica qual chave de acesso usar ao autenticar o acesso ao arquivo de versão do pacote no Amazon S3. Esse par de chave/valor é opcional. Não é recomendável usar esse par de chave/valor. Para saber as abordagens de autenticação alternativas que são recomendadas, consulte Como configurar a autenticação da .

SecretKey

Especifica qual chave secreta usar ao autenticar o acesso ao arquivo de versão do pacote no Amazon S3. Esse par de chave/valor é opcional. Não é recomendável usar esse par de chave/valor. Para saber as abordagens de autenticação alternativas que são recomendadas, consulte Como configurar a autenticação da .

Region

Especifica o endpoint de região a ser usado ao acessar o arquivo de versão do pacote do Amazon S3. Esse par de chave/valor é opcional.

ProfileName

Especifica qual perfil de segurança usar ao autenticar o acesso ao arquivo de versão do pacote no Amazon S3. Para obter mais informações, consulte Como configurar a autenticação da . Esse par de chave/valor é opcional.

RoleARN

Especifica qual função assumir ao autenticar o acesso ao arquivo de versão do pacote no Amazon S3 em um cenário entre contas. Para obter mais informações, consulte Como configurar a autenticação da . Esse par de chave/valor é opcional.

Se nenhum plug-in PackageUpdate for especificado, nenhum arquivo de versão do pacote será verificado para determinar se uma atualização é obrigatória.

ConfigUpdate

Especifica que o Kinesis Agent para Windows deve verificar periodicamente se há umappsettings.jsonArmazenado em um compartilhamento de arquivos, no site ou no Amazon S3. Se houver um arquivo de configuração atualizado, ele será baixado e instalado pelo Kinesis Agent para Windows.ConfigUpdateOs pares de chave/valor incluem o seguinte:

Type

O valor deve ser a string ConfigUpdate, e ele é obrigatório.

Interval

Especifica com que frequência é verificada a existência de um novo arquivo de configuração representado como uma string. Esse par de chave/valor é opcional e, se não for especificado, o padrão será 5 minutos. Se o valor for inferior a 1, a atualização do arquivo de configuração não será verificada.

Source

Especifica onde procurar um arquivo de configuração atualizado. O arquivo pode residir em um compartilhamento de arquivos (file://), um site (http://) ou Amazon S3 (s3://). Por exemplo, um valor des3://mycompany/config/appsettings.jsonindica que o Kinesis Agent para Windows deve verificar se há atualizações para oconfig/appsettings.jsonarquivomycompanyBucket do Amazon S3.

nota

O valor da propriedadeSourceO par de chave-valor faz distinção de maiúsculas e minúsculas no Amazon S3.

O valor do par de chave/valor Source é afetado pela substituição de variáveis para facilitar a seleção automática de diferentes arquivos de configuração. Para obter mais informações sobre substituição de variáveis, consulte Configuração de substituições de variáveis de coletor.

Destination

Especifica onde armazenar o arquivo de configuração no computador local. Pode ser um caminho relativo, um caminho absoluto ou um caminho que contenha referências de variável de ambiente, como %PROGRAMDATA%. Se o caminho for relativo, ele será relativo ao local onde o Kinesis Agent para Windows está instalado. Em geral, o valor deve ser .\appsettings.json. Esse par de chave/valor é obrigatório.

AccessKey

Especifica qual chave de acesso usar ao autenticar o acesso ao arquivo de configuração no Amazon S3. Esse par de chave/valor é opcional. Não é recomendável usar esse par de chave/valor. Para saber as abordagens de autenticação alternativas que são recomendadas, consulte Como configurar a autenticação da .

SecretKey

Especifica qual chave secreta usar ao autenticar o acesso ao arquivo de configuração no Amazon S3. Esse par de chave/valor é opcional. Não é recomendável usar esse par de chave/valor. Para saber as abordagens de autenticação alternativas que são recomendadas, consulte Como configurar a autenticação da .

Region

Especifica o endpoint de região a ser usado ao acessar o arquivo de configuração do Amazon S3. Esse par de chave/valor é opcional.

ProfileName

Especifica qual perfil de segurança usar ao autenticar o acesso ao arquivo de configuração no Amazon S3. Para obter mais informações, consulte Como configurar a autenticação da . Esse par de chave/valor é opcional.

RoleARN

Especifica qual função assumir ao autenticar o acesso ao arquivo de configuração no Amazon S3 em um cenário entre contas. Para obter mais informações, consulte Como configurar a autenticação da . Esse par de chave/valor é opcional.

Se nenhum plug-in ConfigUpdate for especificado, nenhum arquivo de configuração será verificado para determinar se uma atualização é obrigatória.

Veja a seguir um exemplo de arquivo de configuração appsettings.json que demonstra o uso dos plug-ins PackageUpdate e ConfigUpdate. Neste exemplo, há um arquivo de versão do pacote localizado nomycompanyBucket do Amazon S3 nomeado comoconfig/agent-package-version.json. É verificada a existência de alterações nesse arquivo a cada 2 horas aproximadamente. Se uma versão diferente do Kinesis Agent para Windows for especificada no arquivo de versão do pacote, a versão especificada do agente será instalada do local especificado no arquivo de versão do pacote.

Além disso, há umappsettings.jsonarmazenado no arquivo de configuraçãomycompanyBucket do Amazon S3 nomeado comoconfig/appsettings.json. Aproximadamente a cada 30 minutos, esse arquivo é comparado com o arquivo de configuração atual. Se eles forem diferentes, o arquivo de configuração atualizado será baixado do Amazon S3 e instalado no local normal doappsettings.jsonArquivo de configuração.

{
  "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"      
    }
  ]
}