Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Issue #67 #81

Open
wants to merge 20 commits into
base: develop
Choose a base branch
from
Open

Fix Issue #67 #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
bd9228f
Merge pull request #53 from BOSWatch/develop
Jul 17, 2020
4b911ab
Merge pull request #70 from BOSWatch/develop
Jan 15, 2021
436e5e4
Merge pull request #72 from BOSWatch/develop
Feb 4, 2021
890b263
Fix timer error
Feb 3, 2021
0363979
Update timer.py
Feb 3, 2021
5ac2ad2
implement basic mysql functionality
janspeller Feb 16, 2021
3b4a594
update mysql plugin: add init_db.sql and create table automatically
janspeller Feb 28, 2021
75f9a25
Update Dockerfile
Feb 16, 2021
13592f5
Update Dockerfile
Feb 16, 2021
7e45fca
add documentation
janspeller Mar 1, 2021
45dcd53
Change spacing in init_db.sql and add comment on table creation
janspeller Mar 4, 2021
53a8623
add log option for server
janspeller Mar 13, 2021
fb703fb
fix issue if additionalWildcard is not set (eg. descriptor)
janspeller Mar 13, 2021
d0f0792
Disable most logging by default
janspeller May 4, 2022
7cca892
Merge branch 'develop' into feature/ISSUE-67
janspeller May 4, 2022
a16f67f
Merge remote-tracking branch 'origin/develop' into feature/ISSUE-67
janspeller May 23, 2022
efeb271
Documentation, fix config flag for logging
janspeller May 23, 2022
b1f87e8
Merge branch 'BOSWatch:develop' into feature/ISSUE-67
janspeller May 24, 2022
07953e0
Typo
janspeller Jan 24, 2023
1d6f290
Merge branch 'develop' into feature/ISSUE-67
janspeller Jan 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion boswatch/router/routerManager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ class RouterManager:

def __init__(self):
"""!Create new router"""
self.config = None
self._routerDict = {}
self._startTime = int(time.time())

Expand All @@ -40,6 +41,7 @@ def buildRouters(self, config):

@param config: instance of ConfigYaml class
@return True or False"""
self.config = config
self._routerDict = {} # all routers and instances of modules/plugins would be destroyed
routerDict_tmp = {}
logging.debug("build routers")
Expand Down Expand Up @@ -116,7 +118,8 @@ def runRouters(self, routerRunList, bwPacket):
else:
logging.warning("unknown router: %s", routerName)

self._saveStats() # write stats to stats file
if self.config.get("server", "logging", default=False):
self._saveStats() # write stats to stats file

def cleanup(self):
"""!Run cleanup routines for all loaded route points"""
Expand Down
2 changes: 1 addition & 1 deletion config/logger_client.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class=handlers.TimedRotatingFileHandler
interval=midnight
backupCount=7
formatter=complex
level=DEBUG
level=ERROR
args=('log/client.log',)

[handler_screen]
Expand Down
2 changes: 1 addition & 1 deletion config/logger_server.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class=handlers.TimedRotatingFileHandler
interval=midnight
backupCount=7
formatter=complex
level=DEBUG
level=ERROR
args=('log/server.log',)

[handler_screen]
Expand Down
1 change: 1 addition & 0 deletions config/server.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ server:
port: 8080
name: BW3 Server # name of the BW3 Server instance
useBroadcast: no # serve server ip on broadcast request
logging: False # enable log file

alarmRouter:
- Router 1
Expand Down
20 changes: 17 additions & 3 deletions docu/docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,15 +157,16 @@ decoder:
```

---
## Server
Nachfolgend alle Paramater der Server Konfiguration
<h2 id="server-configuration">Server</h2>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wieso als H2? Geht das nicht auch mit file.md#headline?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Schrolli91 #server linked auf die erste gefundene Instanz von server in einer Headline, das wäre in diesem Fall falsch. Alternativ koennte ich die Headline auf Server-Konfiguration o.ä. ändern, dann koennten wir unten eindeutig darauf verweisen :)

Copy link
Member

@Schrolli91 Schrolli91 May 26, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@janspeller
Finde halt das HTML etwas störend im sonst recht sauberen Markdown.
Aber wenn das nicht anders geht, ohne jetzt alles irgendwie umzubenennen, dann lassen wir das halt so.
Außer du hast noch eine Idee - bin mir nicht sicher ob mkDocs da nicht auch eine Möglichkeit bietet, benutzerdefinierte Anker zu erzeugen.

Copy link
Member Author

@janspeller janspeller Jan 24, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Schrolli91 Ich wüsste leider so keine bessere Lösung, ausser die Section umzubenennen. Wird auch häufig so (oder mit <a id="section"></a> hinter der heading) verwendet. Was meinst du?

Nachfolgend alle Parameter der Server Konfiguration

### `server:`
|Feld|Beschreibung|Default|
|----|------------|-------|
|port|Port auf dem der Server lauscht|8080
|port|Port auf dem der Server lauscht| 8080
|name|Name zur Identifizierung der Server Instanz||
|useBroadcast|Verbindungsdaten per Broadcast Server bereitstellen|no|
|logging|Aktivieren / Deaktivieren des Schreibens von Statistik-Dateien|False|

---
### `alarmRouter:`
Expand Down Expand Up @@ -215,3 +216,16 @@ router:
## Module/Plugins

Die möglichen Einstellungen der einzelnen Module und Plugins sind im jeweiligen Kapitel aufgelistet.

---
## Logging

Um den Datenträger, auf dem Boswatch läuft, zu schützen ist das Logging in
Dateien standartmäßig auf Fehlermeldungen begrenzt.
In den Dateien `logger_client.ini` bzw `logger_server.ini` kann dies
entsprechend im Bereich `handler_file` unter `level=` angepasst werden.

Das Schreiben einer Statistik-Datei, welche die Durchläufe aller Module
und Plugins dokumentiert, kann in der Server-Konfiguration über den Parameter
`logging` aktiviert werden.
(siehe [Server-Konfiguration](#server-configuration))