Skip to main content

A logging library with asynchronous logs dispatch to Loki.

Project description

nextlog

This is a python logging library which asynchronously dispatches logs to monitoring services like loki. It uses the OOTB python logging library as its base.
Whenever the logger statement - logger.info() / logger.debug() / logger.error() etc. gets executed, the log is pushed onto a redis queue.
A process running on separate thread will keep dispatching those logs to the specified loki endpoint.

Features

  • Seamless Integration: nextlog builds upon the Python logging library, so its usage is similar and familiar.
  • Async Dispatch: Logs are asynchronously dispatched to monitoring services like Loki, ensuring minimal impact on the main code flow.
  • Redis Backup: Utilizes Redis to temporarily store logs in case the monitoring service (e.g., Loki) is unavailable.

Setup

Install the library

pip3 install nextlog

Setup redis server

docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest


Setup test enviroment from local source

Download the library from Git Repo

  1. Download the zip file from Git Repo
  2. Unzip
  3. Go to root folder for nextlog

Setup Virtual Enviroment and install nextlog locally

  1. python -m venv venv
  2. source venv/bin/activate # On Windows use venv\Scripts\activate
  3. pip install -e . This installs nextlog via the nextlog folder rather than though pip
  4. Local Nextlog should be importable via from nextlog import Logger

Examples

Check out the Examples folder for two examples.

The basic example is a simple way to use Nextlog to send logs, but does not use optional features like exit methods and shared flags that would exist in an application

The application example is a quick start example to use Nextlog in a more robust application. This allows Nextlog to exit the main application if there are errors in logging setup (like connecting to redis or grafana) and more robust commenting for options.

Basic Usage

from nextlog import Logger
import logging

loki_url = "http://localhost:3100/api/prom/push"
redis_host='localhost' # Default is localhost
redis_port=6379  # Default port is 6379

labels = {
    'source' : 'localhost-x2'
}

logger = Logger(__name__,loki_url=loki_url,labels=labels)

logger.setLevel(logging.INFO)
file_handler = logging.FileHandler('console2.log')
console_handler = logging.StreamHandler()
logger.addHandler(file_handler)
logger.addHandler(console_handler)

logger.error("Error log 1")
logger.error("Error log 2")
logger.critical("Critical log 1")
logger.critical("Critical log 2")
logger.error("Error log 3")
logger.stop() #Stop the logger and finish sending logs


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nextlog-2.0.1.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nextlog-2.0.1-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file nextlog-2.0.1.tar.gz.

File metadata

  • Download URL: nextlog-2.0.1.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for nextlog-2.0.1.tar.gz
Algorithm Hash digest
SHA256 fb28ed755cc12a3d963ea3e56d163403721503071f22d2aa499c0f83d7033a0f
MD5 a26a87b218fa82a9a7965f0592869efa
BLAKE2b-256 33682e660b2e47cd2038c42e2989d20da8cd158a870122b67c6a08e2358bb761

See more details on using hashes here.

File details

Details for the file nextlog-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: nextlog-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for nextlog-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 89b3805feeef1dbc43690aad3f32dc63a6b5e6d761c2b65593e565b7b7faccb4
MD5 0be0f25b89aa7a31ff8e692e684245c0
BLAKE2b-256 7bc835bc024ce6af64388d5e36aeda480e878fc26ae93d10d818f7f56b8eec1a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page