Documentation
Table of Contents
Objeto de correlação
Os objetos a seguir estão diretamente relacionados à API correlation.
Correlação
O objeto de correlação tem as seguintes propriedades.
|Propriedade|Tipo|Descrição| |--------|---------------------------------------- -----------|-----------| |correlationid|string|(readonly) ID da correlação.| |nome
(obrigatório)|string|Nome da correlação.| |descrição|string|Descrição da correlação.| |status|inteiro|Se a correlação está habilitada ou desabilitada.
Os valores possíveis são:
0 - (padrão) habilitado;
1 - desabilitado.|
Operação de correlação
O objeto de operação de correlação define uma operação que será executada quando uma correlação é executada. Tem o seguinte propriedades.
|Propriedade|Tipo|Descrição| |--------|---------------------------------------- -----------|-----------| |tipo
(obrigatório)|inteiro|Tipo de operação.
Valores possíveis:
0 - fechar eventos antigos;
1 - fechar novo evento.|
Filtro de correlação
O objeto de filtro de correlação define um conjunto de condições que devem ser atendidas para executar as operações de correlação configuradas. Possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| conditions | array | Conjunto de condições de filtro a serem usadas para filtrar os resultados. As condições serão classificadas na ordem de sua colocação na fórmula. Comportamento da propriedade: - obrigatório |
| evaltype | integer | Método de avaliação da condição do filtro. Valores possíveis: 0 - E/Ou; 1 - E; 2 - Ou; 3 - Expressão personalizada. Comportamento da propriedade: - obrigatório |
| eval_formula | string | Expressão gerada que será usada para avaliar as condições do filtro. A expressão contém IDs que referenciam condições de filtro específicas por seu formulaid. O valor de eval_formula é igual ao valor de formula para filtros com uma expressão personalizada.Comportamento da propriedade: - somente leitura |
| formula | string | Expressão definida pelo usuário a ser usada para avaliar as condições dos filtros com uma expressão personalizada. A expressão deve conter IDs que referenciem condições de filtro específicas por seu formulaid. Os IDs usados na expressão devem corresponder exatamente aos definidos nas condições do filtro: nenhuma condição pode permanecer não utilizada ou omitida.Comportamento da propriedade: - obrigatório se evaltype estiver definido como "expressão personalizada" |
Condição do filtro de correlação
O objeto de condição do filtro de correlação define uma condição específica que deve ser verificado antes de executar as operações de correlação.
|Propriedade|Tipo|Descrição| |--------|---------------------------------------- -----------|-----------| |tipo
(obrigatório)|inteiro|Tipo de condição.
Valores possíveis:
0 - tag de evento antiga;
1 - nova tag de evento;
2 - novo grupo de host de evento;
3 - par de tags de evento;
4 - valor de tag de evento antigo;
5 - novo valor de tag de evento.| |tag|string|tag de evento (antiga ou nova). Necessário quando o tipo de condição é: 0, 1, 4, 5.| |groupid|string|ID do grupo de hosts. Necessário quando o tipo de condição é: 2.| |oldtag|string|Etiqueta de evento antiga. Necessário quando o tipo de condição é: 3.| |newtag|string|Etiqueta de evento antiga. Necessário quando o tipo de condição é: 3.| |value|string|Valor da tag de evento (antiga ou nova). Necessário quando o tipo de condição é: 4, 5.| |formulaid|string|ID exclusivo arbitrário que é usado para fazer referência à condição de uma expressão customizada. Só pode conter letras maiúsculas. O ID deve ser definido pelo usuário ao modificar as condições do filtro, mas será gerado novamente ao solicitá-los posteriormente.| |operator|inteiro|Operador de condição.
Requerido quando o tipo de condição é: 2, 4, 5.|
Para entender melhor como usar filtros com vários tipos de expressões, veja exemplos no correlation.get e método correlation.create Páginas.
Os seguintes operadores e valores são suportados para cada condição tipo.
|Condição|Nome da condição|Operadores suportados|Valor esperado| |---------|--------------|-------------------|---- ----------| |2|Grupo de hosts|=, <>|ID do grupo de hosts.| |4|Valor da tag de evento antigo|=, <>, like, not like|string| |5|Novo valor da tag de evento|=, <>, like, not like|string|