logdash 0.1.0__tar.gz

logdash-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 LogDash
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

logdash-0.1.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include LICENSE
+include README.md
+recursive-include logdash *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co] 

logdash-0.1.0/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: logdash
+Version: 0.1.0
+Summary: Python SDK for LogDash logging and metrics service
+Home-page: https://logdash.io
+Author: LogDash
+Author-email: info@logdash.io
+Keywords: logging,metrics,monitoring
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: colorama
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

logdash-0.1.0/README.md

@@ -0,0 +1,60 @@
+# LogDash Python SDK
+
+This is the official Python SDK for LogDash - a simple and powerful logging and metrics service.
+
+## Installation
+
+```bash
+pip install logdash
+```
+
+## Usage
+
+### Basic Usage
+
+```python
+from logdash import create_logdash
+
+# Initialize LogDash with your API key
+logdash = create_logdash(params={
+    "api_key": "your-api-key-here",
+    "host": "https://api.logdash.io",  # optional, default value shown
+    "verbose": False  # optional, default value shown
+})
+
+# Access the logger
+logger = logdash["logger"]
+logger.info("This is an info message")
+logger.error("This is an error message")
+logger.debug("This is a debug message")
+
+# Log levels supported:
+# - error
+# - warn
+# - info (also available as log())
+# - http
+# - verbose
+# - debug
+# - silly
+
+# Access metrics
+metrics = logdash["metrics"]
+metrics.set("page_views", 100)  # Set a metric value
+metrics.mutate("user_count", 1)  # Change a metric by a value (increment/decrement)
+```
+
+### Local Development
+
+If you don't provide an API key, logs will only be output locally and metrics will not be tracked:
+
+```python
+from logdash import create_logdash
+
+# Local only logger
+logdash = create_logdash()
+logdash["logger"].info("This will only be logged locally")
+```
+
+## License
+
+MIT

logdash-0.1.0/logdash/__init__.py

@@ -0,0 +1,5 @@
+from logdash.logdash import create_logdash
+from logdash.logger.logger import Logger
+from logdash.metrics.metrics import MetricOperation
+
+__all__ = ["create_logdash", "Logger", "MetricOperation"] 

logdash-0.1.0/logdash/logdash.py

@@ -0,0 +1,43 @@
+from datetime import datetime
+from typing import Dict, Optional, TypedDict, Any
+
+from logdash.logger.logger import Logger
+from logdash.metrics.base_metrics import BaseMetrics
+from logdash.metrics.create_metrics import create_metrics
+from logdash.sync.create_log_sync import create_log_sync
+from logdash.types.initialization_params import InitializationParams, RequiredInitializationParams
+from logdash.types.log_level import LogLevel
+
+
+class LogdashInstance(TypedDict):
+    logger: Logger
+    metrics: BaseMetrics
+
+
+def create_logdash(params: Optional[Dict[str, Any]] = None) -> LogdashInstance:
+    init_params = InitializationParams()
+    
+    if params is not None:
+        if "api_key" in params:
+            init_params.api_key = params["api_key"]
+        if "host" in params:
+            init_params.host = params["host"]
+        if "verbose" in params:
+            init_params.verbose = params["verbose"]
+    
+    required_params = RequiredInitializationParams(
+        api_key=init_params.api_key or "",
+        host=init_params.host or "https://api.logdash.io",
+        verbose=init_params.verbose or False,
+    )
+    
+    log_sync = create_log_sync(required_params)
+    metrics = create_metrics(required_params)
+
+    def on_log(level: LogLevel, message: str) -> None:
+        log_sync.send(message, level, datetime.now().isoformat())
+
+    return {
+        "logger": Logger(log_method=print, on_log=on_log),
+        "metrics": metrics,
+    } 

logdash-0.1.0/logdash/logger/__init__.py

@@ -0,0 +1 @@
+ 

logdash-0.1.0/logdash/logger/internal_logger.py

