Como configurar o Conector do Service Graph para OpenTelemetry

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 9 min. de leitura

    • Configure trabalhos de importação programada para inserir dados de ServiceNow Observabilidade de nuvem (anteriormente Lightstep) no seu Configuration Management Database (CMDB).

    Antes de Iniciar

    Para usar este Conector do Service Graph, você precisa de uma assinatura para uma Unidade de Assinatura baseada na aplicação Visibilidade IT Operations Management (ITOM) ou na aplicação Descoberta ITOM. Conforme definido na seção intitulada "Tipos de recurso de TI gerenciados" em Visão geral da unidade de assinatura da ServiceNow, para sua assinatura, para recursos de TI gerenciados criados ou modificados em CMDB por este Conector do Service Graph, mas que ainda não são gerenciados pela Visibilidade do ITOM ou pela Descoberta do ITOM, esses recursos aumentarão o consumo da Unidade de Assinatura dessa aplicação. Analise o consumo atual da unidade de assinatura na Visibilidade do ITOM ou no ITOM Discovery para garantir a capacidade disponível.

    Dependências e requisitos:
    • A aplicação da Store Componentes comuns de integração para CMDB, que é instalado automaticamente.
    • O app da Store dos Modelos de classe de IC do CMDB, que é instalado automaticamente. Consulte Modelos de classe de IC do CMDB.
    • O plug-in de licença da Descoberta do ITOM (com.snc.itom.discovery.license). Você deve ativar este plug-in.
    • Plug-in de licenciamento do ITOM (com.snc.itom.license). Para obter mais informações, consulte Solicitação da Descoberta.
    • O plug-in Datastream Action (com.glide.hub.action_type.datastream), que é instalado automaticamente.
    • Base para observabilidade para CMDB (sn_observability), que só é necessário para ingestão de eventos. Para que a Gestão de eventos funcione, o app Base para observabilidade para CMDB deve ser instalado antes da instalação do conector. Para obter mais informações, confira Base para observabilidade para CMDB em ServiceNow Store.
    Nota:
    Se você tiver uma versão anterior do Conector do Service Graph para OpenTelemetry, não migre os dados do conector antigo. Você deve desinstalar a versão anterior e executar a nova integração.

    Função necessária: admin

    Procedimento

    1. Certifique-se de que o escopo da aplicação está definido como Conector do Service Graph para OpenTelemetry usando o seletor de aplicações.
      Para obter mais informações, consulte Seletor de aplicações.
    2. Navegar até Tudo > Conectores do Service Graph > OpenTelemetry > Configuração.
    3. Na página de Introdução, selecione Introdução.
    4. Configure as propriedades da aplicação para configurar suas credenciais da organização e de autenticação para enviar solicitações para os APIs do ServiceNow Observabilidade de nuvem.
      1. Na seção Configurar conexão da página Conector do Service Graph para OpenTelemetry, selecione a tarefa Introdução.
      2. Para a tarefa Usar o OpenTelemetry, certifique-se de que a aplicação Observabilidade de nuvem atenda às condições conforme abordado no artigo ServiceNow Cloud Observability setup (Configuração da Observabilidade de nuvem da ServiceNow) [KB1527588] na Base de conhecimento do Now Support.
        Importante:
        Anote seus projetos, organização e detalhes de chave de API da aplicação Observabilidade de nuvem para serem usados posteriormente durante a instalação do conector.
        Após configurar o ambiente do OpenTelemetry na aplicação Observabilidade de nuvem, retorne à configuração assistida e marque a tarefa Usar o OpenTelemetry como concluída, selecionando Marcar como concluído.
      3. Insira os detalhes da sua organização Observabilidade de nuvem de onde você deseja recuperar os projetos, recursos e informações de mapeamento de dependência.
        1. Para a tarefa Configurar sua organização, selecione Configurar.
        2. No campo Valor do formulário Propriedades de conexão do Service Graph, insira o nome da sua organização Observabilidade de nuvem.
        3. Selecione Atualizar.
        4. Marque a tarefa Configurar sua organização como concluída clicando em Marcar como Concluída.
      4. Insira os detalhes da chave de API associados à aplicação Observabilidade de nuvem.
        1. Para a tarefa Create Chave API, selecione Configurar.
        2. No campo Chave de API do formulário Credenciais de Chave de API, insira a chave de API associada à aplicação Observabilidade de nuvem que você anotou na etapa 4.b.
        3. Selecione Atualizar.
        4. Defina a tarefa Configurar Chave da API como concluída clicando em Marcar como Concluída.
      5. Teste a conexão da API Observabilidade de nuvem para importar dados da aplicação Observabilidade de nuvem.
        1. Para a tarefa Testar conexão, selecione Configurar.
        2. Selecione o link relacionado Testar Conexão.
        3. Quando o campo Status estiver definido como Êxito, selecione X para fechar a caixa de diálogo Testar a conexão e retornar à página de configuração assistida.

          Se algum dos testes apresentar algum erro, siga as sugestões de correção.

        4. Defina a tarefa Testar conexão como concluída clicando em Marcar como Concluída.
      6. Recupere todos os projetos incluídos em sua organização Observabilidade de nuvem.
        1. Para a tarefa Obter projetos, selecione Configurar.
        2. Selecionar Obter Projetos.
        3. Quando a lista relacionada Propriedades do projeto for preenchida com todos os projetos incluídos na organização que você especificou na etapa 4.c.ii, selecione X para fechar a caixa de diálogo Obter projetos e retornar à página de configuração assistida.
        4. Defina a tarefa Obter projetos como concluída clicando em Marcar como Concluída.
    5. Opcional: Defina configurações adicionais para definir o tempo de lookback, adicionar projetos excluídos, executar diagnósticos de projeto e definir configurações de integração para mapas de serviço e itens de configuração (ICs) obsoletos.
      1. Na seção Configurações avançadas da página Conector do Service Graph para OpenTelemetry, selecione Continuar.
      2. Configure o tempo de lookback a partir do momento em que você deseja recuperar recursos dos projetos.

        O tempo de lookback é usado para calcular a hora de início e a hora de término da recuperação de recursos de um projeto de uma organização e deve corresponder à configuração de frequência do trabalho agendado. Por exemplo, se o tempo de lookback for definido para 12 horas, os recursos serão recuperados a partir da hora de início calculada como a hora atual menos 12 horas e até a hora de término que é a hora atual.

        1. Para a tarefa Configurar tempo de lookback, selecione Configurar.
        2. No campo Valor do formulário Propriedades de Conexão do Service Graph, insira o tempo de lookback em horas.
        3. Selecione Atualizar.
        4. Defina a tarefa Configurar tempo de lookback como concluída clicando em Marcar como Concluída.
      3. Selecione os projetos dos quais você não deseja recuperar recursos.
        1. Para a tarefa Adicionar projetos excluídos, selecione Configurar.
        2. Selecione um projeto na coluna Projeto.
        3. Marque a caixa de seleção Excluir projeto.
        4. Selecione Atualizar.
        5. Repita as etapas de 5.c.ii a 5.c.iv para cada projeto que você deseja excluir.
        6. Selecione X para fechar a caixa de diálogo Adicionar projetos excluídos e retornar à página de configuração assistida.
        7. Defina a tarefa Adicionar projetos excluídos como concluída clicando em Marcar como Concluída.
      4. Execute o diagnóstico do projeto para testar a resposta da API Recurso e verifique se a API contém o nome do cluster do Kubernetes, o namespace do Kubernetes e os nós do Kubernetes.
        1. Para a tarefa Executar diagnóstico do projeto, selecione Configurar.
        2. Selecione um projeto na coluna Projeto.
        3. Selecione Executar diagnóstico.
        4. Quando o campo Status de diagnóstico estiver definido como Êxito, selecione X para fechar a caixa de diálogo Executar diagnóstico do projeto e retornar à página de configuração assistida.

          Se algum dos testes de diagnóstico apresentar algum erro, siga as instruções no campo Mensagem de diagnóstico para resolver os erros.

        5. Repita as etapas de 5.d.ii a 5.d.iv para cada projeto em que você deseja executar diagnósticos.
        6. Defina a tarefa Executar diagnóstico do projeto como concluída clicando em Marcar como Concluída.
      5. Configure as propriedades do sistema para mapas de serviço e ICs obsoletos.
        1. Para a tarefa Configurar propriedades do sistema para o conector, selecione Configurar.
        2. Verifique os valores padrão das propriedades ou preencha os valores de uma configuração personalizada.
        3. Selecione Salvar.
        4. Defina a tarefa Configurar propriedades do sistema para o conector como concluída selecionando Marcar como Concluída.
    6. Configure os trabalhos agendados para importar dados completos ou incrementais da aplicação Observabilidade de nuvem.
      1. Na seção Configure os trabalhos de importação agendada da página Conector do Service Graph para OpenTelemetry, selecione Continuar.
      2. Ative o trabalho agendado para importação completa de dados.

        Por padrão, o trabalho agendado OpenTelemetry Resources está disponível para importação completa de dados. No entanto, você deve ativar o trabalho.

        1. Na tarefa Configurar o trabalho agendado para importação completa, selecione Configurar.
        2. No formulário "Importação de dados programada" do trabalho agendado OpenTelemetry Resources, verifique os valores de campo do trabalho agendado e marque a caixa de seleção Ativo.

          Para obter mais informações, consulte Schedule a data import.

        3. Selecione Atualizar.
        4. Defina a tarefa Configurar o trabalho agendado para importação completa como concluída clicando em Marcar como concluído na configuração assistida.
      3. Opcional: Ative o trabalho agendado para importação de dados delta.

        Por padrão, o trabalho agendado OpenTelemetry Delta Resources está disponível para importação de dados delta. No entanto, você deve ativar o trabalho.

        Nota:
        A extração de dados delta não ocorre nos seguintes cenários:
        • A importação de dados completa é programada ao mesmo tempo.
        • O campo Data/hora da última execução de uma fonte de dados está vazio.
        • O último período de extração de dados delta ultrapassa três dias.
        1. Na tarefa Configurar o trabalho agendado para importação delta, selecione Configurar.
        2. No formulário "Importação de dados programada" do trabalho agendado OpenTelemetry Delta Resources, verifique os valores de campo do trabalho agendado e marque a caixa de seleção Ativo.

          Para obter mais informações, consulte Schedule a data import.

        3. Selecione Atualizar.
        4. Defina a tarefa Configurar o trabalho agendado para importação delta como concluída clicando em Marcar como concluído na configuração assistida.
      Nota:
      Ao adicionar um novo projeto para recuperar recursos, certifique-se de executar uma importação completa antes de executar uma importação delta para evitar dados parciais e preencher o CMDB com precisão.
    7. Gerencie alertas e eventos enviando eventos da aplicação Observabilidade de nuvem para a aplicação ServiceNow Gestão de eventos.
      Você só poderá gerenciar alertas e eventos quando a aplicação Base para observabilidade do CMDB estiver instalada.
      Nota:
      A habilitação deste recurso requer uma licença paga de Observabilidade de nuvem, mas o recurso também está disponível para contas gratuitas com a finalidade de avaliar o produto em ambientes de não produção. Você pode entrar em contato com o representante da sua conta ServiceNow para obter mais informações.
      1. Na seção Gerenciar alertas e eventos na página Conector do Service Graph para OpenTelemetry, selecione Continuar.
      2. Crie um destino de webhook para um projeto.
        1. Para a tarefa Criar um webhook, selecione Configurar.
        2. Selecione um projeto que não tenha sido incluído na coluna Projeto.
        3. Selecione Criar Webhook para criar um destino de webhook na aplicação Observabilidade de nuvem.
        4. Depois que uma mensagem de sucesso for exibida, selecione X para fechar a caixa de diálogo Criar um webhook e retornar à página de configuração assistida.

          Quando o webhook é criado com sucesso:

          • O sistema cria automaticamente um registro de usuário para cada destino de webhook em sua instância ServiceNow.
          • O nome de usuário do registro do usuário começa com ls_api_<project_name> e o usuário é atribuído à função evt_mgmt_integration.
        5. Repita as etapas 7.b.ii a 7.b.iv para cada projeto para o qual você deseja criar um webhook.
        6. Defina a tarefa Criar um webhook como concluída selecionando Marcar como Concluída na configuração assistida.
      3. Configure a propriedade do sistema para ingerir eventos que não tenham ICs correspondentes no CMDB.
        1. Para a tarefa Configurar a propriedade de ICs sem correspondência, selecione Configurar.
        2. No campo Valor, insira verdadeiro.
        3. Selecione Atualizar.
        4. Defina a tarefa Configurar a propriedade de ICs sem correspondência como concluída selecionando Marcar como Concluída na configuração assistida.