Configurar Coleção de Comandos do SO
Se quiser executar scripts de comando do SO no host do Agente de Gerenciamento e coletar a saída contínua dos comandos na forma de logs no Oracle Log Analytics, crie um script próprio.
Tópicos:
-
Pré-requisitos para Configurar a Coleta de Saída de Comando do SO
-
Fatores Importantes a Considerar ao Configurar a Coleta de Comandos do SO
Pré-requisitos para Configurar a Coleta de Saída de Comando do SO
Conclua as seguintes tarefas de pré-requisito antes de configurar a coleta de logs:
-
Criar um script personalizado que consiste em um comando do sistema operacional, cuja saída pode ser coletada no Oracle Log Analytics como logs. A saída do STDOUT e STDERR do script é enviada como payload pelo agente para a nuvem. O payload STDOUT e STDERR pode ser uma única entrada de log ou várias entradas de log. Certifique-se de que o parser usado na origem do Oracle Log Analytics possa fazer parsing dele. Além disso, o script deve ser capaz de tratar condições de erro e verificar se há pré-requisitos.
Armazene seu script personalizado na pasta
logan/scripts/os_cmd. Portanto, o caminho absoluto para armazenar o script é:- Para o Oracle Management Agent:
/opt/oracle/mgmt_agent/usercontent/logan/scripts/os_cmd - Para o plug-in do Oracle Cloud Agent- Management Agent:
/var/lib/oracle-cloud-agent/plugins/oci-managementagent/polaris/usercontent/logan/scripts/os_cmd
- Para o Oracle Management Agent:
-
Permissões especiais de arquivo podem precisar ser fornecidas para executar comandos específicos no script. Configure essas permissões no host de agente manualmente. O script e quaisquer outros comandos/scripts executados pelo script devem ter a permissão execute para o usuário do Management Agent.
Fluxo Geral para Coleta de Logs de Comando do SO
A seguir estão as tarefas de alto nível para coletar a saída de um script de comando do SO:
-
Instale o Management Agent no host no qual você deseja executar OS scripts de comando do sistema operacional e gerar a saída que precisa ser coletada no Oracle Log Analytics. Consulte Configurar Coleta Contínua de Logs Usando o Management Agent.
-
Crie uma entidade para identificar o host do agente no Oracle Log Analytics. A entidade deve estar no mesmo host que o Agente de Gerenciamento no qual o script será executado. A execução remota de comandos do SO não é suportada. Geralmente, a entidade é criada automaticamente quando você instala o Management Agent. Consulte Criar uma Entidade para Representar Seu Recurso de Emissão de Log.
- Crie um parser que possa fazer parsing da saída do script. Este parser deve ser usado na origem que será identificada na etapa a seguir. Consulte Criar um Parser.
- Identifique uma origem existente ou crie uma origem de log do tipo comando OS. Consulte Criar uma Origem de Comando do SO.
- Verifique se você deseja configurar a propriedade de coleta do agente customized_schedule para definir o intervalo de coleta da coleta de comandos do SO. O valor-padrão é
30 seconds. Você pode atualizar a programação no nível do agente, no nível de origem, no nível da entidade ou no nível de associação usando as propriedades de coleta do agente. Consulte Propriedades do Agente que Você Pode Modificar e Modificar Propriedades do Agente. -
Associe as entidades à origem que você criou anteriormente. Consulte Configurar Nova Associação entre Origem e Entidade.
Após a conclusão da associação, o agente começa a executar o comando do SO periodicamente, o STDOUT e o STDERR do comando são coletados como dados de log e esses dados de log começam a fluir para o Oracle Log Analytics.
-
Exiba dados de log no Log Explorer selecionando a origem do Comando do SO que você criou anteriormente. Consulte Filtrar Logs por Atributos de Origem.
Se os dados de log não aparecerem no Log Explorer após a conclusão da configuração, você poderá verificar se há avisos de coleta de agentes para quaisquer problemas. As seguintes advertências estão especificamente relacionadas à coleta de saída do Comando do SO:
-
Falha de Execução de Aplicativo Externo: Ocorreu um erro durante a execução do script ou o comando do SO não é suportado.
-
Aplicativo Externo Não Encontrado: Script não encontrado, Sem permissões de Leitura/Execução no script.
Consulte Exibir Advertências de Coleta do Agente.
Fatores Importantes a Considerar ao Configurar a Coleta de Comandos do SO
-
Use o caminho completo dos comandos nos scripts; Por exemplo, use
/bin/sudoem vez desudo. -
Os scripts são executados como o mesmo usuário que o Management Agent está executando. Isso é importante ao ler ou gravar arquivos no script.
-
A saída gerada pelo script em Saída Padrão (STDOUT) e Erro Padrão (STDERR) é coletada como texto para extrair as entradas de log.
-
As seguintes palavras ou prefixos não são suportados no comando do SO ou no nome do script:
sh,bash,csh,zsh,ksh,dash,cmd -
OS seguintes caracteres não são suportados no comando do SO ou no nome do script:
|,&,;,>,< -
As seguintes sequências de travessia do diretório pai não são suportadas no comando do SO ou no nome do script:
/../ou\..\. Além disso, o comando do SO não pode terminar com/..ou\... -
A variável de ambiente a seguir é passada para os scripts do agente. Você pode usar a variável nos scripts.
-
LA_SOURCE_COMMAND_ID: Este é o id de padrão gerado internamente do comando na origem de log. Ele pode ser usado para diferenciar instâncias de script se o mesmo script for fornecido em vários comandos.
-
Criar uma Origem de Comando do SO
Crie esse tipo de origem para configurar a coleta contínua de saída executando scripts de comando do SO no host do agente, na forma de logs.
-
Abra o menu de navegação e clique em Observabilidade e Gerenciamento. Em Log Analytics, clique em Administração.
-
Os recursos administrativos são listados no painel esquerdo de navegação em Administração. Clique em Origens.
A página Origens é aberta. Clique em Criar Origem.
-
No campo Nome, digite o nome da origem.
Se desejar, adicione uma descrição.
-
Na lista Tipo de Origem, selecione comando do SO.
-
Clique no campo Tipo de Entidade e selecione o tipo de entidade para essa origem de log. Posteriormente, quando você associar essa origem a uma entidade para ativar a coleta de logs por meio do agente de gerenciamento, somente as entidades desse tipo estarão disponíveis para associação. Uma origem pode ter um ou mais tipos de entidade. Observe que a entidade deve estar no mesmo host que o Agente de Gerenciamento no qual o script será executado. A execução remota de comandos do SO não é suportada.
-
Clique no campo Parser e selecione o nome do parser relevante que melhor captura os campos em seus logs.
As seguintes funções de parser não são suportadas:
- A função Detalhes do Cabeçalho não é suportada nos casos em que o tamanho do bloco JSON ou XML é maior que 1 MB e o cabeçalho fica no final do bloco ou do cabeçalho envolve o corpo.
- Deslocamento de tempo
-
Use a guia Comandos para incluir OS scripts de comando do SO e seus detalhes que devem ser executados no host do agente para coletar a saída na forma de logs.
-
Comando: Forneça o caminho do script de comando do SO armazenado no host do agente. O caminho deve ser relativo à pasta de script personalizada. O campo Comando não pode conter sequências de travessia do diretório pai
/../ou\..\. O comando não pode terminar com/..ou\...Caminho de Exemplo:
Se o caminho absoluto do seu script personalizado for
/opt/oracle/mgmt_agent/usercontent/logan/scripts/os_cmd/my_script1.sh, forneça o caminhomy_script1.shneste campo.Para obter detalhes sobre o script personalizado do comando do SO e o local para armazená-lo no host do agente, consulte Pré-requisitos para Configurar a Coleta da Saída do Comando do SO.
-
Argumentos: Opcionalmente, você pode especificar argumentos para o script e separar cada argumento por um caractere de espaço em branco.
-
Descrição: Opcionalmente, forneça uma descrição significativa para este comando e conjunto de argumentos.
Depois de fornecer detalhes do script de comando do SO, ative a caixa de seleção correspondente à linha para ativar a configuração.
-
-
Adicionar Filtros de Dados. Consulte Usar Filtros de Dados em Origens.
-
Adicionar Campos Estendidos. Consulte Usar Campos Estendidos em Origens.
-
Configurar opções de Enriquecimento de Campo. Consulte Configurar Opções de Enriquecimento de Campo.
-
Adicionar Labels. Consulte Usar Labels em Origens.
-
Clique em Salvar.