@@ -0,0 +1,11 @@
+from colorama import Fore, Style
+
+from logdash.logger.logger import Logger
+from logdash.types.log_level import LogLevel
+
+
+def logdash_prefix(level: LogLevel) -> str:
+    return f"{Fore.MAGENTA}[LogDash] {Style.RESET_ALL}"
+
+
+internal_logger = Logger(log_method=print, prefix=logdash_prefix) 

logdash-0.1.0/logdash/logger/logger.py

@@ -0,0 +1,66 @@
+from datetime import datetime
+from typing import Any, Callable, List, Dict, Optional
+
+from colorama import Fore, Style, init
+
+from logdash.types.log_level import LogLevel
+
+# Initialize colorama
+init()
+
+LOG_LEVEL_COLORS: Dict[LogLevel, str] = {
+    LogLevel.ERROR: Fore.RED,
+    LogLevel.WARN: Fore.YELLOW,
+    LogLevel.INFO: Fore.BLUE,
+    LogLevel.HTTP: Fore.CYAN,
+    LogLevel.VERBOSE: Fore.GREEN,
+    LogLevel.DEBUG: Fore.LIGHTGREEN_EX,
+    LogLevel.SILLY: Fore.LIGHTBLACK_EX,
+}
+
+
+class Logger:
+    def __init__(
+        self,
+        log_method: Callable = print,
+        prefix: Optional[Callable[[LogLevel], str]] = None,
+        on_log: Optional[Callable[[LogLevel, str], None]] = None,
+    ):
+        self.log_method = log_method
+        self.prefix = prefix or (lambda level: f"{level.value.upper()} ")
+        self.on_log = on_log
+
+    def error(self, *data: Any) -> None:
+        self._log(LogLevel.ERROR, " ".join(str(item) for item in data))
+
+    def warn(self, *data: Any) -> None:
+        self._log(LogLevel.WARN, " ".join(str(item) for item in data))
+
+    def info(self, *data: Any) -> None:
+        self._log(LogLevel.INFO, " ".join(str(item) for item in data))
+
+    def log(self, *data: Any) -> None:
+        self._log(LogLevel.INFO, " ".join(str(item) for item in data))
+
+    def http(self, *data: Any) -> None:
+        self._log(LogLevel.HTTP, " ".join(str(item) for item in data))
+
+    def verbose(self, *data: Any) -> None:
+        self._log(LogLevel.VERBOSE, " ".join(str(item) for item in data))
+
+    def debug(self, *data: Any) -> None:
+        self._log(LogLevel.DEBUG, " ".join(str(item) for item in data))
+
+    def silly(self, *data: Any) -> None:
+        self._log(LogLevel.SILLY, " ".join(str(item) for item in data))
+
+    def _log(self, level: LogLevel, message: str) -> None:
+        color = LOG_LEVEL_COLORS[level]
+        
+        date_prefix = f"{Fore.LIGHTBLACK_EX}[{datetime.now().isoformat()}]{Style.RESET_ALL}"
+        prefix = f"{color}{self.prefix(level)}{Style.RESET_ALL}"
+        formatted_message = f"{date_prefix} {prefix}{message}"
+
+        self.log_method(formatted_message)
+        if self.on_log:
+            self.on_log(level, message) 

logdash-0.1.0/logdash/metrics/__init__.py

@@ -0,0 +1 @@
+ 

logdash-0.1.0/logdash/metrics/base_metrics.py

@@ -0,0 +1,11 @@
+from abc import ABC, abstractmethod
+
+
+class BaseMetrics(ABC):
+    @abstractmethod
+    def set(self, key: str, value: float) -> None:
+        pass
+
+    @abstractmethod
+    def mutate(self, key: str, value: float) -> None:
+        pass 

logdash-0.1.0/logdash/metrics/create_metrics.py

