Coralogix Python SDK

This package provides logging suites integrated with Coralogix logs analytics platform. To see how to use it, please read Coralogix Python SDK Docs.

Region Selection

The SDK requires a Coralogix region to be specified. You can specify the region in two ways:

1. Environment Variable: Set the CORALOGIX_REGION environment variable to one of the supported regions.

2. Code Parameter: Pass the region parameter when initializing the logger.

Note: The region is mandatory. If no region is provided (neither as a parameter nor via environment variable), the SDK will raise a ValueError.

Supported regions:

• AP1 - Mumbai (AWS: ap-south-1)
• AP2 - Singapore (AWS: ap-southeast-1)
• AP3 - Jakarta (AWS: ap-southeast-3)
• EU1 - Ireland (AWS: eu-west-1)
• EU2 - Stockholm (AWS: eu-north-1)
• US1 - Ohio (AWS: us-east-2)
• US2 - N. Virginia (AWS: us-east-1)

Example usage:

from coralogix.handlers import CoralogixLogger

# Using region parameter
logger = CoralogixLogger(
    private_key="YOUR_PRIVATE_KEY",
    app_name="MyApp",
    subsystem="backend",
    region="EU1"
)

# Or set via environment variable
# export CORALOGIX_REGION=EU1