phlo-alloy 0.1.0__tar.gz

phlo_alloy-0.1.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: phlo-alloy
+Version: 0.1.0
+Summary: alloy 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: pyyaml>=6.0.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+
+alloy service plugin for Phlo.

phlo_alloy-0.1.0/README.md

@@ -0,0 +1,64 @@
+# phlo-alloy
+
+Grafana Alloy log collector for Phlo.
+
+## Description
+
+Collects logs from all Docker containers and ships them to Loki for aggregation and querying.
+
+## Installation
+
+```bash
+pip install phlo-alloy
+# or
+phlo plugin install alloy
+```
+
+## Profile
+
+Part of the `observability` profile.
+
+## Configuration
+
+| Variable     | Default | Description     |
+| ------------ | ------- | --------------- |
+| `ALLOY_PORT` | `12345` | Alloy HTTP port |
+
+## Auto-Configuration
+
+This package is **fully auto-configured**:
+
+| Feature                 | How It Works                                           |
+| ----------------------- | ------------------------------------------------------ |
+| **Container Discovery** | Auto-discovers all Docker containers via Docker socket |
+| **Log Collection**      | Collects stdout/stderr from all containers             |
+| **Loki Shipping**       | Ships logs to Loki for storage and querying            |
+| **Metrics Labels**      | Exposes Alloy metrics for Prometheus                   |
+
+### Docker Socket Access
+
+Alloy mounts the Docker socket to discover and collect logs from all containers:
+
+```yaml
+volumes:
+  - /var/run/docker.sock:/var/run/docker.sock:ro
+```
+
+## Usage
+
+```bash
+# Start with observability profile
+phlo services start --profile observability
+
+# Or start individually
+phlo services start --service alloy
+```
+
+## Endpoints
+
+- **HTTP**: `http://localhost:12345`
+- **Ready**: `http://localhost:12345/-/ready`
+
+## Entry Points
+
+- `phlo.plugins.services` - Provides `AlloyServicePlugin`

phlo_alloy-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools>=45", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "phlo-alloy"
+version = "0.1.0"
+description = "alloy service plugin for Phlo"
+readme = {text = "alloy 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",
+    "pyyaml>=6.0.1",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "ruff>=0.1.0",
+]
+
+[project.entry-points."phlo.plugins.services"]
+alloy = "phlo_alloy.plugin:AlloyServicePlugin"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+phlo_alloy = ['service.yaml', 'config.alloy']
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"

phlo_alloy-0.1.0/setup.cfg

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

phlo_alloy-0.1.0/src/phlo_alloy/config.alloy

@@ -0,0 +1,80 @@
+// Grafana Alloy Configuration for Phlo
+// Collects Docker container logs and ships to Loki
+
+// Log discovery from Docker
+discovery.docker "containers" {
+  host = "unix:///var/run/docker.sock"
+}
+
+// Relabel Docker labels to Loki labels
+discovery.relabel "docker_logs" {
+  targets = discovery.docker.containers.targets
+
+  // Keep container name as primary label
+  rule {
+    source_labels = ["__meta_docker_container_name"]
+    regex         = "/(.*)"
+    target_label  = "container"
+  }
+
+  // Add project/compose labels
+  rule {
+    source_labels = ["__meta_docker_container_label_com_docker_compose_project"]
+    target_label  = "project"
+  }
+
+  rule {
+    source_labels = ["__meta_docker_container_label_com_docker_compose_service"]
+    target_label  = "service"
+  }
+
+  // Keep image name
+  rule {
+    source_labels = ["__meta_docker_container_image"]
+    target_label  = "image"
+  }
+}
+
+// Collect logs from Docker containers
+loki.source.docker "containers" {
+  host       = "unix:///var/run/docker.sock"
+  targets    = discovery.relabel.docker_logs.output
+  forward_to = [loki.process.docker_logs.receiver]
+}
+
+// Process logs - add timestamps and parse JSON
+loki.process "docker_logs" {
+  forward_to = [loki.write.loki.receiver]
+
+  // Try to extract JSON fields
+  stage.json {
+    expressions = {
+      level   = "level",
+      msg     = "msg",
+      message = "message",
+      run_id  = "run_id",
+      asset_key = "asset_key",
+      partition_key = "partition_key",
+    }
+  }
+
+  // Normalize level
+  stage.labels {
+    values = {
+      level = "",
+    }
+  }
+
+  // Add timestamp if present in log
+  stage.timestamp {
+    source = "time"
+    format = "RFC3339"
+  }
+}
+
+// Write logs to Loki
+loki.write "loki" {
+  endpoint {
+    url = "http://loki:3100/loki/api/v1/push"
+  }
+}

phlo_alloy-0.1.0/src/phlo_alloy/plugin.py

