Como relatar registros

Nesta página, você aprende a usar o Service Infrastructure para que os serviços gerenciados enviem registros a projetos tanto de produtor quanto de consumidor de serviço.

A API Service Control aceita dados de registro estruturados ou não estruturados, que são agrupados e encaminhados para o Stackdriver Logging. Você e os usuários dos seus serviços gerenciados podem usar o console do Google Cloud Platform e o console de APIs do Google para ver os dados de registro ou usar a API Stackdriver Logging para acessar os dados programaticamente.

Assim como o próprio Logging permite que um serviço gerenciado gere registros para uso por você como desenvolvedor do serviço gerenciado, a API Service Control também permite gerar registros destinados a seus usuários. Isso possibilita que seus usuários entendam e diagnostiquem o uso que fazem do seu serviço gerenciado.

Como configurar registros

Antes de enviar registros para a API Service Control, você precisa especificar três informações diferentes na sua configuração de serviço:

  • Nomes dos registros: você pode ter um ou mais registros distintos. Cada registro é identificado por um nome exclusivo. Registros individuais permitem isolar tipos diferentes de dados caso seja mais fácil visualizá-los ou usá-los dessa forma.

  • Recursos monitorados: os tipos de recursos monitorados controlam o formato dos dados mantidos em um determinado registro. O Logging oferece um grupo conhecido de tipos de recurso monitorados para seleção.

  • Configuração de registro: permite especificar o recurso monitorado associado a qualquer fluxo de registros e o projeto de produtor ou consumidor de serviço em que cada registro será enviado.

No exemplo do estado de configuração de serviço a seguir, o registro activity_log é configurado para ser enviado ao consumidor de serviço. Consulte service.proto para mais detalhes sobre a configuração de serviço.

# The monitored resource to be used.
monitored_resources:
- type: api
  labels:
  - key: cloud.googleapis.com/location
  - key: serviceruntime.googleapis.com/api_version
  - key: serviceruntime.googleapis.com/api_method
  - key: cloud.googleapis.com/project
  - key: cloud.googleapis.com/service

# The log name to be used.
logs:
- name: activity_log

# The logging configuration.
logging:
  consumer_destinations:
  - monitored_resource: api
    logs:
    - activity_log

Como relatar registros

Depois de configurar os logs na configuração de serviço e enviar a configuração usando a API Service Management, você pode chamar a API Service Control para relatar as entradas de registro. No exemplo a seguir, o comando gcurl é usado para demonstrar a chamada. Para saber como configurar isso, consulte Primeiros passos com a API Service Control.

gcurl -d "{
  'operations': [ {
    'operationId': 'e8bf36ef-f9b5-4274-b4f9-079a3731e6e5',
    'operationName': 'google.example.hello.v1.HelloService.GetHello',
    'consumerId': 'project:endpointsapis-consumer',
    'startTime': '`date +%FT%T%:z`',
    'endTime': '`date +%FT%T%:z`',
    'labels': {
      'cloud.googleapis.com/location': 'global',
      'serviceruntime.googleapis.com/api_version': 'v1',
      'serviceruntime.googleapis.com/api_method': 'google.example.hello.v1.HelloService.GetHello',
      'cloud.googleapis.com/project': 'proven-catcher-789',
      'cloud.googleapis.com/service': 'endpointsapis.appspot.com'
    },
    'logEntries': [ {
      'severity': 'INFO',
      'textPayload': 'new book arrived',
      'name': 'activity_log'
    } ]
  } ]
}" https://servicecontrol.googleapis.com/v1/services/endpointsapis.appspot.com:report
Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Documentação do Service Infrastructure