Gerenciar configurações de observabilidade

Este documento descreve como configurar as opções de observabilidade do seu app Gemini Enterprise usando o console Google Cloud . Depois de ativar as configurações, você pode conferir os seguintes dados das suas interações com o assistente no app da Web do Gemini Enterprise:

  • Veja métricas no Metrics Explorer.
  • Veja traces e intervalos no Explorador de traces.

Principais conceitos

Esta seção apresenta os principais conceitos relacionados à capacidade de observação no Gemini Enterprise.

Conceito Descrição
Trace Um trace é uma coleção de períodos que representa uma única solicitação ou transação à medida que ela flui por diferentes serviços e componentes.

Por exemplo, um trace representa todo o ciclo de vida de uma solicitação. Isso inclui um usuário fazendo uma pergunta ao assistente do Gemini Enterprise, o assistente respondendo e qualquer ação subsequente acionada pela resposta, como o envio de um e-mail.
Período Um período é uma unidade de trabalho única e cronometrada em um trace. Ela representa uma operação específica, como uma chamada de função, uma solicitação de API ou uma consulta de banco de dados. Cada período inclui detalhes como horários de início e término, um ID exclusivo e a relação com outros períodos. Essas relações formam um rastreamento.
Registros de período Os registros de extensão são mensagens ou eventos com carimbo de data/hora e formato livre associados a uma extensão específica. Elas fornecem informações contextuais detalhadas sobre a execução de um intervalo, ajudando os usuários a depurar problemas e entender o fluxo de uma solicitação.
Métricas As métricas são medidas numéricas que os sistemas coletam ao longo do tempo. Essas medições representam o desempenho, a utilização de recursos ou o comportamento de um sistema. Os engenheiros usam métricas para monitorar a integridade do sistema, identificar tendências e acionar alertas.
Registros de auditoria de uso Os registros de auditoria de uso são registros de atividades administrativas e acessos nos recursos do Google Cloud . Eles fornecem informações detalhadas sobre quem realizou qual ação, quando e de onde. Esses registros são essenciais para auditoria de segurança, compliance e entendimento de como seus recursos estão sendo usados.
Registros de erros do conector do Gemini Enterprise Os registros de erros do conector do Gemini Enterprise capturam erros e falhas encontrados ao integrar o Gemini Enterprise com fontes de dados de terceiros, como Jira e Microsoft OneDrive. Esses registros incluem problemas de conexão, problemas de transformação de dados e erros de API.

Antes de começar

Verifique se você tem o seguinte:

Ativar as configurações de observabilidade

Para ativar a observabilidade do seu app do Gemini Enterprise, use o consoleGoogle Cloud ou a API REST.

Console

Para ativar as configurações de observabilidade usando o console Google Cloud , siga estas etapas:

  1. No console Google Cloud , acesse a página Gemini Enterprise.

    Gemini Enterprise

  2. Clique no nome do app que você quer configurar.

  3. Clique em Configurações e na guia Observabilidade.

  4. Você pode ativar ou desativar as seguintes configurações:

    Configuração de observabilidade Descrição
    Ativar a instrumentação de traces e registros do OpenTelemetry Quando ativada, é possível conferir traces, spans, registros de span e métricas associados aos seus registros no Cloud Logging.
    Ativar a geração de registros de entradas de comandos e saídas de respostas Quando ativado, o Cloud Logging registra o conteúdo completo dos comandos e respostas dos usuários. Isso inclui dados sensíveis ou informações de identificação pessoal (PII). Para ativar essa configuração, primeiro ative a opção Ativar a instrumentação de traces e registros do OpenTelemetry.

REST

Para configurar as opções de observabilidade usando a API REST, consulte as seções a seguir:

Ativar a capacidade de observação ao criar um app

Para criar um novo app com a observabilidade ativada, execute o seguinte comando:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines?engineId=APP_ID" \
-d '{
  "name": "projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID",
  "displayName": "APP_DISPLAY_NAME",
  "solutionType": "SOLUTION_TYPE_SEARCH",
  "searchEngineConfig": {
    "searchTier": "SEARCH_TIER_ENTERPRISE",
    "searchAddOns": ["SEARCH_ADD_ON_LLM"],
    "requiredSubscriptionTier": "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT"
  },
  "industryVertical": "GENERIC",
  "appType": "APP_TYPE_INTRANET",
  "observabilityConfig": {
    "observabilityEnabled": true,
    "sensitiveLoggingEnabled": true
  }
}'

Substitua:

  • ENDPOINT_LOCATION: a multirregião da sua solicitação de API. Especifique um dos seguintes valores:
    • us para a multirregião dos EUA
    • eu para a multirregião da UE
    • global para o local global
    Para mais informações, consulte Especificar uma multirregião para seu repositório de dados.
  • PROJECT_ID: ID do projeto.
  • LOCATION: a multirregião do seu repositório de dados: global, us ou eu
  • APP_ID: o ID do app que você quer criar.
  • APP_DISPLAY_NAME: o nome de exibição do app que você quer criar.

Ativar a observabilidade para um app atual

Para ativar a observabilidade em um app atual, execute o seguinte comando:

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID?updateMask=observabilityConfig" \
-d '{
  "observabilityConfig": {
    "observabilityEnabled": true,
    "sensitiveLoggingEnabled": true
  }
}'

Substitua:

  • ENDPOINT_LOCATION: a multirregião da sua solicitação de API. Especifique um dos seguintes valores:
    • us para a multirregião dos EUA
    • eu para a multirregião da UE
    • global para o local global
    Para mais informações, consulte Especificar uma multirregião para seu repositório de dados.
  • PROJECT_ID: ID do projeto.
  • LOCATION: a multirregião do seu repositório de dados: global, us ou eu
  • APP_ID: o ID do app.

Desativar as configurações de observabilidade

Para desativar as configurações de observabilidade do seu app Gemini Enterprise, use o console do Google Cloud ou a API REST.

Console

Para desativar as configurações de observabilidade usando o console do Google Cloud , siga estas etapas:

  1. No console Google Cloud , acesse a página Gemini Enterprise.

    Gemini Enterprise

  2. Clique no nome do app em que você quer desativar as configurações de observabilidade.

  3. Clique em Configurações e na guia Observabilidade.

  4. É possível desativar as seguintes configurações:

    Configuração de observabilidade Descrição
    Ativar a instrumentação de traces e registros do OpenTelemetry Quando desativada, essa configuração interrompe a coleta de traces, períodos, registros de período e métricas. Ela também desativa a configuração Ativar a geração de registros de entradas de comandos e saídas de respostas, o que significa que nenhum registro é enviado ao Cloud Logging.
    Ativar a geração de registros de entradas de comandos e saídas de respostas Quando desativado, o Cloud Logging não registra entradas de comandos e saídas de respostas.

REST

Para desativar as configurações de observabilidade usando a API REST, execute o seguinte comando:

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID?updateMask=observabilityConfig" \
-d '{
  "observabilityConfig": {
    "observabilityEnabled": false,
    "sensitiveLoggingEnabled": false
  }
}'

Substitua:

  • ENDPOINT_LOCATION: a multirregião da sua solicitação de API. Especifique um dos seguintes valores:
    • us para a multirregião dos EUA
    • eu para a multirregião da UE
    • global para o local global
    Para mais informações, consulte Especificar uma multirregião para seu repositório de dados.
  • PROJECT_ID: ID do projeto.
  • LOCATION: a multirregião do seu repositório de dados: global, us ou eu
  • APP_ID: o ID do app.

A seguir