phlo-loki 0.1.0__tar.gz

phlo_loki-0.1.0/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.4
+Name: phlo-loki
+Version: 0.1.0
+Summary: loki service plugin for Phlo
+Author-email: Phlo Team <team@phlo.dev>
+License: MIT
+Requires-Python: >=3.11
+Description-Content-Type: text/plain
+Requires-Dist: phlo>=0.1.0
+Requires-Dist: phlo-observatory>=0.1.0
+Requires-Dist: pyyaml>=6.0.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+
+loki service plugin for Phlo.

phlo_loki-0.1.0/README.md

@@ -0,0 +1,55 @@
+# phlo-loki
+
+Loki log aggregation for Phlo.
+
+## Description
+
+Log aggregation and querying service. Receives logs from Alloy and provides log search in Grafana.
+
+## Installation
+
+```bash
+pip install phlo-loki
+# or
+phlo plugin install loki
+```
+
+## Profile
+
+Part of the `observability` profile.
+
+## Configuration
+
+| Variable       | Default | Description   |
+| -------------- | ------- | ------------- |
+| `LOKI_PORT`    | `3100`  | Loki API port |
+| `LOKI_VERSION` | `3.2.1` | Loki version  |
+
+## Auto-Configuration
+
+This package is **fully auto-configured**:
+
+| Feature                | How It Works                                   |
+| ---------------------- | ---------------------------------------------- |
+| **Metrics Labels**     | Exposes Loki metrics for Prometheus            |
+| **Grafana Datasource** | Pre-configured in Grafana as "Loki" datasource |
+| **Alloy Integration**  | Receives logs from Alloy                       |
+
+## Usage
+
+```bash
+# Start with observability profile
+phlo services start --profile observability
+
+# Or start individually
+phlo services start --service loki
+```
+
+## Endpoints
+
+- **API**: `http://localhost:3100`
+- **Ready**: `http://localhost:3100/ready`
+
+## Entry Points
+
+- `phlo.plugins.services` - Provides `LokiServicePlugin`

phlo_loki-0.1.0/pyproject.toml

