Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/OpenVoiceOS/ovos-utils

hacktoberfest openvoiceos

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/OpenVoiceOS/ovos-utils
Owner: OpenVoiceOS
License: apache-2.0
Created: 2021-10-24T11:11:55.000Z (about 3 years ago)
Default Branch: dev
Last Pushed: 2024-07-18T20:02:44.000Z (4 months ago)
Last Synced: 2024-07-29T09:28:24.760Z (4 months ago)
Topics: hacktoberfest, openvoiceos
Language: Python
Homepage:
Size: 1.02 MB
Stars: 3
Watchers: 5
Forks: 9
Open Issues: 26
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-mycroft-community - Project Link

README

        # OVOS-utils

collection of simple utilities for use across the mycroft ecosystem

## Install

```bash

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_}

    

   

  _[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_.log`)._}

  

--------------

- **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._}

  

  

  _[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._}

  

---------------------

- **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_}