Storage

Storage implementations are in charge of persisting transactions and messages into a backend (database, memory, …) using eventual dependencies.

Each storages should implement the Storage protocol.

Model

• a Transaction represents a transaction that went through the proxy. A set of request-response forms a transaction in the case of an HTTP transaction (although the response may not be present in case of an in progress transaction or a timed out transaction).

• a Message represents an atomic message that went through the proxy. An http request or response is a message.

• a Blob represents a binary content, for example the headers or the body of an http request or response.

Protocol

class IStorage

__init__(*args, **kwargs)

async create_users_once_ready(users)

Create users.

Parameters:

users (Iterable[str])

async finalize()

Coroutine function to finalize the instance. Should release resources, close files etc… The caller should make sure to call finalize on all cases where the instance is not needed anymore to get a clean shutdown.

async get_facet_meta(name)

Retrieve a facet’s metadata, by name.

async get_transaction(id, *, username)

Find a transaction, by id.

Parameters:

• id (str)

• username (str)

async get_transaction_list(*, username, with_messages=False, filters=None, page=1, cursor='', text_search='')

Find transactions, using optional filters, for example to be displayed in the dashboard.

Parameters:

• username (str)

• page (int)

• cursor (str)

• text_search (str)

async get_usage()

Get storage usage.

async initialize()

Coroutine function to initialize the instance.

async set_user_flag(*, transaction_id, username, flag, value=True)

Sets or unsets a user flag on a transaction.

Parameters:

• transaction_id (str)

• username (str)

• flag (int)