Skip to content

SkyLog SDK

Release Build status Commit activity License

Python SDK for Skylog Integration

Skylog is a robust service designed for seamless integration with various platforms like Sentry, Telegram, and more, enabling the efficient transmission of logs and rapid identification of issues.

This Python SDK facilitates easy interaction with Skylog services, allowing users to:

  • fire alert
  • stop alert
  • notify

How to install

install from gitlab

pip install skylog-sdk

Setup and Configuration

  • Environment Variables: Configure the following variables in your project environment:

  • DEFAULT_SKY_LOG_ALERTING_TELEGRAM_ALERT_NAME: Default alert name for Telegram

  • DEFAULT_SKY_LOG_ALERTING_PHONE_CALL_ALERT_NAME: Default alert name for phone calls
  • DEFAULT_SKY_LOG_ALERTING_SMS_ALERT_NAME: Default alert name for SMS
  • SKY_LOG_BASE_URL: Base URL for Skylog API calls
  • SKY_LOG_ALERTING_TOKEN: Your Skylog authentication token

Proxy Configuration

If you want to use proxy, include the following additional variables:

- `PROXY_USERNAME`
- `PROXY_PASSWORD`
- `PROXY_IP`
- `PROXY_PORT`

Usage Example

1
2
3
4
5
6
7
8
  from skylog import AlertingSkyLogClient, AlertingProvider

  AlertingProvider(telegram='telegram_rule')
  # Initialize the Skylog client with the desired provider (e.g., Telegram)
  client = AlertingSkyLogClient(default_provider=AlertingProvider.telegram)
  client.fire_alert(description='Issue detected', instance_name='unique_key', provider=AlertingProvider.sms)
  client.stop_alert(description='Issue resolved', instance_name='unique_key', provider=AlertingProvider.sms)
  client.notify(description='Alert notification', instance_name='unique_key', provider=AlertingProvider.telegram)


 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
from skylog import AlertingSkyLogClient, AlertingProvider
from skylog.integration.config import ClientSettings, LazySettings

class CustomSettings(ClientSettings):
    ... # some settings

settings = LazySettings(client_settings_class=CustomSettings)

AlertingProvider(telegram='telegram_rule')
# Initialize the Skylog client with the desired provider (e.g., Telegram)
client = AlertingSkyLogClient(
  default_provider=AlertingProvider.telegram,
  use_proxy=True,
  settings=settings,
  enable=False, # not send data just log data
  duplicate_request_message='duplicate' # this is the skylog message when get duplicate instance-name
)
client.fire_alert(
  description='Issue detected',
  instance_name='unique_key',
  provider=AlertingProvider.sms,
  notify_on_duplicate=True # if got duplicate message from skylog send notify msg
)
client.stop_alert(description='Issue resolved', instance_name='unique_key', provider=AlertingProvider.sms)
client.notify(description='Alert notification', instance_name='unique_key', provider=AlertingProvider.telegram)

Concepts to Understand

Alertname and Instance

  • Alertname: Represents the provider or service. It identifies where Skylog sends alerts.
  • Instance: A unique identifier within a group alert, specifying a particular part of a universal alert.

Alerts Management

  • Firing an Alert: Triggering an alert, resulting in immediate notifications sent to relevant endpoints.
  • Stopping an Alert: Removing a fired alert, resolving it and stopping further notifications.
  • Notifying an Alert: Sending messages to endpoints without adding records to the triggered list.