qlever-control icon indicating copy to clipboard operation
qlever-control copied to clipboard

Add `system-info` command to collect infos for troubleshooting

Open Qup42 opened this issue 6 months ago • 1 comments

We often ask for the same info when debugging issues. It might be useful to have a command system-info that automatically collects some basic info. Users can then be told to run this command and attach its output to issue reports.

Example of the current version:

>>> qlever system-info

Command: system-info

================== General Info ==================
qlever-control: 0.5.2
OS: Linux (Arch Linux)
Arch: x86_64
Host: archmobile
RAM: 30.1 GB total, 19.5 GB available
CPU: 8 Cores, 16 Threads @ 5.13 GHz
CWD: /home/julian/code/uni/osm-live-updates-qlever
Disk space in . (/dev/nvme0n1p3 @ / is ext4): 142.16GB free / 905.34GB total
User/Group on host: uid=1000(julian) gid=1000(julian) groups=1000(julian),961(docker),1002(sudo)
=================== Qleverfile ===================
# Qleverfile for OSM Planet, use with the qlever script (pip install qlever)
#
# qlever get-data  # takes ~50 mins to download .ttl.bz2 file of ~ 300 GB
# qlever index     # takes ~12 hours and ~20 GB RAM (on an AMD Ryzen 9 5900X)
# qlever start     # takes a few seconds
#
# For the OSM data of a single country, do `qlever setup-config osm-country`
# and edit the Qleverfile to specify the country,

[data]
NAME         = osm-andorra
#DATA_URL     = https://osm2rdf.cs.uni-freiburg.de/ttl/planet.osm.ttl.bz2
DATA_URL     = https://osm2rdf.cs.uni-freiburg.de/ttl/and.osm.ttl.bz2
GET_DATA_CMD = curl --location --fail --continue-at - --remote-time --output ${NAME}.ttl.bz2 ${DATA_URL}
VERSION      = $$(date -r ${NAME}.ttl.bz2 +"%d.%m.%Y")
DESCRIPTION  = OSM Planet, data from ${DATA_URL} version ${VERSION} (complete OSM data, with GeoSPARQL predicates ogc:sfContains and ogc:sfIntersects)

[index]
INPUT_FILES     = ${data:NAME}.ttl.bz2
CAT_INPUT_FILES = lbzcat -f -n 2 ${INPUT_FILES}
STXXL_MEMORY    = 20G
SETTINGS_JSON   = { "languages-internal": [], "prefixes-external": [""], "ascii-prefixes-only": false, "num-triples-per-batch": 5000000 }
INDEX_BINARY    = /home/julian/CLionProjects/qlever/cmake-build-release/IndexBuilderMain

[server]
PORT                        = 7007
ACCESS_TOKEN                = ${data:NAME}_oQSb1fI7z87h
MEMORY_FOR_QUERIES          = 90G
CACHE_MAX_SIZE              = 40G
CACHE_MAX_SIZE_SINGLE_ENTRY = 30G
TIMEOUT                     = 300s
SERVER_BINARY               = /home/julian/CLionProjects/qlever/cmake-build-release/ServerMain

[runtime]
SYSTEM = native
IMAGE  = docker.io/adfreiburg/qlever:latest

[ui]
UI_CONFIG = osm-planet

Qup42 avatar Aug 28 '24 11:08 Qup42