Skip to content

Cli

🤖 AI-Generated Content

This documentation was generated with AI assistance and is still being audited. Some, or potentially a lot, of this information may be inaccurate. Learn more.

provide.foundation.profiling.cli

Classes

Functions

profile_command 

profile_command(ctx: CLIContext) -> None

Show profiling metrics for Foundation telemetry.

Displays real-time performance metrics including throughput, latency, and emoji processing overhead.

Examples:

foundation profile # Human-readable output foundation profile --json # JSON output for monitoring

Source code in provide/foundation/profiling/cli.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
@register_command("profile")
def profile_command(ctx: CLIContext) -> None:
    """Show profiling metrics for Foundation telemetry.

    Displays real-time performance metrics including throughput,
    latency, and emoji processing overhead.

    Examples:
        foundation profile              # Human-readable output
        foundation profile --json       # JSON output for monitoring

    """
    show_profile_metrics(ctx)

register_profile_command 

register_profile_command(hub: Hub) -> None

Register the profile command with the Hub.

Parameters:

Name Type Description Default
hub Hub

Hub instance to register with

 required
Source code in provide/foundation/profiling/cli.py 
108
109
110
111
112
113
114
def register_profile_command(hub: Hub) -> None:
    """Register the profile command with the Hub.

    Args:
        hub: Hub instance to register with

    """

show_profile_metrics 

show_profile_metrics(ctx: CLIContext) -> None

Display current profiling metrics.

Parameters:

Name Type Description Default
ctx CLIContext

CLI context with output preferences

 required
Example

$ foundation profile 📊 Performance Metrics 📨 Messages/sec: 14523 ⏱️ Avg latency: 0.07ms 🎨 Emoji overhead: 3.2%

Source code in provide/foundation/profiling/cli.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
@resilient(
    fallback=None,
    context_provider=lambda: {"command": "profile"},
)
def show_profile_metrics(ctx: CLIContext) -> None:
    """Display current profiling metrics.

    Args:
        ctx: CLI context with output preferences

    Example:
        $ foundation profile
        📊 Performance Metrics
          📨 Messages/sec: 14523
          ⏱️  Avg latency: 0.07ms
          🎨 Emoji overhead: 3.2%

    """
    hub = get_hub()
    profiler = hub.get_component("profiler")

    if not profiler:
        perr("❌ Profiling not enabled", color="red", ctx=ctx)
        perr("   Enable with: profiler.enable()", color="yellow", ctx=ctx)
        return

    metrics = profiler.get_metrics()

    if ctx.json_output:
        # JSON output for monitoring systems
        pout(metrics.to_dict(), json_key="metrics")
    else:
        # Human-readable output with Foundation emoji patterns
        pout("📊 Performance Metrics", bold=True, color="cyan")

        # Main metrics
        pout(f"  📨 Messages/sec: {metrics.messages_per_second:.0f}")
        pout(f"  ⏱️  Avg latency: {metrics.avg_latency_ms:.2f}ms")
        pout(f"  🎨 Emoji overhead: {metrics.emoji_overhead_percent:.1f}%")

        # Additional details
        pout(f"  📈 Total messages: {metrics.message_count:,}")
        pout(f"  🎭 Emoji messages: {metrics.emoji_message_count:,}")
        pout(f"  📊 Avg fields/msg: {metrics.avg_fields_per_message:.1f}")

        # Show uptime
        uptime = metrics.to_dict()["uptime_seconds"]
        if uptime < 60:
            pout(f"  ⏰ Uptime: {uptime:.0f}s")
        elif uptime < 3600:
            pout(f"  ⏰ Uptime: {uptime / 60:.1f}m")
        else:
            pout(f"  ⏰ Uptime: {uptime / 3600:.1f}h")

        # Warnings for dropped messages
        if metrics.dropped_count > 0:
            perr(f"  ⚠️  Dropped: {metrics.dropped_count:,}", color="yellow")

        # Status indicator
        if not profiler.enabled:
            perr("  ⚠️  Status: Disabled", color="yellow")
        else:
            sample_rate = profiler.processor.sample_rate * 100
            pout(f"  📊 Sample rate: {sample_rate:.0f}%")