Acessar os registros do Gemini para Google Cloud

Neste documento, descrevemos como ativar a coleta e o armazenamento da atividade do Gemini para Google Cloud , incluindo o seguinte:

• Registros de comandos e respostas do Gemini para Google Cloud , como entrada do usuário, informações contextuais e respostas.
• Registros de metadados do Gemini para Google Cloud , como metadados de telemetria e linhas de código aceitas pelo usuário.

Se precisar gerar métricas do Gemini Code Assist, consulte Monitorar o uso do Gemini para Google Cloud .

O Gemini para Google Cloud não coleta nem envia ao Cloud Logging outras interações que o usuário possa ter tido com o Gemini para Google Cloud, incluindo feedback por escrito. Os dados coletados são enviados ao Cloud Logging para armazenamento. Para analisar esses dados, pesquise entradas de registro com o tipo de recurso cloudaicompanion.googleapis.com/Instance.

Esse recurso não registra comandos nem respostas no Gemini na Vertex AI. Para ativar os registros do Gemini na Vertex AI, consulte Ativar registros de auditoria de acesso a dados.

Os papéis do Identity and Access Management (IAM) controlam a capacidade de um principal acessar registros. É possível conceder papéis predefinidos a principais ou criar papéis personalizados. Para mais informações sobre as permissões necessárias, consulte Controle de acesso.

Por padrão, o Cloud Logging criptografa o conteúdo do cliente armazenado em repouso. Os dados armazenados em buckets de registros pelo Logging são criptografados usando chaves de criptografia de chaves, um processo conhecido como criptografia de envelope. Para acessar os dados de registro, é preciso ter acesso a essas chaves de criptografia de chaves. Elas são gerenciadas pelo Google sem que você precise realizar nenhuma ação.

Sua organização pode ter requisitos de criptografia regulamentares, relacionados à conformidade ou avançados que nossa criptografia em repouso padrão não oferece. Para atender aos requisitos da sua organização, em vez de o Google gerenciar as chaves de criptografia que protegem seus dados, você pode gerenciar suas chaves.

Para informações específicas sobre o uso de chaves de criptografia gerenciadas pelo cliente (CMEK), incluindo vantagens e limitações, consulte Chaves de criptografia gerenciadas pelo cliente.

Limitações

A gravação de dados de registros do Gemini no Google Cloud é limitada às interações do usuário com o Gemini Code Assist no ambiente de desenvolvimento integrado.

Além disso, se o usuário final desativar a configuração de telemetria do VS Code, o Gemini para Google Cloud não vai registrar metadados. No entanto, os registros de comandos e respostas ainda são gerados quando os administradores ativam o registro de comandos e respostas.

Antes de começar

• Para receber as permissões necessárias para ver os registros do Gemini para Google Cloud , peça ao administrador para conceder a você o papel do IAM de Leitor de registros (roles/logging.viewer) no seu projeto. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

  Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou de outros papéis predefinidos.

• Revise os preços do Cloud Logging e os preços do Gemini para Google Cloud antes de ativar o Gemini para o registro em Google Cloud log.

• Ative o Gemini para o registro de Google Cloud .

Ver registros de usuários e de metadados do Gemini para Google Cloud

Para ver os registros de usuário e de metadados do Gemini para Google Cloud , faça o seguinte:

gcloud logging read "resource.type=cloudaicompanion.googleapis.com/Instance" --project PROJECT_ID  --limit 3

Gemini para registros do Google Cloud

Um LogEntry é a unidade básica de dados no Cloud Logging. As seções a seguir fornecem listas de campos encontrados no LogEntry para um evento da plataforma Gemini para Google Cloud , como solicitações do usuário e respostas do Gemini para Google Cloud .

Solicitações de usuários

A tabela a seguir mostra uma lista de campos encontrados em uma entrada de registro de solicitação do usuário.

A amostra a seguir mostra um exemplo de entrada de registro para um evento de solicitação de chat.

