Descobertas - com escopo, global

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 2 min. de leitura
  • A API de descobertas fornece métodos para lidar com como uma verificação Instance Scan produz descobertas.

    Esta API está incluída com o plug-in Instance Scan (com.glide.instance_scan) e é executada no namespace sn_instance_scan. Para obter mais informações, consulte Verificação de instância.

    Na verificação de instância, as verificações são executadas em cada registro no escopo de uma verificação na instância para gerar descobertas. Cada descoberta contém informações sobre um registro de problema e qual verificação foi violada. Os métodos dedescoberta são usados em Instance Scan verificações como parte do objeto de mecanismo passado para o usuário. Adicione o código ao campo Script no formulário de verificação.

    Descobertas - increment()

    Aumenta a contagem da descoberta atual.

    A contagem de descobertas começa em zero para cada registro que uma verificação analisa em uma verificação. Quando chamado, este método incrementa a contagem de descobertas. A contagem indica que uma descoberta deve ser gerada para o registro atual.

    Este método pode ser chamado várias vezes para significar que esta descoberta tem várias ocorrências de uma violação de verificação no registro atual.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 2. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como contar o número de registros com um estado de falha em uma verificação de tipo de tabela. Para obter mais informações, consulte Criar uma verificação de tipo de tabela.

    (function(engine) {
      if (current.getValue("state") == "failed") {
        engine.finding.increment();
      }
    })(engine);

    Descobertas - incrementWithNode(Object node)

    Se a descoberta atual for de uma verificação de linter, este método incrementará a contagem de descoberta atual e passará simultaneamente o objeto de nó de linter para a descoberta.

    Use este método no campo Script no formulário Verificação de linter. Este método salva informações sobre o nó fornecido, como um número de linha na coluna de detalhes de uma descoberta atual.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    node Objeto Objeto de nó da verificação do linter.
    Tabela 4. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como incrementar nós do tipo linter em uma verificação de linter. Para obter informações sobre como usar métodos de verificação de linter, consulte API LinterCheckAstNode.

    (function(engine) {
      engine.rootNode.visit(function(node) {
        if (node.getTypeName() === "NAME" &&
            node.getNameIdentifier() === "soughtFunction" &&
            node.getParent().getTypeName() === "CALL") {
          engine.finding.incrementWithNode(node);
        } 
      });
    })(engine);

    Descobertas - setCurrentSource(GlideRecord source)

    Define a origem da descoberta atual com base no GlideRecord fornecido.

    Use este método no campo Script de uma verificação Somente script. Este método não é usado para outras verificações porque ele define automaticamente a origem como o registro atual durante a verificação. Para obter mais informações, consulte Criar uma verificação somente de script.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    origem GlideRecord O registro a ser definido como o registro de origem para a descoberta atual. Este valor é adicionado como uma referência no campo Origem da tabela Resultados da verificação [scan_finding].
    Tabela 6. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir a origem atual como um registro de incidente em uma verificação somente de script. Para obter mais informações, consulte Criar uma verificação somente de script.

    (function(engine) {
      var gr = new GlideRecord('incident');
      gr.get('2f99f330730210100a5310c92bf6a798');
      engine.finding.setCurrentSource(gr);
      engine.finding.increment();
    })(engine);