Pristy Support

pristy-support runs on the server hosting Pristy, not from Pristy Portail. It needs Python 3.9 or later, a Linux system with systemd, and Docker for container checks and PostgreSQL access.

pristy-support is a command-line tool that audits a Pristy installation: system and service status, errors in the logs, database statistics, configuration file review and Solr index status. It produces a Markdown report, an HTML report and a ZIP archive, to attach to a support request.

The source code is published at gitlab.com/pristy-oss/pristy-support.

Installation

The tool is published on PyPI:

pip install pristy-support

The tool adapts its checks to the available permissions. Run as root or with sudo, it reaches every check; as a member of the docker group, it reaches the containers; with a standard account, some system information is missing.

Running a full audit

sudo pristy-support audit

The audit runs the following checks:

CheckContent
Systemsystemd services, Docker containers and their age, memory and swap, disk space, load, firewall
Logserrors, warnings and critical messages of each service in journalctl
Databasenode, property and aspect counts, internal and external (SSO/LDAP) users, groups, sites, table sizes
Configurationreview of alfresco-global.properties and of the Pristy applications’ env-config.json, missing parameters
Solrindexed nodes and transactions, indexing lag, error nodes, tracker status

It writes pristy_audit_report.md, pristy_audit_report.html and pristy_audit.zip to the current directory. Main options:

  • --output-dir, -o: report directory;
  • --formats, -f: formats to produce, among md, html and zip (all three by default);
  • --since, -s: log period to analyse, for example 24h, 7d (default) or 30d.
sudo pristy-support audit --output-dir /tmp/audit --formats html,zip --since 30d

Running a single check

CommandCheck
pristy-support system-checksystem, services and containers
pristy-support logs-check --since 7dservice logs
pristy-support access-logs-checkproxy access logs: request volume, peaks, browsers, most active IP addresses and sites
pristy-support database-checkdatabase statistics
pristy-support solr-checkalfresco and archive Solr cores, and synchronisation report against the database
pristy-support config-checkconfiguration files

Querying the database

The database-query command groups diagnostic queries on the Alfresco database:

CommandResult
list-modulesinstalled Alfresco modules and their version
node-info <uuid|nodeRef|id>type, store, dates, path, aspects and properties of a node, for example one quoted in a Solr error
audit-tablesaudit applications, entry count, size and vacuum state of the alf_audit_* and alf_prop_* tables
table-sizeslargest tables
locked-nodeslocked nodes (check-out, editing session)
trash-and-orphansnodes in the trash and orphan content waiting for cleanup
largest-documentslargest files
db-activityrunning or blocked PostgreSQL queries
pristy-support database-query node-info workspace://SpacesStore/0d3b2c8e-1f5a-4e2b-9a7c-6b1d2e3f4a5b

These queries are read-only, except drop-module, which removes the record of an Alfresco module from the database after confirmation.

drop-module modifies the database. Back up the database before using it.

Configuration

The defaults match a standard Pristy installation (/opt/alfresco/tomcat/shared/classes/alfresco-global.properties, /opt/pristy-*/public/env-config.json, database in the postgres container). To adapt them, generate a configuration file:

pristy-support init-config

The pristy-support.yml file is looked up, in order, in the current directory, in ~/.pristy-support.yml, in ~/.config/pristy-support/config.yml and then in /etc/pristy/pristy-support.yml. The --config option points to another file:

pristy-support --config /etc/pristy/pristy-support.yml audit

It sets in particular the monitored services and containers, the memory and disk thresholds, the database connection, the configuration file paths and the access log source. The web_publish section also publishes each HTML report to a directory served by the web server (/var/www/html/pristy-support by default), keeping the last ten.

Debug mode

The --debug option shows every command run by the tool (systemctl, journalctl, docker, SQL queries) and its result:

sudo pristy-support --debug audit

Last Update - October 20, 2026
Call To Action 📣

Try Pristy

You can try the Pristy demo by signing up using the link below.

Demander une démo