Skip to content

OpenVoiceOS/ovos-utils

Repository files navigation

OVOS-utils

collection of simple utilities for use across the mycroft ecosystem

Install

pip install ovos_utils

Commandline scripts

ovos-logs

Small helper tool to quickly navigate the logs, create slices and quickview errors


  • ovos-logs slice [options]

    Slice logs of a given time period. Defaults on the last service start (-s) until now (-u)

    Different logs can be picked using the -l option. All logs will be included if not specified.
    Optionally the directory where the logs are stored (-p) and the file where the slices should be dumped (-f) can be specified.

    [ex: ovos-logs slice]
    Slice all logs from service start up until now.

    [ex: ovos-logs slice -s 17:05:20 -u 17:05:25]
    Slice all logs from 17:05:20 until 17:05:25.
    **no logs in that timeframe in other present logs Screenshot 2023-12-25 185004

    [ex: ovos-logs slice -s 17:05:20 -u 17:05:25 -l skills]
    Slice skills.log from 17:05:20 until 17:05:25.

    [ex: ovos-logs slice -s 17:05:20 -u 17:05:25 -f ~/testslice.log]
    Slice the logs from 17:05:20 until 17:05:25 on all log files and dump the slices in the file ~/testslice.log (default: ~/slice_<timestamp>.log). Screenshot 2023-12-25 190732


  • ovos-logs list [-e|-w|-d|-x] [options]

    List logs by severity (error/warning/debug/exception). A log level has to be specified - more than one can be listed

    A start and end date can be specified using the -s and -u options. Defaults to the last service start until now.
    Different logs can be picked using the -l option. All logs will be included if not specified.
    Optionally, the directory where the logs are stored (-p) and the file where the slices should be dumped (-f) can be passed as arguments.

    [ex: ovos-logs list -x]
    List the logs with level EXCEPTION (plus tracebacks) from the last service start until now. Screenshot 2023-12-25 184321

    [ex: ovos-logs list -w -e -s 20-12-2023 -l bus -l skills]
    List the logs with level WARNING and ERROR from the 20th of December 2023 until now from the logs bus.log and skills.log. Screenshot 2023-12-25 173739


  • ovos-logs reduce [options]

    Downsize logs to a given size (in bytes) or remove entries before a given date.

    Different logs can be included using the -l option. If not specified, all logs will be included.
    Optionally the directory where the logs are stored (-p) can be specified.

    [ex: ovos-logs reduce]
    Downsize all logs to 0 bytes

    [ex: ovos-logs reduce -s 1000000]
    Downsize all logs to ~1MB (latest logs)

    [ex: ovos-logs reduce -d "1-12-2023 17:00"]
    Downsize all logs to entries after the specified date/time

    [ex: ovos-logs reduce -s 1000000 -l skills -l bus]
    Downsize skills.log and bus.log to ~1MB (latest logs)


  • ovos-logs show -l [servicelog]

    Show logs

    [ex: ovos-logs show -l bus]
    Show the logs from bus.log.

    [ex: wrong servicelog]
    **logs shown depending on the logs present in the folder