participant_dump.py

"""Print debugging information about a participant.

Usage: run_client.sh --account $USER@pmi-ops.org --project all-of-us-rdr-prod %(prog)s P12345
"""

import httplib
import json
import logging
import pprint
import subprocess

from client import Client
from main_util import configure_logging, get_parser


# Server logs are searchable for at most 30 days (see DA-247).
_SERVER_LOG_FRESHNESS = '30d'


def log_debug_info(client, participant_id, project):
  # basic info: signup time, withdrawal
  logging.info(pprint.pformat(client.request_json('Participant/%s' % participant_id)))

  # Questionnaires available: TODO implement list for Questionnaire
  # QuestionnaireResponses: TODO implement list for QRs on a participant

  logging.info(
      'Server logs for %s from the last %s (oldest first)\n%s',
      participant_id,
      _SERVER_LOG_FRESHNESS,
      '\n'.join(['\t' + line for line in _get_app_log_lines(participant_id, project)]))


def _get_app_log_lines(participant_id, project):
  # Alternate format for easy reading on the CLI:
  #    --format="value(timestamp,severity,protoPayload.status,protoPayload.resource)"
  log_json_data = subprocess.check_output([
      'gcloud',
      'beta',
      'logging',
      'read',
      ('resource.type="gae_app"'
       + ' logName="projects/%(project)s/logs/appengine.googleapis.com%%2Frequest_log"'
       + ' "%(participant_id)s"') % {'participant_id': participant_id, 'project': project},
       '--format', 'json',
       '--freshness', _SERVER_LOG_FRESHNESS,
  ])
  log_data = json.loads(log_json_data)
  formatted_lines = []
  for msg in reversed(log_data):
    payload = msg['protoPayload']
    formatted_lines.append('%(startTime)s %(method)s %(status)d %(resource)s' % payload)
    # Only print messages logged on the server for errors (status != 200 or log severity != INFO).
    if (payload['status'] != httplib.OK or
        any([line['severity'] != 'INFO' for line in payload['line']])):
      for line in payload['line']:
        formatted_lines.append('\t%(time)s %(severity)s %(logMessage)s' % line)
  return formatted_lines


if __name__ == '__main__':
  configure_logging()
  parser = get_parser()
  parser.add_argument('participant_id', help='P12345 format participant ID to look up.')
  rdr_client = Client(parser=parser)
  log_debug_info(rdr_client, rdr_client.args.participant_id, rdr_client.args.project)