{
  "insertId": "654581e30003b19e340bbd96",
  "resource": {
    "type": "cloudaicompanion.googleapis.com/Instance",
    "labels": {
        instance_id: "default"
        location: "global"
        resource_container: "my-project-id"
     }
  },
  "timestamp": "2023-11-03T23:27:31.242078Z",
  "labels": {
    "product": "code_assist",
    "request_id": "4ea1e265-ea5d-4d11-b3c8-39bad9c96326"
    "user_id": "my-user@example.com"
  },
  "jsonPayload" : {
    @type: "type.googleapis.com/google.cloud.cloudaicompanion.logging.v1.RequestLog"
    "taskCompletionRequest":
      input: {
        messages: [{
          author: "USER"
          content: "What are some best practices to save cost on my Google Cloud bill?"
        }]
        preamble: ""
      }
  }
  "logName": "projects/my-project-id/logs/cloudaicompanion.googleapis.com%2Frequest",
  "receiveTimestamp": "2023-11-03T23:27:31.255648319Z"
  "severity": "INFO"
}

O exemplo a seguir mostra uma entrada RequestLog para solicitações de sugestão de código inline automática e pedir ao Gemini para Google Cloud em um arquivo de código.

Os dados de solicitação para sugestões de código inline usam o objeto codeCompletionRequest (conforme mostrado no exemplo a seguir), enquanto a geração acionada manualmente usa codeGenerationRequest.

{
  "insertId": "654581e30003b19e340bbd96",
  "resource": {
    "type": "cloudaicompanion.googleapis.com/Instance",
    "labels": {
        instance_id: "default"
        location: "global"
        resource_container: "my-project-id"
     }
  },
  "timestamp": "2023-11-03T23:27:31.242078Z",
  "labels": {
    "product": "code_assist",
    "request_id": "4ea1e265-ea5d-4d11-b3c8-39bad9c96326"
    "user_id": "my-user@example.com"
  },
  "jsonPayload" : {
    @type: "type.googleapis.com/google.cloud.cloudaicompanion.logging.v1.RequestLog"
    "codeCompletionRequest": {
      "input_data_context": {
        "additional_context": {
          "files": [
            {
              "language": "go",
              "path": "{/path/to/../current-file.go",
              "segments": [
                {
                  "content": "...Prefix Text..."
                },
                {
                  "content": "...Suffix Text..."
                }
              ],
              "state": ["EDITED"]
            },
            {
              "language": "go",
              "path": "/path/to/../recent-file.go",
              "segments": [
                {
                  "content": "...File Text..."
                }
              ],
              "state": ["RECENTLY_OPENED"]
            }
          ]
        }
      }
    }
  }
  "logName": "projects/my-project-id/logs/cloudaicompanion.googleapis.com%2Frequest",
  "receiveTimestamp": "2023-11-03T23:27:31.255648319Z"
  "severity": "INFO"
}

Respostas do Gemini para Google Cloud

A tabela a seguir mostra os campos de resposta e as descrições do Gemini para Google Cloud .

Registros de metadados do Gemini para Google Cloud

Para que os registros de metadados sejam gerados, a configuração de telemetria da extensão do Gemini Code Assist precisa estar ativada para as extensões do VS Code e do IntelliJ. Além disso, para o VS Code, a configuração global de coleta de telemetria também precisa estar ativada.

Os registros de metadados do Gemini para Google Cloud seguem a mesma estrutura dos registros do Gemini para Google Cloud , mas especificam campos diferentes. A tabela a seguir mostra uma lista de campos encontrados em uma entrada de registro de solicitação do usuário:

Confira a seguir um exemplo de entrada de registro codeExposure:

