pflog 1.0.14

A logger client that can speak to a pftel telemetry server

Abstract

This software is a lightweight user of the pftel-client library that allows for logging to a remote logging service. Both stand-alone and modular use cases are supported. At the moment only minimal coverage of server API is provided.

Overview

pflog is a simple app that is both a stand alone client as well as a module for logging to a pftel telemetry server.

Installation

Local python venv

For on the metal installations, pip it:

pip install pflog

docker container

docker pull fnndsc/pflog

Runnning

Script mode

To use pflog in script mode you simply call the script with appropriate arguments (and of course this assumes you have a server isntance at the $PFTEL location)

export PFTEL=http://localhost:22223 # obviously change this as needed

pflog                                           \
        --log              "Hello, world!"      \
        --pftelURL         $PFTEL               \
        --verbosity        1                    \

Module mode

To use pflog in python module mode, you declare an object and instantiate with a dictionary of values. The dictionary keys are identical to the script CLI keys:

from pflog               import pflog

log:pflog.Pflog        = pflog.Pflog( {
        'log'           : 'Hello, world!',
        'pftelURL'      : 'http://localhost:22223',
        'verbosity'     : '1'
    }
)
d_tlog:dict             = log.run()

# You can use this same object to log more messages:
log('This is another message')
log('and so is this!')

This writes messages to default logObject under a logCollection that is the timestamp of the event transmission. Within the logCollection will be logEvents prefixed by an incremental counter, so 000-event, 001-event, etc.

Arguments

--pftelURL <pftelURL>
The URL of the pftel instance. Typically:

        --pftelURL http://some.location.somewhere:22223

and is a REQUIRED parameter.

--log <logMessage>
The actual message to log. Use quotes to protect messages that
contain spaces:

        --log "Hello, world!"

[--logObject <logObjectInPTFEL>] "default"
[--logCollection <logCollectionInPFTEL>] `timestamp`
[--logEvent <logEventInPFTEL>] "event"
[--appName <appName>]
[--execTime <execTime>]
Logs are stored within the pftel database in

    `{logObjectInPFTEL}`/`{logCollectionInPFTEL}`/`{logEventInPFTEL}`

if not specified, use defaults as shown. The <appName> and <execTime>
are stored within the <logEventInPFTEL>.

[--asyncio]
If specified, use asyncio, else do sync calls.

[--detailed]
If specified, return detailed responses from the server.

[--test]
If specified, run a small internal test on multi-logger calls.

[--pftelUser <user>] ("chris")
The name of the pftel user. Reserved for future use.

[--inputdir <inputdir>]
An optional input directory specifier. Reserverd for future use.

[--outputdir <outputdir>]
An optional output directory specifier. Reserved for future use.

[--man]
If specified, show this help page and quit.

[--verbosity <level>]
Set the verbosity level. The app is currently chatty at level 0 and level 1
provides even more information.

[--debug]
If specified, toggle internal debugging. This will break at any breakpoints
specified with 'Env.set_trace()'

[--debugTermsize <253,62>]
Debugging is via telnet session. This specifies the <cols>,<rows> size of
the terminal.

[--debugHost <0.0.0.0>]
Debugging is via telnet session. This specifies the host to which to connect.

[--debugPort <7900>]
Debugging is via telnet session. This specifies the port on which the telnet
session is listening.

Development

Instructions for developers.

To debug, the simplest mechanism is to trigger the internal remote telnet session with the --debug CLI. Then, in the code, simply add Env.set_trace() calls where appropriate. These can remain in the codebase (i.e. you don’t need to delete/comment them out) since they are only live when a --debug flag is passed.

Testing

Run unit tests using pytest. Coming soon!

-30-