Grafonix

Grafonix is a Grafana integration service for the SONIX project.

This Flask application fetches and modifies JSON data from an external API, providing a simple interface for integration with Grafana.

Prerequisites

• Python 3.9 or higher with virtualenv support
• poetry for running tests locally
• mypy for type checking

Installation

1. Clone the repository:

   git clone https://github.com/sonix-network/grafonix.git
   cd grafonix

2. Install the package in a venv and execute:

   ./run.sh

Deploying

Using SONIX internal ansible, you can deploy changes like this:

./ansible/bin/ansible-playbook site.yml -l prometheus.local.sonix.network -t grafana

Running the Application

You can run the Grafonix application using the installed command-line binary:

grafonix

This will start the Flask application, listening on all IPv6 addresses (::) at port 3001.

Type Checking

The codebase uses Python type hints to ensure type safety. To verify type correctness:

poetry run mypy --install-types grafonix.py tests/

This will check all Python files for type correctness. Make sure to run type checking before submitting any pull requests.

Running Tests

1. Run the tests:

   poetry run pytest tests/

This will execute the tests located in the tests directory and provide you with a summary of the results.

Project Structure

grafonix/
├── grafonix.py            # Main application file
├── pyproject.toml         # Project configuration and dependencies
├── tests/                 # Directory containing unit tests
│   └── test_grafonix.py   # Unit tests for the application

Contributing

Contributions are welcome! If you have suggestions for improvements or new features, feel free to open an issue or submit a pull request.