{
  insertId: "whfrqgc1gj"
  jsonPayload: {
    @type: "type.googleapis.com/google.cloud.cloudaicompanion.logging.v1.MetadataLog"
    clientName: "CloudCodeVscode"
    clientVersion: "1.93.1"
    codeExposure: {
      originalRequestId: "cac019824a0b25ba"
      programmingLanguage: "python"
    }
  requestId: "0c5178fe-446f-4ab6-b996-520dec100cf8"
  }
  labels: {
    method: "Export.Metrics"
    product: "code_assist"
    user_id: "user@company.com"
  }
  logName: "projects/my-project-id/logs/cloudaicompanion.googleapis.com%2Fmetadata"
  receiveTimestamp: "2025-02-03T23:34:35.662837985Z"
  resource: {
    labels: {
      instance_id: "default"
      location: "global"
      resource_container: "my-project-id"
    }
  type: "cloudaicompanion.googleapis.com/Instance"
  }
  severity: "INFO"
  timestamp: "2025-02-03T23:34:35.021564463Z"
}

Confira a seguir um exemplo de entrada de registro codeAcceptance:

{
  insertId: "whfrqgc1gk"
  jsonPayload: {
    @type: "type.googleapis.com/google.cloud.cloudaicompanion.logging.v1.MetadataLog"
    clientName: "CloudCodeVscode"
    clientVersion: "1.93.1"
    codeAcceptance: {
      linesCount: 2
      originalRequestId: "cac019824a0b25ba"
      programmingLanguage: "python"
    }
    requestId: "ddf11040-c315-452e-b7cd-928c3f97984e"
  }
  labels: {
    method: "Export.Metrics"
    product: "code_assist"
    user_id: "user@company.com"
  }
  logName: "projects/my-project-id/logs/cloudaicompanion.googleapis.com%2Fmetadata"
  receiveTimestamp: "2025-02-03T23:34:37.632662272Z"
  resource: {
    labels: {
      instance_id: "default"
      location: "global"
      resource_container: "my-project-id"
    }
    type: "cloudaicompanion.googleapis.com/Instance"
  }
  severity: "INFO"
  timestamp: "2025-02-03T23:34:36.778692483Z"
} 

Confira a seguir um exemplo de entrada de registro chatExposure:

{
  insertId: "3diaj2c208"
  jsonPayload: {
    @type: "type.googleapis.com/google.cloud.cloudaicompanion.logging.v1.MetadataLog"
    clientName: "CloudCodeVscode"
    clientVersion: "1.93.1"
    chatExposure: {
      originalRequestId: "cac019824a0b25ba"
    }
  requestId: "0c5178fe-446f-4ab6-b996-520dec100cf8"
  }
  labels: {
    method: "Export.Metrics"
    product: "code_assist"
    user_id: "user@company.com"
  }
  logName: "projects/my-project-id/logs/cloudaicompanion.googleapis.com%2Fmetadata"
  receiveTimestamp: "2025-02-03T23:34:35.662837985Z"
  resource: {
    labels: {
      instance_id: "default"
      location: "global"
      resource_container: "my-project-id"
    }
  type: "cloudaicompanion.googleapis.com/Instance"
  }
  severity: "INFO"
  timestamp: "2025-02-03T23:34:35.021564463Z"
}

Calcular a taxa de aceitação de código

Para calcular a taxa de aceitação usando os registros de metadados do Gemini Code Assist, encontre o número total de IDs exclusivos de eventos com codeAcceptance.originalRequestId e divida pelo número total de IDs exclusivos de eventos com codeExposure.originalRequestId. É possível refinar ainda mais esse cálculo por linguagem de programação e por usuário usando os respectivos campos de evento de registro de metadados.

Calcular linhas de código aceitas

Para calcular as linhas de código aceitas, encontre o valor máximo de codeAcceptance.linesCount para um codeAcceptance.originalRequestId exclusivo. Em seguida, adicione o valor linesCount para todos os eventos codeAcceptance finais de cada originalRequestId para calcular o total de linhas de código aceitas. É possível refinar ainda mais esse cálculo por linguagem de programação e por usuário usando os respectivos campos de evento de registro de metadados.

A seguir

• Saiba como ver, analisar e monitorar seus registros em Google Cloud.
• Saiba como monitorar o uso do Gemini para Google Cloud.