Skip to main content

Web based Sys Admin server statistics

Project description

ckanext-selfinfo

This extension is built to represent a basic information about the running CKAN Application accessible only to admins.

CKAN should be configured to be able to connect to Redis as it heavily relies on it for storage.

On CKAN admin page /ckan-admin/selfinfo can see a big variety of information such as System Info, RAM, disk Usage, CKAN Errors, GIT Info and more.

Main Selfinfo Screen

Check full documentation for more information.

Selftools

Selftools plugin is now available for ckanext-selfinfo.

It is designed to do different sort of operations with SOLR/DB/Redis Data, for example Search within the DB using UI, update records in DB, SOLR search, index Dataset within UI, CKAN config query and more.

You can find more details on what it does and what it needed for in here.

Selftracking (new)

Selftracking plugin is now available for ckanext-selfinfo.

An plugin that provides lightweight tracking of user interactions. It records page views, API calls, and supports custom event tracking such as resource downloads, enabling better insights into portal usage and user behavior.

You can find more details on what it does and how to confiugre here.

What's New in Version 2

Version 2 introduces several important improvements and breaking changes:

New Features

  • Enhanced UI Styling - Completely redesigned interface with improved user experience
  • Action Security - New ckan.selfinfo.actions_prefix configuration option to add custom prefixes to all actions for enhanced security through obscurity
  • Updated Documentation - Comprehensive documentation updates with better examples and configuration guides

Breaking Changes

Category Configuration Changes

Version 2 changes the default behavior for categories. Previously, all categories were enabled by default. Now you must explicitly configure which categories to use:

  • Selfinfo: Only platform_info is enabled by default, while status_show was removed from the list and added by default.
  • Selftools: Only solr is enabled by default

Upgrading from Version 1 to Version 2

When upgrading from version 1.x to 2.x, you must explicitly configure your categories in your CKAN configuration file:

For Selfinfo, add to your .ini file:

# Enable all categories (v1 behavior)
ckan.selfinfo.categories_list = python_modules platform_info ram_usage disk_usage git_info freeze errors actions auth_actions blueprints helpers status_show ckan_queues ckan_solr_schema ckan_cli_commands

# Or enable only specific categories you need
ckan.selfinfo.categories_list = platform_info ram_usage disk_usage errors

For Selftools, add to your .ini file:

# Enable all tools (v1 behavior)
ckan.selftools.categories = solr db redis config model datastore

# Or enable only specific tools you need
ckan.selftools.categories = solr db redis

Note: If you don't specify these configurations, only the default categories will be available, which may result in missing functionality you previously relied on.

See the full documentation for detailed configuration options.

Active work

You can find future features that currently being under development on this board.

Requirements

Compatibility with core CKAN versions:

CKAN version Compatibility
2.7 untested
2.8 untested
2.9 untested
2.10 yes
2.11 yes
master yes as of 2025/06 (check test results)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ckanext_selfinfo-2.0.0.tar.gz (310.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ckanext_selfinfo-2.0.0-py3-none-any.whl (357.2 kB view details)

Uploaded Python 3

File details

Details for the file ckanext_selfinfo-2.0.0.tar.gz.

File metadata

  • Download URL: ckanext_selfinfo-2.0.0.tar.gz
  • Upload date:
  • Size: 310.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for ckanext_selfinfo-2.0.0.tar.gz
Algorithm Hash digest
SHA256 647d4e88c9be72c6bdb8a7d7082b577e88648bc2629d785811d1feccf9151a0d
MD5 2fdd01f14a9786b1c429f612a691a579
BLAKE2b-256 667e0274f3f338121578d95c9b52c3723b1ae3071388bb2d27223edf7881facf

See more details on using hashes here.

File details

Details for the file ckanext_selfinfo-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ckanext_selfinfo-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 541c204e4ca838fec1ee2a838c60d28651c905275abe0a59796524df9b1f2efb
MD5 ec9008256c9cba062a11af982b9062c6
BLAKE2b-256 5fd19fda0b2f4e574624d3c6d282528dcb8ed5dd1549f33f2e98a30d235d9450

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page