Extension Observability


Extension Basics

Title
Observability
Name
ckanext-observability
Type
Public extension
Description
The **Observability** extension for CKAN aims to provide enhanced monitoring and diagnostic capabil
CKAN versions
Download-Url (zip)
Last commit
a year ago (2024-05-02 16:49:51)
Url to repo
Category
Regional Government Themes


Background Infos

Description (long)
Show details

ckanext-observability

Observability plugin

Getting Started

  1. Install the extension on your virtualenv:

    (pyenv) $ pip install -e git+https://github.com/OpenGov-OpenData/ckanext-observability.git#egg=ckanext-observability
    
  2. Install the extension requirements:

    (pyenv) $ pip install -r ckanext-observability/requirements.txt
    

Installation

To install ckanext-observablity:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Clone the source and install it on the virtualenv

    git clone https://github.com/OpenGov-OpenData/ckanext-observability.git cd ckanext-observablity pip install -e . pip install -r requirements.txt

  3. Add observablity to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  4. Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload

Config settings

None at present

TODO: Document any optional config settings here. For example:

# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.observablity.some_setting = some_default_value

Developer installation

To install ckanext-observablity for development, activate your CKAN virtualenv and do: git clone https://github.com/OpenGov-OpenData/ckanext-observability.git cd ckanext-observablity python setup.py develop pip install -r dev-requirements.txt

Tests

To run the tests, do:

pytest --ckan-ini=test.ini

Releasing a new version of ckanext-observablity

If ckanext-observablity should be available on PyPI you can follow these steps to publish a new version:

  1. Update the version number in the setup.py file. See PEP 440 for how to choose version numbers.

  2. Make sure you have the latest version of necessary packages:

Version
Version release date
(not set)
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

To install ckanext-observablity:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Clone the source and install it on the virtualenv

    git clone https://github.com/OpenGov-OpenData/ckanext-observability.git cd ckanext-observablity pip install -e . pip install -r requirements.txt

  3. Add observablity to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini

Plugins to configure (ckan.ini)
observability
CKAN Settings (ckan.ini)
# ckanext.observablity.some_setting = some_default_value
DB migration to be executed
(not set)
<< back to Extensions