Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make it clear how to view server and console logs in different environments #394

Open
HardikGoyal2003 opened this issue Oct 2, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request Impact: High target: Q1 2025 Plan to complete by 31 Mar 2025. Work: Low

Comments

@HardikGoyal2003
Copy link
Member

HardikGoyal2003 commented Oct 2, 2024

Logging is crucial for debugging, so it’s important to include the following information in this documentation:

  • How do we console log information from the tests?
  • Where should we look for these logs— in the terminal or in Docker container logs? If so, which image logs specifically?
@seanlip seanlip changed the title how to view console logs for frontend tests? Make it clear how to view server and console logs in different environments Jan 2, 2025
@seanlip
Copy link
Member

seanlip commented Jan 2, 2025

Generalizing this issue: let's ensure that it's clear and properly documented how to view all the different types of logs. Ideally, we should make sure this is clearly documented for both the Python and Docker setups (focusing on Python for now).

Python checklist

  • Add and view backend logs when running the dev server.
  • Add and view frontend logs when running the dev server.
  • Add and view backend logs when running backend unit tests.
  • Add and view frontend logs when running frontend unit tests.
  • Add and view backend logs when running e2e tests.
  • Add and view frontend logs when running e2e tests.
  • Add and view backend logs when running acceptance tests.
  • Add and view frontend logs when running acceptance tests.
  • Add and view backend logs when running lighthouse tests.
  • Add and view frontend logs when running lighthouse tests.

Docker checklist

  • Add and view backend logs when running the dev server.
  • Add and view frontend logs when running the dev server.
  • Add and view backend logs when running backend unit tests.
  • Add and view frontend logs when running frontend unit tests.
  • Add and view backend logs when running e2e tests.
  • Add and view frontend logs when running e2e tests.
  • Add and view backend logs when running acceptance tests.
  • Add and view frontend logs when running acceptance tests.
  • Add and view backend logs when running lighthouse tests.
  • Add and view frontend logs when running lighthouse tests.

@seanlip
Copy link
Member

seanlip commented Jan 2, 2025

Somewhat related: oppia/oppia#18632 and oppia/oppia#16127

@seanlip seanlip added the target: Q1 2025 Plan to complete by 31 Mar 2025. label Jan 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Impact: High target: Q1 2025 Plan to complete by 31 Mar 2025. Work: Low
Projects
Status: Todo
Development

No branches or pull requests

3 participants