@@ -0,0 +1,15 @@
+from logdash.logger.internal_logger import internal_logger
+from logdash.metrics.base_metrics import BaseMetrics
+from logdash.metrics.metrics import Metrics
+from logdash.metrics.noop_metrics import NoopMetrics
+from logdash.types.initialization_params import RequiredInitializationParams
+
+
+def create_metrics(params: RequiredInitializationParams) -> BaseMetrics:
+    if not params.api_key:
+        internal_logger.log(
+            "Api key was not provided in the InitializationParams when calling create_logdash(), metrics will not be registered.\n"
+        )
+        return NoopMetrics()
+
+    return Metrics(params) 

logdash-0.1.0/logdash/metrics/metrics.py

@@ -0,0 +1,50 @@
+from enum import Enum
+import requests
+
+from logdash.logger.internal_logger import internal_logger
+from logdash.metrics.base_metrics import BaseMetrics
+from logdash.types.initialization_params import RequiredInitializationParams
+
+
+class MetricOperation(str, Enum):
+    SET = "set"
+    CHANGE = "change"
+
+
+class Metrics(BaseMetrics):
+    def __init__(self, params: RequiredInitializationParams):
+        self.params = params
+
+    def set(self, name: str, value: float) -> None:
+        if self.params.verbose:
+            internal_logger.verbose(f"Setting metric {name} to {value}")
+
+        requests.put(
+            f"{self.params.host}/metrics",
+            headers={
+                "Content-Type": "application/json",
+                "project-api-key": self.params.api_key,
+            },
+            json={
+                "name": name,
+                "value": value,
+                "operation": MetricOperation.SET,
+            },
+        )
+
+    def mutate(self, name: str, value: float) -> None:
+        if self.params.verbose:
+            internal_logger.verbose(f"Mutating metric {name} by {value}")
+
+        requests.put(
+            f"{self.params.host}/metrics",
+            headers={
+                "Content-Type": "application/json",
+                "project-api-key": self.params.api_key,
+            },
+            json={
+                "name": name,
+                "value": value,
+                "operation": MetricOperation.CHANGE,
+            },
+        ) 

logdash-0.1.0/logdash/metrics/noop_metrics.py

@@ -0,0 +1,9 @@
+from logdash.metrics.base_metrics import BaseMetrics
+
+
+class NoopMetrics(BaseMetrics):
+    def set(self, key: str, value: float) -> None:
+        pass
+
+    def mutate(self, key: str, value: float) -> None:
+        pass 

logdash-0.1.0/logdash/sync/__init__.py

@@ -0,0 +1 @@
+ 

logdash-0.1.0/logdash/sync/create_log_sync.py

@@ -0,0 +1,15 @@
+from logdash.logger.internal_logger import internal_logger
+from logdash.sync.http_log_sync import HttpLogSync
+from logdash.sync.log_sync import LogSync
+from logdash.sync.noop_log_sync import NoopLogSync
+from logdash.types.initialization_params import RequiredInitializationParams
+
+
+def create_log_sync(params: RequiredInitializationParams) -> LogSync:
+    if not params.api_key:
+        internal_logger.log(
+            "Api key was not provided in the InitializationParams when calling create_logdash(), using only local logger.\n"
+        )
+        return NoopLogSync()
+
+    return HttpLogSync(params) 

logdash-0.1.0/logdash/sync/http_log_sync.py

@@ -0,0 +1,31 @@
+import requests
+
+from logdash.sync.log_sync import LogSync
+from logdash.types.initialization_params import RequiredInitializationParams
+from logdash.types.log_level import LogLevel
+
+
+class HttpLogSync(LogSync):
+    def __init__(self, params: RequiredInitializationParams):
+        self.params = params
+        self.sequence_number = 0
+
+    # todos:
+    # - queue
+    # - retry
+    # - batching
+    def send(self, message: str, level: LogLevel, created_at: str) -> None:
+        requests.post(
+            f"{self.params.host}/logs",
+            headers={
+                "Content-Type": "application/json",
+                "project-api-key": self.params.api_key,
+            },
+            json={
+                "message": message,
+                "level": level,
+                "createdAt": created_at,
+                "sequenceNumber": self.sequence_number,
+            },
+        )
+        self.sequence_number += 1 

