asyncgelf 1.0.0

Async python logging handlers that send messages in the Graylog Extended Log Format (GELF).

AsyncGELF

Async python logging handlers that send messages in the Graylog Extended Log Format (GELF).

• AsyncGELF
  • List of ready to run GELF handlers
  • Get AsyncGELF
  • Usage
    • GELF TCP
    • GELF HTTP
    • GELF UDP
    • Additional field
    • Available params

List of ready to run GELF handlers

• TCP (with and without TLS);
• HTTP (with and without TLS);
• UDP;

Get AsyncGELF

pip install asyncgelf

Usage

GELF TCP

import asyncio
import asyncgelf

async def main(message):
    handler = asyncgelf.GelfTcp(
        host='127.0.0.1',
    )

    await handler.tcp_handler(message)

asyncio.run(main(message))

GELF HTTP

import asyncio
import asyncgelf

async def main(message):
    handler = asyncgelf.GelfHttp(
        host='127.0.0.1',
    )

    await handler.http_handler(message)

asyncio.run(main(message))

GELF UDP

import asyncio
import asyncgelf

async def main(message):
    handler = asyncgelf.GelfUdp(
        host='127.0.0.1',
    )

    await handler.udp_handler(message)

asyncio.run(main(message))

Additional field

Expect dict with next moments:

• All keys must start with underscore (_) prefix;
• _id can't be additional field;
• Allowed characters in field names are any word character (letter, number, underscore), dashes and dots

import asyncio
import asyncgelf

async def main(message):
    additional_field = {
      '_key_1': 'value_1',
      '_key_2': 'value_2',
    }
    
    handler = asyncgelf.GelfTcp(
        host='127.0.0.1',
        additional_field=additional_field
    )

    await handler.tcp_handler(message)

asyncio.run(main(message))

Available params

• host Requaried | Graylog server address;
• port Optional | Graylog input port (default: 12201);
• gelf_version Optional | GELF spec version (default: 1.1)
• level Optional | The level equal to the standard syslog levels (default: 1);
• scheme Optional | HTTP Scheme for GELF HTTP input only (default: http);
• tls Optional | Path to custom (self-signed) certificate in pem format (default: None)
• compress Optional | Compress message before sending it to the server or not (default: False)
• debug Optional | Additional information in error log (default: False)
• additional_field Optional | Dictionary with additional fields which will be added to every gelf message (default: None)