Add Server Service

This section adds the basic files require for the plugin to run on the servers service. Create the following files and directories.


Setting up skeleton files for the client, worker and agent services, is identical to the server, generally replace “Server” with the appropriate service name.

The platform loads the plugins python package, and then calls the appropriate peek{Server}EntryHook() method on it, if it exists.

The object returned must implement the right interfaces, the platform then calls methods on this object to load, start, stop, unload, etc the plugin.

Server File Structure

Add Package _private/server

This step creates the _private/server python package.

This package will contain the majority of the plugins code that will run on the Server service. Files in this package can be imported with

# Example
# To import peek_plugin_tutorial/_private/server/
from peek_plugin_tutorial._private.server import File

Create directory peek_plugin_tutorial/_private/server

Create an empty package file in the server directory, peek_plugin_tutorial/_private/server/


mkdir peek_plugin_tutorial/_private/server
touch peek_plugin_tutorial/_private/server/

Add File

This file/class is the entry point for the plugin on the Server service. When the server service starts this plugin, it will call the load() then the start() methods.

Any initialisation and loading that the plugin needs to do to run should be placed in load() and start() methods.


Ensure what ever is constructed and initialised in the load() and start() methods, should be deconstructed in the stop() and unload() methods.

Create the file peek_plugin_tutorial/_private/server/ and populate it with the following contents.

import logging

from peek_plugin_base.server.PluginServerEntryHookABC import PluginServerEntryHookABC

logger = logging.getLogger(__name__)

class ServerEntryHook(PluginServerEntryHookABC):
    def __init__(self, *args, **kwargs):
        """" Constructor """
        # Call the base classes constructor
        PluginServerEntryHookABC.__init__(self, *args, **kwargs)

        #: Loaded Objects, This is a list of all objects created when we start
        self._loadedObjects = []

    def load(self) -> None:
        """ Load

        This will be called when the plugin is loaded, just after the db is migrated.
        Place any custom initialiastion steps here.


    def start(self):
        """ Start

        This will be called to start the plugin.
        Start, means what ever we choose to do here. This includes:

        -   Create Controllers

        -   Create payload, observable and tuple action handlers.


    def stop(self):
        """ Stop

        This method is called by the platform to tell the peek app to shutdown and stop
        everything it's doing
        # Shutdown and dereference all objects we constructed when we started
        while self._loadedObjects:


    def unload(self):

        This method is called after stop is called, to unload any last resources
        before the PLUGIN is unlinked from the platform


Edit peek_plugin_tutorial/

When the Server service loads the plugin, it first calls the peekServerEntryHook() method from the peek_plugin_tutorial package.

The peekServerEntryHook() method returns the Class that the server should create to initialise and start the plugin.

As far as the Peek Platform is concerned, the plugin can be structured how ever it likes internally, as long as it defines these methods in its root python package.

Edit the file peek_plugin_tutorial/, and add the following:

from peek_plugin_base.server.PluginServerEntryHookABC import PluginServerEntryHookABC
from typing import Type

def peekServerEntryHook() -> Type[PluginServerEntryHookABC]:
    from ._private.server.ServerEntryHook import ServerEntryHook
    return ServerEntryHook

Edit plugin_package.json

These updates to the plugin_package.json tell the Peek Platform that we require the “server” service to run, and additional configuration options we have for that service.

Edit the file peek_plugin_tutorial/plugin_package.json :

  1. Add “server” to the requiresServices section so it looks like

    "requiresServices": [
  2. Add the server section after requiresServices section:

    "server": {
  3. Ensure your JSON is still valid (Your IDE may help here)

Here is an example

    "plugin": {
    "requiresServices": [
    "server": {


The plugin should now be ready for the server to load.

Running on the Server Service

File ~/peek-server.home/config.json is the configuration file for the Server service.


This file is created in Administration. Running the Server Service will also create the file.

Edit ~/peek-server.home/config.json:

  1. Ensure logging.level is set to “DEBUG”
  2. Add “peek_plugin_tutorial” to the plugin.enabled array


It would be helpful if this is the only plugin enabled at this point.

It should something like this:

    "logging": {
        "level": "DEBUG"
    "plugin": {
        "enabled": [

You can now run the peek server, you should see your plugin load.

peek@peek:~$ run_peek_server
DEBUG peek_plugin_tutorial._private.server.ServerEntryHook:Loaded
DEBUG peek_plugin_tutorial._private.server.ServerEntryHook:Started