Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces a new
Data Collector API
. The purpose of this API is to enable Open edX instances to collect and send content-related data to a central service (e.g., the Shipyard API). This lays the foundation for the Hosting division to make data-driven decisions and improve the overall service offering.The new API is part of the
data-collector
module, ensuring clear separation from existing APIs in thedata
directory for better modularity and future extensibility.Rationale
data-collector
) allows for easier maintenance and potential migration if required in the future.Key Features
Authentication:
API Design:
/eox-core/data-api/v1/collect-data/
query_file_content
: Content of a YAML file containing SQL queries.query_file_url
: A URL pointing to a publicly accessible YAML file with queries.destination_url
: The URL to which the results will be sent.query_file_content
orquery_file_url
is required.Async Task Execution:
generate_report
) processes the provided queries:edxapp
database.destination_url
.Validation:
Logging and Error Handling:
How to Test
eox-core
plugin installed.Notes