Reports

Chronicle provides reports as Quarto Markdown Documents. These reports process the data that Chronicle has collected to provide insight into your usage of Posit Team Products.

Report Files

When the Chronicle Server starts, it creates the report files in the same location that the data is stored. By default, the reports are created in the /var/lib/posit-chronicle/data/reports directory. If you specified a custom storage location, then reports are stored in {[LocalStorage].Location}/reports. If you store Chronicle data in S3, then the reports are stored in {[S3Storage].Location/Prefix}/reports.

The reports directory contains the Quarto documents that contain the code to produce the report output:

  • posit-usage.qmd is the Posit Team Usage Report. This report provides an overview of your usage of Posit Team Products.

There are also a few other supporting style sheets, images, etc. All of the files in the reports directory are necessary when publishing or rendering the reports.

Running Reports

You can run these reports in a few different ways.

Deploy to Connect

You can publish the report files to Posit Connect (see the Posit Connect documentation for detailed steps). When publishing to Posit Connect, you must include all files from the reports directory.

Render in Workbench

You can Render the reports using Posit RStudio IDE (see the Posit RStudio IDE documentation for detailed steps).

Use the Command Line

You can render the reports using the Quarto command-line tool (see the Quarto documentation for detailed steps). This does require installing a number of libraries.

Install Operating System Dependencies

The R libraries used by the reports depend on a number of operating system libraries. You may already have some or all of these dependencies installed.

Terminal
sudo apt install -y wget libcurl4-openssl-dev libfontconfig1-dev libxml2-dev libssl-dev libharfbuzz-dev libfribidi-dev libfreetype6-dev libpng-dev libtiff5-dev libjpeg-dev
Terminal
sudo dnf install -y cmake openssl-devel libcurl-devel freetype-devel libpng-devel libtiff-devel libjpeg-devel harfbuzz-devel fribidi-devel
sudo dnf install -y https://apache.jfrog.io/artifactory/arrow/almalinux/$(cut -d: -f5 /etc/system-release-cpe | cut -d. -f1)/apache-arrow-release-latest.rpm
sudo dnf install -y arrow-devel arrow-dataset-devel arrow-acero-devel
Install R, Quarto, and R Libraries

The Chronicle reports depend on R, Quarto, and a few R libraries. You may already have some or all of these dependencies installed.

After R and Quarto are installed, you must install a few R libraries.

Terminal
Rscript -e 'install.packages(c("urltools", "curl", "knitr", "arrow", "tidyverse", "DT", "gt", "plotly", "paws"), repos="https://p3m.dev/cran/latest")'
Running the Report with Quarto

After installing the pre-requisites, you can run the report with quarto render posit-usage.qmd.

Back to top