Prerequisites
In order to use Chronicle in your organization, there are a few things you will need in advance:
Environment Access
The admin performing the installation requires privileges to install the agent alongside supported Posit professional products. For VM-based installations, this usually means
sudo
access to those machines, and for Kubernetes-based installations this usually means permission to modify the Helm deployments for that cluster.The agents need to be able to make HTTP(S) connections to the server, so it must be visible to them on the network.
Posit Connect
To collect metrics from Posit Connect, you must
- enable Prometheus metrics in Connect
- log in to Connect with an administrator user and generate an API token with the “Administrator” role.
Posit Workbench
To collect metrics from Posit Workbench, you must
- enable Prometheus metrics in Workbench.
Optionally, additional data can be collected from Workbench via the Workbench API (available in 2024.12.0 and later). To collect this additional data from Posit Workbench,
- a Workbench administrator must enable admin level tokens.
- after enabling admin level tokens and restarting Posit Workbench, generate an Admin API Token.
Continue to installation
After confirming the prerequisites above, continue to the installation instructions corresponding to the type of environment where you have installed your Posit products:
If you are running supported professional products on dedicated Linux servers or VMs, you should run Chronicle on them as well.
If you are running these applications on Kubernetes, you should run Chronicle in the same cluster.