@@ -0,0 +1,29 @@
+"""Alloy service plugin."""
+
+from __future__ import annotations
+
+from importlib import resources
+from typing import Any
+
+import yaml
+
+from phlo.plugins import PluginMetadata, ServicePlugin
+
+
+class AlloyServicePlugin(ServicePlugin):
+    """Service plugin for alloy."""
+
+    @property
+    def metadata(self) -> PluginMetadata:
+        return PluginMetadata(
+            name="alloy",
+            version="0.1.0",
+            description="Grafana Alloy for log collection and shipping to Loki",
+            author="Phlo Team",
+            tags=["observability", "logs", "agent"],
+        )
+
+    @property
+    def service_definition(self) -> dict[str, Any]:
+        service_path = resources.files("phlo_alloy").joinpath("service.yaml")
+        return yaml.safe_load(service_path.read_text(encoding="utf-8"))

phlo_alloy-0.1.0/src/phlo_alloy/service.yaml

@@ -0,0 +1,48 @@
+name: alloy
+description: Grafana Alloy for log collection and shipping to Loki
+category: observability
+default: false
+profile: observability
+
+image: grafana/alloy:v1.4.2
+
+compose:
+  restart: unless-stopped
+  labels:
+    phlo.metrics.enabled: "true"
+    phlo.metrics.port: "alloy:12345"
+    phlo.metrics.path: "/metrics"
+  command:
+    - run
+    - --server.http.listen-addr=0.0.0.0:12345
+    - /etc/alloy/config.alloy
+  ports:
+    - "${ALLOY_PORT:-12345}:12345"
+  volumes:
+    - ./alloy/config.alloy:/etc/alloy/config.alloy:ro
+    - /var/run/docker.sock:/var/run/docker.sock:ro
+  depends_on:
+    loki:
+      condition: service_healthy
+  healthcheck:
+    test:
+      [
+        "CMD",
+        "wget",
+        "--quiet",
+        "--tries=1",
+        "--spider",
+        "http://localhost:12345/-/ready",
+      ]
+    interval: 10s
+    timeout: 5s
+    retries: 5
+
+env_vars:
+  ALLOY_PORT:
+    default: 12345
+    description: Alloy HTTP port
+
+files:
+  - source: config.alloy
+    dest: alloy/config.alloy

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

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: phlo-alloy
+Version: 0.1.0
+Summary: alloy 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: pyyaml>=6.0.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+
+alloy service plugin for Phlo.

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

@@ -0,0 +1,14 @@
+README.md
+pyproject.toml
+src/phlo_alloy/__init__.py
+src/phlo_alloy/config.alloy
+src/phlo_alloy/plugin.py
+src/phlo_alloy/service.yaml
+src/phlo_alloy.egg-info/PKG-INFO
+src/phlo_alloy.egg-info/SOURCES.txt
+src/phlo_alloy.egg-info/dependency_links.txt
+src/phlo_alloy.egg-info/entry_points.txt
+src/phlo_alloy.egg-info/requires.txt
+src/phlo_alloy.egg-info/top_level.txt
+tests/test_alloy_plugin.py
+tests/test_integration_alloy.py

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

@@ -0,0 +1 @@
+

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

@@ -0,0 +1,2 @@
+[phlo.plugins.services]
+alloy = phlo_alloy.plugin:AlloyServicePlugin

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

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

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

@@ -0,0 +1 @@
+phlo_alloy

phlo_alloy-0.1.0/tests/test_alloy_plugin.py

@@ -0,0 +1,19 @@
+"""Tests for Alloy service plugin."""
+
+from phlo_alloy.plugin import AlloyServicePlugin
+
+
+def test_alloy_service_definition():
+    plugin = AlloyServicePlugin()
+    defn = plugin.service_definition
+
+    assert defn["name"] == "alloy"
+    assert defn["profile"] == "observability"
+
+
+def test_alloy_plugin_metadata():
+    plugin = AlloyServicePlugin()
+    meta = plugin.metadata
+
+    assert meta.name == "alloy"
+    assert "observability" in meta.tags

phlo_alloy-0.1.0/tests/test_integration_alloy.py

@@ -0,0 +1,24 @@
+"""Integration tests for phlo-alloy."""
+
+import pytest
+
+pytestmark = pytest.mark.integration
+
+
+def test_alloy_plugin_initializes():
+    """Test that Alloy plugin can be instantiated."""
+    from phlo_alloy.plugin import AlloyServicePlugin
+
+    plugin = AlloyServicePlugin()
+    assert plugin is not None
+    assert plugin.metadata.name == "alloy"
+
+
+def test_alloy_service_definition():
+    """Test that service definition can be loaded."""
+    from phlo_alloy.plugin import AlloyServicePlugin
+
+    plugin = AlloyServicePlugin()
+    service_def = plugin.service_definition
+
+    assert isinstance(service_def, dict)