@@ -0,0 +1,49 @@
+[build-system]
+requires = ["setuptools>=45", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "phlo-loki"
+version = "0.1.0"
+description = "loki service plugin for Phlo"
+readme = {text = "loki service plugin for Phlo.", content-type = "text/plain"}
+requires-python = ">=3.11"
+authors = [
+    {name = "Phlo Team", email = "team@phlo.dev"},
+]
+license = {text = "MIT"}
+dependencies = [
+    "phlo>=0.1.0",
+    "phlo-observatory>=0.1.0",
+    "pyyaml>=6.0.1",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "ruff>=0.1.0",
+]
+
+[project.entry-points."phlo.plugins.services"]
+loki = "phlo_loki.plugin:LokiServicePlugin"
+
+[project.entry-points."phlo.plugins.observatory"]
+loki = "phlo_loki.observatory_plugin:LokiObservatoryExtension"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+phlo_loki = [
+    "service.yaml",
+    "loki-config.yml",
+    "observatory_assets/*",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"

phlo_loki-0.1.0/setup.cfg

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

phlo_loki-0.1.0/src/phlo_loki/loki-config.yml

@@ -0,0 +1,40 @@
+auth_enabled: false
+
+server:
+  http_listen_port: 3100
+  grpc_listen_port: 9096
+
+common:
+  instance_addr: 127.0.0.1
+  path_prefix: /loki
+  storage:
+    filesystem:
+      chunks_directory: /loki/chunks
+      rules_directory: /loki/rules
+  replication_factor: 1
+  ring:
+    kvstore:
+      store: inmemory
+
+query_range:
+  results_cache:
+    cache:
+      embedded_cache:
+        enabled: true
+        max_size_mb: 100
+
+schema_config:
+  configs:
+    - from: 2020-10-24
+      store: tsdb
+      object_store: filesystem
+      schema: v13
+      index:
+        prefix: index_
+        period: 24h
+
+ruler:
+  alertmanager_url: http://localhost:9093
+
+analytics:
+  reporting_enabled: false

phlo_loki-0.1.0/src/phlo_loki/observatory_assets/README.txt

@@ -0,0 +1 @@
+Observatory assets for phlo-loki.

phlo_loki-0.1.0/src/phlo_loki/observatory_plugin.py

@@ -0,0 +1,40 @@
+"""Observatory extension for Loki logs UI."""
+
+from __future__ import annotations
+
+from importlib import resources
+from importlib.abc import Traversable
+
+from phlo.plugins import PluginMetadata
+from phlo_observatory import ObservatoryExtensionPlugin
+from phlo_observatory.manifest import (
+    ObservatoryExtensionCompatibility,
+    ObservatoryExtensionManifest,
+    ObservatoryExtensionNavItem,
+    ObservatoryExtensionUI,
+)
+
+
+class LokiObservatoryExtension(ObservatoryExtensionPlugin):
+    """Observatory extension metadata for Loki logs UI."""
+
+    @property
+    def metadata(self) -> PluginMetadata:
+        return PluginMetadata(
+            name="loki",
+            version="0.1.0",
+            description="Observatory UI extension for logs",
+        )
+
+    @property
+    def manifest(self) -> ObservatoryExtensionManifest:
+        return ObservatoryExtensionManifest(
+            name="loki",
+            version="0.1.0",
+            compat=ObservatoryExtensionCompatibility(observatory_min="0.1.0"),
+            ui=ObservatoryExtensionUI(nav=[ObservatoryExtensionNavItem(title="Logs", to="/logs")]),
+        )
+
+    @property
+    def asset_root(self) -> Traversable:
+        return resources.files("phlo_loki").joinpath("observatory_assets")

phlo_loki-0.1.0/src/phlo_loki/plugin.py

@@ -0,0 +1,29 @@
+"""Loki service plugin."""
+
+from __future__ import annotations
+
+from importlib import resources
+from typing import Any
+
+import yaml
+
+from phlo.plugins import PluginMetadata, ServicePlugin
+
+
+class LokiServicePlugin(ServicePlugin):
+    """Service plugin for loki."""
+
+    @property
+    def metadata(self) -> PluginMetadata:
+        return PluginMetadata(
+            name="loki",
+            version="0.1.0",
+            description="Log aggregation and querying",
+            author="Phlo Team",
+            tags=["observability", "logs"],
+        )
+
+    @property
+    def service_definition(self) -> dict[str, Any]:
+        service_path = resources.files("phlo_loki").joinpath("service.yaml")
+        return yaml.safe_load(service_path.read_text(encoding="utf-8"))

phlo_loki-0.1.0/src/phlo_loki/service.yaml

@@ -0,0 +1,46 @@
+name: loki
+description: Log aggregation and querying
+category: observability
+default: false
+profile: observability
+
+image: grafana/loki:${LOKI_VERSION:-3.2.1}
+
+compose:
+  restart: unless-stopped
+  user: "0"
+  labels:
+    phlo.metrics.enabled: "true"
+    phlo.metrics.port: "loki:3100"
+    phlo.metrics.path: "/metrics"
+  command: -config.file=/etc/loki/loki-config.yml
+  ports:
+    - "${LOKI_PORT:-3100}:3100"
+  volumes:
+    - ./loki:/etc/loki:ro
+    - ./volumes/loki:/loki
+  healthcheck:
+    test:
+      [
+        "CMD",
+        "wget",
+        "--quiet",
+        "--tries=1",
+        "--spider",
+        "http://localhost:3100/ready",
+      ]
+    interval: 10s
+    timeout: 5s
+    retries: 5
+
+env_vars:
+  LOKI_VERSION:
+    default: "3.2.1"
+    description: Loki version
+  LOKI_PORT:
+    default: 3100
+    description: Loki API port
+
+files:
+  - source: loki-config.yml
+    dest: loki/loki-config.yml

phlo_loki-0.1.0/src/phlo_loki.egg-info/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.4
+Name: phlo-loki
+Version: 0.1.0
+Summary: loki service plugin for Phlo
+Author-email: Phlo Team <team@phlo.dev>
+License: MIT
+Requires-Python: >=3.11
+Description-Content-Type: text/plain
+Requires-Dist: phlo>=0.1.0
+Requires-Dist: phlo-observatory>=0.1.0
+Requires-Dist: pyyaml>=6.0.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+
+loki service plugin for Phlo.

phlo_loki-0.1.0/src/phlo_loki.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+README.md
+pyproject.toml
+src/phlo_loki/__init__.py
+src/phlo_loki/loki-config.yml
+src/phlo_loki/observatory_plugin.py
+src/phlo_loki/plugin.py
+src/phlo_loki/service.yaml
+src/phlo_loki.egg-info/PKG-INFO
+src/phlo_loki.egg-info/SOURCES.txt
+src/phlo_loki.egg-info/dependency_links.txt
+src/phlo_loki.egg-info/entry_points.txt
+src/phlo_loki.egg-info/requires.txt
+src/phlo_loki.egg-info/top_level.txt
+src/phlo_loki/observatory_assets/README.txt
+tests/test_integration_loki.py
+tests/test_loki_plugin.py

phlo_loki-0.1.0/src/phlo_loki.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

phlo_loki-0.1.0/src/phlo_loki.egg-info/entry_points.txt

@@ -0,0 +1,5 @@
+[phlo.plugins.observatory]
+loki = phlo_loki.observatory_plugin:LokiObservatoryExtension
+
+[phlo.plugins.services]
+loki = phlo_loki.plugin:LokiServicePlugin

phlo_loki-0.1.0/src/phlo_loki.egg-info/requires.txt

@@ -0,0 +1,7 @@
+phlo>=0.1.0
+phlo-observatory>=0.1.0
+pyyaml>=6.0.1
+
+[dev]
+pytest>=7.0
+ruff>=0.1.0

phlo_loki-0.1.0/src/phlo_loki.egg-info/top_level.txt

@@ -0,0 +1 @@
+phlo_loki

phlo_loki-0.1.0/tests/test_integration_loki.py

@@ -0,0 +1,24 @@
+"""Integration tests for phlo-loki."""
+
+import pytest
+
+pytestmark = pytest.mark.integration
+
+
+def test_loki_plugin_initializes():
+    """Test that Loki plugin can be instantiated."""
+    from phlo_loki.plugin import LokiServicePlugin
+
+    plugin = LokiServicePlugin()
+    assert plugin is not None
+    assert plugin.metadata.name == "loki"
+
+
+def test_loki_service_definition():
+    """Test that service definition can be loaded."""
+    from phlo_loki.plugin import LokiServicePlugin
+
+    plugin = LokiServicePlugin()
+    service_def = plugin.service_definition
+
+    assert isinstance(service_def, dict)

phlo_loki-0.1.0/tests/test_loki_plugin.py

@@ -0,0 +1,19 @@
+"""Tests for Loki service plugin."""
+
+from phlo_loki.plugin import LokiServicePlugin
+
+
+def test_loki_service_definition():
+    plugin = LokiServicePlugin()
+    defn = plugin.service_definition
+
+    assert defn["name"] == "loki"
+    assert defn["profile"] == "observability"
+
+
+def test_loki_plugin_metadata():
+    plugin = LokiServicePlugin()
+    meta = plugin.metadata
+
+    assert meta.name == "loki"
+    assert "observability" in meta.tags