# gordon-introspection

**Repository Path**: mirrors_spotify/gordon-introspection

## Basic Information

- **Project Name**: gordon-introspection
- **Description**: Introspection Server Plugin for Gordon: Event-Driven Cloud DNS registration
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2025-09-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

**Gordon is no longer developed publicly.  This code will remain available, but will not change.**

----

=========================================================
``gordon-introspection``: Introspection Server Plugin for Gordon
=========================================================

.. desc-begin

REST API plugin for service introspection into `Gordon`_. This plugin will expose endpoints for healthchecks (liveness and readiness), dynamic log level changes, and current event messages in flight, and allow for more features if needed (i.e. pull-based metrics).

.. desc-end

**NOTICE**: This is still in the planning phase and under active development. Gordon and this plugin should not be used in production, yet.

.. intro-begin

Requirements
============

For the initial release, the following will be supported:

* Python 3.6
* Google Cloud Platform

Support for other Python versions and cloud providers may be added.

Development
===========

For development and running tests, your system must have all supported versions of Python installed. We suggest using `pyenv`_.

Setup
-----

.. code-block:: bash

    $ git clone git@github.com:spotify/gordon-introspection.git && cd gordon-introspection
    # make a virtualenv
    (env) $ pip install -r dev-requirements.txt

Running tests
-------------

To run the entire test suite:

.. code-block:: bash

    # outside of the virtualenv
    # if tox is not yet installed
    $ pip install tox
    $ tox

If you want to run the test suite for a specific version of Python:

.. code-block:: bash

    # outside of the virtualenv
    $ tox -e py36

To run an individual test, call ``pytest`` directly:

.. code-block:: bash

    # inside virtualenv
    (env) $ pytest tests/test_foo.py


Build docs
----------

To generate documentation:


.. code-block:: bash

    (env) $ pip install -r docs-requirements.txt
    (env) $ cd docs && make html  # builds HTML files into _build/html/
    (env) $ cd _build/html
    (env) $ python -m http.server $PORT


Then navigate to ``localhost:$PORT``!

To watch for changes and automatically reload in the browser:

.. code-block:: bash

    (env) $ cd docs
    (env) $ make livehtml  # default port 8888
    # to change port
    (env) $ make livehtml PORT=8080


Code of Conduct
===============

This project adheres to the `Open Code of Conduct`_. By participating, you are expected to honor this code.

.. _`pyenv`: https://github.com/yyuu/pyenv
.. _`Open Code of Conduct`: https://github.com/spotify/code-of-conduct/blob/master/code-of-conduct.md
.. _`Gordon`: https://github.com/spotify/gordon