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.0.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.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for victorialogs_handler-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a36437bbee6bf69a7d0e9a6abb9b8345dd6e1ee8af1c7b27e91611e9094d7132
MD5 db8f27dd6a662847ea301846cfe4beb2
BLAKE2b-256 49b80cfd035e219ce9e72a9cacda780342d50813a977365866563c536a876213

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for victorialogs_handler-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aba369a74fddde8bdf3d8987c963e08314ea76f3005217146b53503b8ef02627
MD5 7c634014242e4aa741657c67809fc62f
BLAKE2b-256 20636f7567f0158f06f10ad66cce16661a434b9404aab860786b403a3205d1dd

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