Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/iobroker-community-adapters/iobroker.logparser

ioBroker Log Parser Adapter
https://github.com/iobroker-community-adapters/iobroker.logparser

iobroker iobroker-adapter log logging logs parser parsing smarthome

Last synced: 2 months ago
JSON representation

ioBroker Log Parser Adapter

Awesome Lists containing this project

README

        

![Logo](admin/logparser.png)

# ioBroker.logparser

[![GitHub license](https://img.shields.io/github/license/iobroker-community-adapters/ioBroker.logparser)](https://github.com/iobroker-community-adapters/ioBroker.logparser/blob/main/LICENSE)
[![Downloads](https://img.shields.io/npm/dm/iobroker.logparser.svg)](https://www.npmjs.com/package/iobroker.logparser)
![GitHub repo size](https://img.shields.io/github/repo-size/iobroker-community-adapters/ioBroker.logparser)
[![Translation status](https://weblate.iobroker.net/widgets/adapters/-/logparser/svg-badge.svg)](https://weblate.iobroker.net/engage/adapters/?utm_source=widget)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/iobroker-community-adapters/ioBroker.logparser)
![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/iobroker-community-adapters/ioBroker.logparser/latest)
![GitHub last commit](https://img.shields.io/github/last-commit/iobroker-community-adapters/ioBroker.logparser)
![GitHub issues](https://img.shields.io/github/issues/iobroker-community-adapters/ioBroker.logparser)

**Version:**
[![NPM version](http://img.shields.io/npm/v/iobroker.logparser.svg)](https://www.npmjs.com/package/iobroker.logparser)
![Current version in stable repository](https://iobroker.live/badges/logparser-stable.svg)
![Number of Installations](https://iobroker.live/badges/logparser-installed.svg)

**Tests:**
[![Test and Release](https://github.com/iobroker-community-adapters/ioBroker.logparser/actions/workflows/test-and-release.yml/badge.svg)](https://github.com/iobroker-community-adapters/ioBroker.logparser/actions/workflows/test-and-release.yml)
[![CodeQL](https://github.com/iobroker-community-adapters/ioBroker.logparser/actions/workflows/codeql.yml/badge.svg)](https://github.com/iobroker-community-adapters/ioBroker.logparser/actions/workflows/codeql.yml)

## Sentry

**This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers.**
For more details and for information how to disable the error reporting see [Sentry-Plugin Documentation](https://github.com/ioBroker/plugin-sentry#plugin-sentry)! Sentry reporting is used starting with js-controller 3.0.

## Documentation

🇬🇧 [Documentation](/docs/en/logparser.md)
🇩🇪 [Dokumentation](/docs/de/logparser.md)

## Discussion and Questions

[ioBroker Forum](https://forum.iobroker.net/topic/63322/test-adapter-log-parser-1-2-x-latest)

## Info

This adapter parses (filters) all logs of ioBroker adapters and provides the results as JSON in states for each filter as configured in the settings.
Resulting JSON can then be used in VIS for visualization. States for emptying (clearing) old logs are provided as well (like `logparser.0.filters.Homematic.emptyJson` or `logparser.0.emptyAllJson` to empty all.)

![States](docs/en/img/states.png)

## Installation

Just install the adapter regularly through the ioBroker admin interface. The adapter is both in the latest and stable repository.

## Instructions

I have included all instructions right in the admin settings of this adapter.

Also, you can read most of these instructions here as well:

- [**Basic Adapter Instructions**](https://github.com/iobroker-community-adapters/ioBroker.logparser/blob/master/admin/doc-md/start_en.md) - for German [click here (Deutsch)](https://github.com/iobroker-community-adapters/ioBroker.logparser/blob/master/admin/doc-md/start_de.md)
- [**Parser Rules (Filters)**](https://github.com/iobroker-community-adapters/ioBroker.logparser/blob/master/admin/doc-md/table-parser-rules_en.md) - for German [click here (Deutsch)](https://github.com/iobroker-community-adapters/ioBroker.logparser/blob/master/admin/doc-md/table-parser-rules_de.md)
- [**Global Blacklist**](https://github.com/iobroker-community-adapters/ioBroker.logparser/blob/master/admin/doc-md/table-global-blacklist_en.md) - for German [click here (Deutsch)](https://github.com/iobroker-community-adapters/ioBroker.logparser/blob/master/admin/doc-md/table-global-blacklist_de.md)

## Visualization Example (animated gif)

![Vis](docs/de/img/visintro.gif)

## Screenshots of adapter options

Please note that these screenshots are a snapshot and do not reflect the latest adapter options.
This is just to provide you an overview of the adapter options.

- Will be add later

## Credits

Providing this adapter would not have been possible without the great work of @Mic-M (https://github.com/Mic-M).

## How to report issues and feature requests

Please use GitHub issues for this.

Best is to set the adapter to Debug log mode (Instances -> Expert mode -> Column Log level). Then please get the logfile from disk (subdirectory "log" in ioBroker installation directory and not from Admin because Admin cuts the lines). If you do not like providing it in GitHub issue you can also send it to me via email ([email protected]). Please add a reference to the relevant GitHub issue AND also describe what I see in the log at which time.

## Changelog

### **WORK IN PROGRESS**
- (simatec) Admin-UI has been adapted for small displays.

### 2.2.2 (2024-01-20)

- (ciddi89) Fixed: missing space in one entry of global blacklist [#145](https://github.com/iobroker-community-adapters/ioBroker.logparser/issues/145)

### 2.2.1 (2023-12-22)

- (ciddi89) Fixed: Visualization tables was not working correctly [#97](https://github.com/iobroker-community-adapters/ioBroker.logparser/issues/97)
- (ciddi89) Updated: Dependencies

### 2.2.0 (2023-05-28)

- (ciddi89) Dropped: Node v14.x support and added: Node v20.x support
- (ciddi89) Added: Option to empty log for each parser rule.

### 2.1.3 (2023-05-19)

- (ciddi89) Updated: Dependencies

### 2.1.2 (2023-04-07)

- (ciddi89) Fixed: Visualization tables was not working correctly
- (ciddi89) Fixed: Issue if no dateformat was selected correctly

### 2.1.1 (2023-04-05)

- (ciddi89) Fixed: [#25](https://github.com/iobroker-community-adapters/ioBroker.logparser/issues/25) Missing CSS class in date if it's older than today
- (ciddi89) Changed: Moved Dateformat option from table to other settings
- (ciddi89) Updated: Dependencies

### 2.1.0 (2023-03-05)

- (ciddi89) Added: [#24](https://github.com/iobroker-community-adapters/ioBroker.logparser/issues/24) Option to remove 'COMPACT' in log entries
- (ciddi89) Added: [#21](https://github.com/iobroker-community-adapters/ioBroker.logparser/issues/21) Option to remove only 'script.js' in log entries
- (ciddi89) Fixed: [#46](https://github.com/iobroker-community-adapters/ioBroker.logparser/issues/46) Midnight function to change today/yesterday
- (ciddi89) Fixed: [#23](https://github.com/iobroker-community-adapters/ioBroker.logparser/issues/23) When nothing selected in blacklist, adapter didn't work anymore
- (ciddi89) Other: Small code and translation improvements

### 2.0.0 (2023-03-02)

- (ciddi89) Dropped: Admin 5 support
- (ciddi89) Changed: Admin html to jsonConfig [#36](https://github.com/iobroker-community-adapters/ioBroker.logparser/issues/36)
- (ciddi89) Fixed: Issue with Midnight function
- (ciddi89) Added: Translations of admin ui [#28](https://github.com/iobroker-community-adapters/ioBroker.logparser/issues/28)
- (ciddi89) Updated: Readme

### 1.2.3 (2023-02-25)

- (ciddi89) Fixed: Alexa-History script
- (ciddi89) Fixed: adjusted links in admin/docs to new repo
- (ciddi89) Rebuilded main.js

### 1.2.2 (2023-02-23)

- (McM1957) sentry integration has been fixed

### 1.2.1 (2023-02-23)

- (McM1957) Adapter has been moved to iobroker-community-adapters

### 1.1.0

- (Mic-M) Fixed issue [#15](https://github.com/Mic-M/ioBroker.logparser/issues/15) regarding regex for tab "Parser Rules", column "Blacklist"
- (Mic-M) Enhancement [#16](https://github.com/Mic-M/ioBroker.logparser/issues/16) - add specific CSS classes to any element of the JSON log per adapter option.
- (Mic-M) Major improvement: Implemented entire documentation into adapter itself to significantly improve usability.
- (Mic-M) A few improvements under the hood.

### 1.0.4

- (Mic-M) Fixed 'Today/Yesterday' updating issue - https://forum.iobroker.net/post/469757. Thanks to (Kuddel) for reporting and (Glasfaser) for further debugging.

### 1.0.3

- (Mic-M) Added [Sentry](https://github.com/ioBroker/plugin-sentry)

### 1.0.2

- (Mic-M) Added debug logging for callAtMidnight() and updateTodayYesterday()

### 1.0.1

- (Mic-M) Updated lodash dependency from 4.17.15 to 4.17.19

### 1.0.0

- (Mic-M) No changes - just prepare versioning to add adapter to stable repository per [Adapter dev docu](https://github.com/ioBroker/ioBroker.docs/blob/master/docs/en/dev/adapterdev.md#versioning)

## License

MIT License

Copyright (c) 2020 - 2024 Mic-M, McM1957 , ciddi89 , ioBroker Community Developers

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.