Informes de registros

En esta página se describe cómo usar Service Infrastructure para permitir que los servicios gestionados envíen registros a proyectos de productor de servicios y de consumidor de servicios.

La API Service Control acepta datos de registro estructurados o no estructurados, que agrupa y reenvía a Cloud Logging. Tanto tú como los usuarios de tus servicios gestionados podéis usar laGoogle Cloud consola y la consola de APIs de Google para ver los datos de registro, o bien usar la API Cloud Logging para acceder a los datos de forma programática.

Mientras que Logging por sí solo permite que un servicio gestionado genere registros para que los utilices como desarrollador del servicio gestionado, la API Service Control también te permite generar registros destinados a tus usuarios. De esta forma, los usuarios pueden entender y diagnosticar el uso que hacen de tu servicio gestionado.

Configurar registros

Antes de enviar registros a la API Service Control, debe especificar tres datos diferentes en la configuración del servicio:

  • Nombres de registro: puede tener uno o varios registros distintos. Cada registro se identifica con un nombre único. Los registros individuales te permiten aislar distintos tipos de datos para que sea más fácil visualizarlos o usarlos.

  • Recursos monitorizados: un recurso monitorizado representa una entidad de nube que genera datos de registro. Para definir un recurso monitorizado en la configuración del servicio, consulta la especificación técnica en monitored_resource.proto. Te recomendamos que uses el mismo recurso monitorizado para la monitorización y el registro.

  • Configuración de los registros: te permite especificar el recurso monitorizado asociado a cualquier flujo de registro y el proyecto de productor o consumidor de servicios al que se debe enviar cada registro. Para configurar la asociación de registros, consulta la especificación técnica en logging.proto.

En el siguiente ejemplo de configuración de servicio, el registro activity_log se configura para que se envíe al consumidor del servicio.

# The definition of the monitored resource to be used.
monitored_resources:
- type: library.appspot.com/Branch
  description: A library branch
  display_name: Library Branch
  launch_stage: ALPHA
  labels:
  - key: resource_container
    description: The Google Cloud resource container (ie. project id) for
    the branch.
  - key: location
    description: The Google Cloud region the branch is located.
  - key: branch_id
    description: The ID of the branch.

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

# The logging configuration.
logging:
  consumer_destinations:
  - monitored_resource: library.appspot.com/Branch
    logs:
    - activity_log

Una vez que hayas creado la configuración, tendrás que seguir los pasos que se indican en los artículos Gestionar configuraciones de servicios y Gestionar lanzamientos de servicios para enviar la configuración del servicio a la API Service Management, que configurará el recurso monitorizado en Cloud Logging.

Registros de informes

Una vez que se haya completado la inserción de la configuración del servicio, puedes llamar a la API Service Control para registrar entradas de registro. En el siguiente ejemplo se usa el comando gcurl para mostrar la llamada. Para saber cómo configurarlo, consulta la sección Primeros pasos con la API Service Control.

gcurl -d "{
  'operations': [ {
    'operationId': 'e8bf36ef-f9b5-4274-b4f9-079a3731e6e5',
    'operationName': 'New book arrived',
    'consumerId': 'projects/library-consumer',
    'startTime': '`date +%FT%T%:z`',
    'endTime': '`date +%FT%T%:z`',
    'labels': {
      'location': 'us-east1',
      'branch_id': 'my-test-library-branch'
    },
    'logEntries': [ {
      'severity': 'INFO',
      'textPayload': 'new book arrived',
      'name': 'activity_log'
    } ]
  } ]
}" https://servicecontrol.googleapis.com/v1/services/endpointsapis.appspot.com:report