project:report

After collecting the metrics described in by Generated metrics, you can use the nox session project:report to create a report using one of the following formats:

• JSON

  This format is usually used in the CI. The created JSON file is uploaded as an artifact, which can be downloaded and aggregated for multiple projects (see Metrics schema).

• markdown

  This is displayed in the GitHub Action’s summary for a given CI run. Displaying this content per CI run gives the developer immediate feedback as to how the code quality has changed between code modifications.

Metrics schema

The PTB supports the uniform json schema for metrics used by all projects of the Exasol Product Integration Team:

• Exasol Schemas

• Metrics Schema

• Metrics Schema Project

The Integration team runs regular aggregation of the metrics from all projects into a centralized data sink as described in the company Wiki.

Development

If the metrics schema needs to be updated, the Metrics Schema Project provides a convenient way (via a Pydantic model) to update and generate an updated schema for the metrics.

Note

The updated version needs to be first integrated into the Exasol Schemas Project.