Skip to main content

A log handler for VictoriaLogs.

Project description

python-victorialogs-handler

A high-performance Python log handler for VictoriaLogs.

release python CI/CD codecov license

Description

victorialogs-handler is a high-performance Python log handler tailored for VictoriaLogs. It integrates seamlessly with Python’s native logging module, allowing you to stream log events to a VictoriaLogs instance with minimal configuration.

  • Non-blocking: Logs are stored in a buffer and later processed in a background thread.
  • Hybrid trigger: Log processing is triggered by a ticker and/or when a size threshold is reached.
  • Batching: Multiple logs are combined into one request to the log server to minimize the amount of requests.
  • Complete logs: All fields of a log record are transmitted including exceptions and extra fields.
  • Highly customizable: The handler's behavior is highly customizable (see also Documentation)

Installation

The handler can be installed with PIP from PyPI:

pip install victorialogs-handler

Quick start

[!NOTE] The script assumes that there is a VictoriaLogs server running on the same system at the default URL: http://localhost:9428

Here is a quick example on how to use the handler in your Python script:

import logging

from vlogs_handler import VictoriaLogsHandler

# Create a custom logger with INFO level
logger = logging.getLogger(__name__)
logger.setLevel(logging.INFO)

# Add a handler for VictoriaLogs
vlogs_handler = VictoriaLogsHandler()
vlogs_handler.setLevel(logging.DEBUG)
logger.addHandler(vlogs_handler)

# Log example
logger.info("This is an info message")

Please see the directory /examples for additional examples on how to use the handler.

Documentation

The full documentation can be found here: Documentation.

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

victorialogs_handler-0.1.0a2.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

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

victorialogs_handler-0.1.0a2-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file victorialogs_handler-0.1.0a2.tar.gz.

File metadata

  • Download URL: victorialogs_handler-0.1.0a2.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.33.1

File hashes

Hashes for victorialogs_handler-0.1.0a2.tar.gz
Algorithm Hash digest
SHA256 23190bb23788fcf10ebb3c0658d9c1ebd85cd0b767abddb1242e0bd81dc35664
MD5 bc4184f0f0e2dd1aa8a16dc9618ae75f
BLAKE2b-256 f38086357248561b0da905b38010d121552994c93153e12afddd157b1eabca57

See more details on using hashes here.

File details

Details for the file victorialogs_handler-0.1.0a2-py3-none-any.whl.

File metadata

File hashes

Hashes for victorialogs_handler-0.1.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 2f2db287e9c4d1f8835dddfdbda8d3f086049431a8afab9aa588bc9c2cfbb9b0
MD5 450bc1bd25dac94abd52da158c98b45e
BLAKE2b-256 e1bb45969fbae81f3885e4728bdd0f7416e343c218381c3f1fe1723bf7f73a09

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