devlogs 2.0.3__tar.gz → 2.2.0__tar.gz

{devlogs-2.0.3/src/devlogs.egg-info → devlogs-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devlogs
-Version: 2.0.3
+Version: 2.2.0
 Summary: Developer-focused logging library for Python with OpenSearch integration.
 Author-email: Dan Driscoll <dan@thedandriscoll.org>
 License: MIT License

{devlogs-2.0.3 → devlogs-2.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "devlogs"
-version = "2.0.3"
+version = "2.2.0"
 description = "Developer-focused logging library for Python with OpenSearch integration."
 requires-python = ">=3.11"
 readme = "README.md"

{devlogs-2.0.3 → devlogs-2.2.0}/src/devlogs/cli.py

@@ -10,7 +10,7 @@ import click
 import typer
 from pathlib import Path
 
-from .config import load_config, set_dotenv_path, set_url, URLParseError, _parse_opensearch_url
+from .config import load_config, set_dotenv_path, set_url, URLParseError, _parse_opensearch_url, parse_url, CollectorURLConfig
 from .formatting import format_timestamp
 from .opensearch.client import (
 	get_opensearch_client,
@@ -39,7 +39,7 @@ OLD_TEMPLATE_NAMES = ("devlogs-template", "devlogs-logs-template")
 
 # Common options for commands - these can be placed anywhere in the command line
 ENV_OPTION = typer.Option(None, "--env", help="Path to .env file to load")
-URL_OPTION = typer.Option(None, "--url", help="OpenSearch URL (e.g., https://user:pass@host:port/index)")
+URL_OPTION = typer.Option(None, "--url", help="URL (e.g., opensearchs://user:pass@host:port/index or https://TOKEN@host:port/path)")
 
 
 def _apply_common_options(env: str = None, url: str = None):
@@ -61,11 +61,17 @@ def main_callback(
 	_apply_common_options(env, url)
 
 
+_HIDDEN_FIELDS = {"run_id", "build_number", "build_url", "job", "node_id", "seq"}
+
+
 def _format_features(features):
 	if not features:
 		return ""
 	if isinstance(features, dict):
-		items = sorted(features.items(), key=lambda item: str(item[0]))
+		items = sorted(
+			((k, v) for k, v in features.items() if k not in _HIDDEN_FIELDS),
+			key=lambda item: str(item[0]),
+		)
 		parts = []
 		for key, value in items:
 			key_text = str(key)
@@ -722,6 +728,7 @@ def tail(
 				since=since,
 				limit=limit,
 				search_after=search_after,
+				application=cfg.application,
 			)
 			_verbose_echo(f"Received {len(docs)} docs, next cursor={search_after}")
 			if verbose and docs:
@@ -845,6 +852,7 @@ def search(
 					since=since,
 					limit=limit,
 					search_after=search_after,
+					application=cfg.application,
 				)
 			else:
 				docs = search_logs(
@@ -856,6 +864,7 @@ def search(
 					level=level,
 					since=since,
 					limit=limit,
+					application=cfg.application,
 				)
 			entries = normalize_log_entries(docs, limit=limit)
 			consecutive_errors = 0
@@ -941,6 +950,7 @@ def last_error(
 			since=since,
 			until=until,
 			limit=limit,
+			application=cfg.application,
 		)
 		entries = normalize_log_entries(docs, limit=limit)
 	except (ConnectionFailedError, urllib.error.URLError) as e:
@@ -1166,7 +1176,13 @@ def demo(
 	"""Generate demo logs to illustrate devlogs capabilities."""
 	_apply_common_options(env, url)
 	from .demo import run_demo
-	run_demo(duration, count, require_opensearch)
+
+	cfg = load_config()
+	if cfg.url_mode == "collector":
+		from .devlogs_client import DevlogsClient
+		run_demo(duration, count, require_opensearch=None, collector_url=cfg.collector_url)
+	else:
+		run_demo(duration, count, require_opensearch=require_opensearch)
 
 
 @app.command()
@@ -1181,8 +1197,20 @@ def serve(
 
 
 def _build_opensearch_url(scheme: str, host: str, port: int, user: str, password: str, index: str) -> str:
-	"""Build an OpenSearch URL from components, URL-encoding credentials."""
+	"""Build an OpenSearch URL from components, URL-encoding credentials.
+
+	Uses the opensearchs:// scheme (TLS) or opensearch:// (non-TLS).
+	The scheme parameter accepts 'https'/'http' (mapped to opensearch schemes)
+	or 'opensearchs'/'opensearch' directly.
+	"""
 	from urllib.parse import quote
+	# Map legacy schemes to opensearch:// variants
+	if scheme == "https":
+		url_scheme = "opensearchs"
+	elif scheme == "http":
+		url_scheme = "opensearch"
+	else:
+		url_scheme = scheme
 	# URL-encode username and password to handle special characters
 	encoded_user = quote(user, safe="") if user else ""
 	encoded_pass = quote(password, safe="") if password else ""
@@ -1193,7 +1221,7 @@ def _build_opensearch_url(scheme: str, host: str, port: int, user: str, password
 	else:
 		auth = ""
 	path = f"/{index}" if index else ""
-	return f"{scheme}://{auth}{host}:{port}{path}"
+	return f"{url_scheme}://{auth}{host}:{port}{path}"
 
 
 def _format_env_output(scheme: str, host: str, port: int, user: str, password: str, index: str) -> str:
@@ -1211,155 +1239,6 @@ def _format_env_output(scheme: str, host: str, port: int, user: str, password: s
 	return "\n".join(lines)
 
 
-@app.command()
-def initjenkins(
-	jenkinsfile: str = typer.Argument("Jenkinsfile", help="Path to Jenkinsfile to modify"),
-	credential_id: str = typer.Option("devlogs-opensearch-url", "--credential-id", "-c", help="Jenkins credential ID to use"),
-	env: str = ENV_OPTION,
-	url: str = URL_OPTION,
-):
-	"""Add devlogs configuration to an existing Jenkinsfile.
-
-	This command modifies an existing Jenkinsfile to add an options block
-	with the devlogs pipeline step configured to use a Jenkins credential.
-
-	After running this command, you need to create a Jenkins credential
-	of type "Secret text" with the OpenSearch URL.
-
-	Examples:
-	  devlogs initjenkins                        # Modify ./Jenkinsfile
-	  devlogs initjenkins path/to/Jenkinsfile    # Modify specific file
-	  devlogs initjenkins --credential-id my-cred  # Use custom credential ID
-	"""
-	import re
-
-	_apply_common_options(env, url)
-
-	jenkinsfile_path = Path(jenkinsfile)
-	if not jenkinsfile_path.is_file():
-		typer.echo(typer.style(f"Error: Jenkinsfile not found: {jenkinsfile_path}", fg=typer.colors.RED), err=True)
-		raise typer.Exit(1)
-
-	content = jenkinsfile_path.read_text(encoding="utf-8")
-
-	# Check if this looks like a declarative pipeline
-	if "pipeline" not in content:
-		typer.echo(typer.style("Error: File does not appear to be a declarative Jenkins pipeline.", fg=typer.colors.RED), err=True)
-		typer.echo("This command only supports declarative pipelines with a 'pipeline { }' block.", err=True)
-		raise typer.Exit(1)
-
-	# Check if devlogs is already configured
-	if "devlogs(" in content:
-		typer.echo(typer.style("Warning: Jenkinsfile already appears to have devlogs configuration.", fg=typer.colors.YELLOW))
-		typer.echo("Review the file manually to ensure correct configuration.")
-		raise typer.Exit(0)
-
-	options_line = f"        devlogs(credentialsId: '{credential_id}')"
-
-	modified = False
-	lines = content.split("\n")
-	result_lines = []
-	i = 0
-
-	# Track brace depth and whether we're inside pipeline block
-	in_pipeline = False
-	pipeline_brace_depth = 0
-	added_options = False
-
-	while i < len(lines):
-		line = lines[i]
-		result_lines.append(line)
-
-		# Detect entering pipeline block
-		if not in_pipeline and re.match(r'^\s*pipeline\s*\{', line):
-			in_pipeline = True
-			pipeline_brace_depth = 1
-			i += 1
-			continue
-
-		if in_pipeline:
-			# Count braces to track depth
-			pipeline_brace_depth += line.count('{') - line.count('}')
-
-			# Check for existing options block and add our line
-			if not added_options and re.match(r'^\s*options\s*\{', line):
-				result_lines.append(options_line)
-				added_options = True
-				modified = True
-
-			# If we hit stages and haven't added options, add it before stages
-			if re.match(r'^\s*stages\s*\{', line) and not added_options:
-				# Insert before the stages line
-				result_lines.pop()  # Remove the stages line we just added
-
-				result_lines.append("")
-				result_lines.append("    options {")
-				result_lines.append(options_line)
-				result_lines.append("    }")
-				added_options = True
-				modified = True
-
-				result_lines.append("")
-				result_lines.append(line)  # Re-add the stages line
-
-			# Exit pipeline tracking when we close the pipeline block
-			if pipeline_brace_depth == 0:
-				in_pipeline = False
-
-		i += 1
-
-	if not modified:
-		typer.echo(typer.style("Error: Could not find a suitable location to add devlogs configuration.", fg=typer.colors.RED), err=True)
-		typer.echo("Ensure the Jenkinsfile has a 'pipeline { stages { } }' structure.", err=True)
-		raise typer.Exit(1)
-
-	# Write the modified file
-	new_content = "\n".join(result_lines)
-	jenkinsfile_path.write_text(new_content, encoding="utf-8")
-
-	typer.echo(typer.style(f"Modified {jenkinsfile_path}", fg=typer.colors.GREEN))
-	typer.echo()
-	typer.echo("Added:")
-	typer.echo(f"  - Options: devlogs(credentialsId: '{credential_id}')")
-
-	# Print setup instructions
-	typer.echo()
-	typer.echo(typer.style("Next steps - Create Jenkins credential:", fg=typer.colors.CYAN, bold=True))
-	typer.echo("=" * 60)
-	typer.echo()
-	typer.echo("1. Go to Jenkins > Manage Jenkins > Credentials")
-	typer.echo("2. Select the appropriate domain (e.g., Global)")
-	typer.echo("3. Click 'Add Credentials'")
-	typer.echo("4. Configure:")
-	typer.echo(f"   - Kind: Secret text")
-	typer.echo(f"   - ID: {credential_id}")
-	typer.echo("   - Secret: <your OpenSearch URL>")
-	typer.echo()
-
-	# Try to load config and show the URL value
-	try:
-		cfg = load_config()
-		if cfg.enabled:
-			# Build the URL from config
-			credential_url = _build_opensearch_url(
-				cfg.opensearch_scheme,
-				cfg.opensearch_host,
-				cfg.opensearch_port,
-				cfg.opensearch_user,
-				cfg.opensearch_pass,
-				cfg.index,
-			)
-			typer.echo(typer.style("Credential value (from your .env/environment):", fg=typer.colors.GREEN, bold=True))
-			typer.echo("-" * 60)
-			typer.echo(credential_url)
-			typer.echo("-" * 60)
-		else:
-			typer.echo("Tip: Set up a .env file with DEVLOGS_OPENSEARCH_URL to see the exact value here.")
-			typer.echo("     Run 'devlogs mkurl' to interactively build the URL.")
-	except Exception:
-		typer.echo("Tip: Run 'devlogs mkurl' to interactively build the OpenSearch URL.")
-
-
 @app.command()
 def mkurl():
 	"""Interactively create an OpenSearch URL and show .env formats.
@@ -1369,7 +1248,7 @@ def mkurl():
 	the components (host, port, credentials, index) one by one.
 
 	The output shows three equivalent formats:
-	- A bare URL (for --url flag or DEVLOGS_OPENSEARCH_URL)
+	- A bare URL (for --url flag or DEVLOGS_URL)
 	- The URL as a single .env variable
 	- Individual .env variables for each component
 	"""
@@ -1410,10 +1289,8 @@ def mkurl():
 	else:
 		# Prompt for each component
 		typer.echo()
-		scheme = typer.prompt("Scheme (http/https)", default="https")
-		if scheme not in ("http", "https"):
-			typer.echo(typer.style("Error: Scheme must be 'http' or 'https'.", fg=typer.colors.RED), err=True)
-			raise typer.Exit(1)
+		use_tls = typer.prompt("Use TLS? (yes/no)", default="yes")
+		scheme = "https" if use_tls.lower() in ("yes", "y") else "http"
 		host = typer.prompt("Host", default="localhost")
 		default_port = 443 if scheme == "https" else 9200
 		port = int(typer.prompt("Port", default=str(default_port)))
@@ -1441,7 +1318,7 @@ def mkurl():
 	typer.echo()
 	typer.echo(typer.style("2. Single .env variable:", fg=typer.colors.CYAN, bold=True))
 	typer.echo("-" * 50)
-	typer.echo(f"DEVLOGS_OPENSEARCH_URL={url}")
+	typer.echo(f"DEVLOGS_URL={url}")
 
 	# Format 3: Individual .env variables
 	typer.echo()

{devlogs-2.0.3 → devlogs-2.2.0}/src/devlogs/collector/cli.py

@@ -75,6 +75,8 @@ def serve(
             typer.echo(f"  OpenSearch: {cfg.opensearch_host}:{cfg.opensearch_port}")
             typer.echo(f"  Index: {cfg.index}")
 
+    from ..version import __version__
+    typer.echo(f"  Version: {__version__}")
     typer.echo(f"  Listening on: {host}:{port}")
     typer.echo()
 

{devlogs-2.0.3 → devlogs-2.2.0}/src/devlogs/collector/forwarder.py

@@ -24,7 +24,7 @@ def forward_request(
     Forwards the request body as-is, preserving relevant headers.
 
     Args:
-        forward_url: The upstream URL to forward to (should end with /v1/logs)
+        forward_url: The upstream URL to forward to
         body: The raw request body bytes
         content_type: The Content-Type header value
         auth_header: Optional Authorization header to forward
@@ -37,9 +37,7 @@ def forward_request(
     Raises:
         ForwardError: If the forward request fails
     """
-    # Ensure URL ends with /v1/logs
-    if not forward_url.endswith("/v1/logs"):
-        forward_url = forward_url.rstrip("/") + "/v1/logs"
+    forward_url = forward_url.rstrip("/")
 
     headers = {
         "Content-Type": content_type,

{devlogs-2.0.3 → devlogs-2.2.0}/src/devlogs/collector/server.py

@@ -72,6 +72,30 @@ async def lifespan(app: FastAPI):
 
     yield
 
+    # Emit shutdown trace
+    if mode == "ingest":
+        try:
+            client = get_opensearch_client()
+            doc = DevlogsRecord(
+                application="devlogs-collector",
+                component="lifecycle",
+                timestamp=get_current_timestamp(),
+                message="Collector stopped",
+                level="info",
+                area="shutdown",
+                version=__version__,
+                fields={
+                    "mode": mode,
+                    "host": platform.node(),
+                },
+            )
+            doc.collected_ts = get_current_timestamp()
+            doc.client_ip = "127.0.0.1"
+            doc._identity = {"mode": "internal"}
+            client.index(index=cfg.index, body=doc.to_dict())
+        except Exception:
+            pass
+
 
 # Create FastAPI app for collector
 app = FastAPI(
@@ -115,19 +139,8 @@ async def collector_error_handler(request: Request, exc: CollectorError):
     )
 
 
-@app.get("/health")
-async def health():
-    """Health check endpoint."""
-    cfg = load_config()
-    mode = cfg.get_collector_mode()
-    return {
-        "status": "healthy",
-        "mode": mode,
-        "version": __version__,
-    }
-
 
-@app.post("/v1/logs")
+@app.post("/")
 async def ingest_logs(request: Request):
     """Ingest log records.