Page MenuHomePhabricator

Add structured-contents API logging for business analytics
Open, Needs TriagePublic

Description

As a PM or manager, I want to see usage statistics for the structured-contents API, including fine-grained logs on which fields the clients requested
so that I can have a global view of the API usage and see which customers are using different features of the structured-contents product. I'd like to see daily hit counts for the API endpoint, and requests for infoboxes, sections, and descriptions.

Acceptance criteria

  1. CloudWatch is receiving logs from the parser.go and modifier.go code for successful requests to structured contents
  2. Documentation on how to login to AWS Conclode, navigate to CloudWatch and query for strucutred contents logs
  3. Include in the documentation, useful CloudWatch queries to aggregate individual logs into meaning business metrics for the structured-contents` endpoint

ToDo

  • Check Prod logs for current strucutred-contents (SC) API calls, document the process to login to AWS and query the current SC logs
  • Update parser.go with log entries with "successful responses" and which features were requested (or enabled/disabled in ENv variable)
Test Strategy

Add unit tests for the added logs

Checklist for testing

  • check if logs are output
Things to consider:
  • Perhaps the current logs have enough data to to show the SC features that are requests.

Related Objects

StatusSubtypeAssignedTask
ResolvedNone
InvalidNone
OpenNone
OpenNone