logdash-0.1.0/logdash/sync/log_sync.py

@@ -0,0 +1,9 @@
+from abc import ABC, abstractmethod
+
+from logdash.types.log_level import LogLevel
+
+
+class LogSync(ABC):
+    @abstractmethod
+    def send(self, message: str, level: LogLevel, created_at: str) -> None:
+        pass 

logdash-0.1.0/logdash/sync/noop_log_sync.py

@@ -0,0 +1,7 @@
+from logdash.sync.log_sync import LogSync
+from logdash.types.log_level import LogLevel
+
+
+class NoopLogSync(LogSync):
+    def send(self, message: str, level: LogLevel, created_at: str) -> None:
+        pass 

logdash-0.1.0/logdash/types/__init__.py

@@ -0,0 +1 @@
+ 

logdash-0.1.0/logdash/types/initialization_params.py

@@ -0,0 +1,16 @@
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass
+class InitializationParams:
+    api_key: Optional[str] = None
+    host: Optional[str] = None
+    verbose: Optional[bool] = None
+
+
+@dataclass
+class RequiredInitializationParams:
+    api_key: str
+    host: str
+    verbose: bool 

logdash-0.1.0/logdash/types/log_level.py

@@ -0,0 +1,11 @@
+from enum import Enum
+
+
+class LogLevel(str, Enum):
+    ERROR = "error"
+    WARN = "warning"
+    INFO = "info"
+    HTTP = "http"
+    VERBOSE = "verbose"
+    DEBUG = "debug"
+    SILLY = "silly" 

logdash-0.1.0/logdash.egg-info/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: logdash
+Version: 0.1.0
+Summary: Python SDK for LogDash logging and metrics service
+Home-page: https://logdash.io
+Author: LogDash
+Author-email: info@logdash.io
+Keywords: logging,metrics,monitoring
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: colorama
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

logdash-0.1.0/logdash.egg-info/SOURCES.txt

@@ -0,0 +1,27 @@
+LICENSE
+MANIFEST.in
+README.md
+setup.py
+logdash/__init__.py
+logdash/logdash.py
+logdash.egg-info/PKG-INFO
+logdash.egg-info/SOURCES.txt
+logdash.egg-info/dependency_links.txt
+logdash.egg-info/requires.txt
+logdash.egg-info/top_level.txt
+logdash/logger/__init__.py
+logdash/logger/internal_logger.py
+logdash/logger/logger.py
+logdash/metrics/__init__.py
+logdash/metrics/base_metrics.py
+logdash/metrics/create_metrics.py
+logdash/metrics/metrics.py
+logdash/metrics/noop_metrics.py
+logdash/sync/__init__.py
+logdash/sync/create_log_sync.py
+logdash/sync/http_log_sync.py
+logdash/sync/log_sync.py
+logdash/sync/noop_log_sync.py
+logdash/types/__init__.py
+logdash/types/initialization_params.py
+logdash/types/log_level.py

logdash-0.1.0/logdash.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

logdash-0.1.0/logdash.egg-info/requires.txt

@@ -0,0 +1,2 @@
+requests
+colorama

logdash-0.1.0/logdash.egg-info/top_level.txt

@@ -0,0 +1 @@
+logdash

logdash-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

logdash-0.1.0/setup.py

@@ -0,0 +1,22 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="logdash",
+    version="0.1.0",
+    packages=find_packages(),
+    install_requires=[
+        "requests",
+        "colorama",
+    ],
+    author="LogDash",
+    author_email="info@logdash.io",
+    description="Python SDK for LogDash logging and metrics service",
+    keywords="logging, metrics, monitoring",
+    url="https://logdash.io",
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.6",
+)