https://github.com/stil/zlog-sql

MySQL/SQLite logging plugin for ZNC IRC bouncer written in Python 3
https://github.com/stil/zlog-sql

irc logging mysql sqlite znc znc-irc-bouncer

Last synced: about 1 month ago
JSON representation

MySQL/SQLite logging plugin for ZNC IRC bouncer written in Python 3

• Host: GitHub
• URL: https://github.com/stil/zlog-sql
• Owner: stil
• License: mit
• Created: 2017-09-11T16:13:43.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-04-21T12:49:55.000Z (over 2 years ago)
• Last Synced: 2024-10-05T06:39:58.760Z (about 1 month ago)
• Topics: irc, logging, mysql, sqlite, znc, znc-irc-bouncer
• Language: Python
• Size: 23.4 KB
• Stars: 9
• Watchers: 3
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# zlog-sql

MySQL/SQLite logging plugin for ZNC IRC bouncer written in Python 3

## Features

* Supports MySQL, PostgreSQL and SQLite databases.

* Asynchronous database writes on separate thread. Guarantees that ZNC won't hang during SQL connection timeout.

* Automatic table creation (`CREATE TABLE IF NOT EXIST`)

* Retry after failed inserts. When database server is offline, logs are buffered to memory. They are saved when database is back online, so you won't lose logs during MySQL/PostgreSQL outages. 

## Some statistics

After having this plugin enabled for around 11 months, below are my statistics of MySQL table:

* Total logs count: more than 4.87 million.

* Space usage: 386 MB (data 270 MB, index 116 MB)

MySQL gives great compression ratio and is easily searchable. SQLite database doesn't support compression, but it's easier to setup and migrate.

## Quick start

1. Copy `zlog_sql.py` to `~/.znc/modules/zlog_sql.py`.

2. In Webadmin, open the list of Global Modules.

3. Make sure `modpython` is enabled.

4. Enable module `zlog_sql` and set its argument.

![Screenshot](docs/webadmin_modules.png)

### MySQL

For MySQL, set module argument matching following format:

```

mysql://username:password@localhost/database_name

```

**Important:** you need [`PyMySQL`](https://github.com/PyMySQL/PyMySQL) pip package for MySQL logging. Install it with `pip3 install PyMySQL` command.

### PostgreSQL

For PostgreSQL, set module argument matching following format:

```

postgres://username:password@localhost/database_name

```

**Important:** you need [`psycopg2`](https://github.com/psycopg/psycopg2) pip package for PostgreSQL logging. Install it with `pip3 install psycopg2` command.

### SQLite

For SQLite use following string format:

```

sqlite:///home/user/logs.sqlite

```

or simply leave out the path

```

sqlite

```

in this case, logs are going to be written to the default path `~/.znc/moddata/zlog_sql/logs.sqlite`.

5. Save changes. SQL table schema is going to be created automatically.