Skip to main content

Reporting

Overview​

Moderne offers three types of reports for administrators:

  • Audit logs - every action any user takes in the system is logged. We currently have two ways of accessing it: via a UI, and via the API as a download in CEF format.
  • Recipes run - every recipe run by every user in your system. Includes the recipe name, time saved, user that ran it, recipe, as well as various statistics of the recipe run.
  • Commits made - every commit made by every user in your system. Includes the recipe run id (to be able to link the reports together), the type of commit, status of the commit job, as well as other statistics of the commit job.

Audit logs​

Audit logs are accessible from https://<TENANT>.moderne.io/admin/audit-logs, and can be viewed in the UI, accessed from the API, or downloaded in CEF format.

To download audit logs, use the "Export to CEF" button:

Other reports (recipe runs and commits)​

To access non-audit-log reports, navigate to https://<TENANT>.moderne.io/admin/reports.

These reports can be downloaded using the download button:

Accessing via the API​

All of these reports can be accessed via the API as well. Here is an example of how to prepare and download the recipe run report:

mutation firstGenerateRecipeRunReport {
  downloadRecipeRunReport {
    id
  }
}

query secondDownloadRecipeRunReport($id: ID!) {
  recipeRunReportDownload(id: $id) {
    id
    state
    stateMessage
    url
    fileSize
  }
}

The output of secondDownloadRecipeRunReport will include a URL which you can then use to download the report.

Note: These actions require admin access, and Moderne tokens do not provide admin access (even for platform administrators). You must use your current JWT, accessible by accessing https://<TENANT>.moderne.io/graphql and copying the authorization: