Skip to content

Generate

provide.foundation.cli.commands.logs.generate

TODO: Add module docstring.

Classes

Functions

generate_logs_command 

generate_logs_command(
    count: int,
    rate: float,
    stream: str,
    style: str,
    error_rate: float,
    enable_rate_limit: bool,
    rate_limit: float,
) -> None

Generate logs to test OpenObserve integration with Foundation's rate limiting.

Parameters:

Name Type Description Default
count int

Number of logs to generate (0 for continuous mode)

 required
rate float

Target logs per second

 required
stream str

Target stream name (currently unused)

 required
style str

Message generation style ("normal" or "burroughs")

 required
error_rate float

Probability of generating error logs (0.0 to 1.0)

 required
enable_rate_limit bool

Whether to enable Foundation's rate limiting

 required
rate_limit float

Rate limit value (logs/s) when enabled

 required
Source code in provide/foundation/cli/commands/logs/generate.py 
 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
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
@click.command(name="generate")
@click.option("-n", "--count", default=100, help="Number of logs to generate (0 for continuous)")
@click.option("-r", "--rate", default=10.0, help="Logs per second rate")
@click.option("-s", "--stream", default="default", help="Target stream name")
@click.option(
    "--style",
    type=click.Choice(["normal", "burroughs"]),
    default="normal",
    help="Message generation style",
)
@click.option("-e", "--error-rate", default=0.1, help="Error rate (0.0 to 1.0)")
@click.option("--enable-rate-limit", is_flag=True, help="Enable Foundation's rate limiting")
@click.option("--rate-limit", default=100.0, help="Rate limit (logs/s) when enabled")
@requires_click
@with_cleanup
def generate_logs_command(
    count: int,
    rate: float,
    stream: str,
    style: str,
    error_rate: float,
    enable_rate_limit: bool,
    rate_limit: float,
) -> None:
    """Generate logs to test OpenObserve integration with Foundation's rate limiting.

    Args:
        count: Number of logs to generate (0 for continuous mode)
        rate: Target logs per second
        stream: Target stream name (currently unused)
        style: Message generation style ("normal" or "burroughs")
        error_rate: Probability of generating error logs (0.0 to 1.0)
        enable_rate_limit: Whether to enable Foundation's rate limiting
        rate_limit: Rate limit value (logs/s) when enabled

    """
    print_generation_config(count, rate, stream, style, error_rate, enable_rate_limit, rate_limit)
    _configure_rate_limiter(enable_rate_limit, rate_limit)

    # Create log generator
    generator = LogGenerator(style=style, error_rate=error_rate)

    start_time = time.time()
    logs_sent = logs_failed = logs_rate_limited = 0

    try:
        if count == 0:
            logs_sent, logs_failed, logs_rate_limited = generator.generate_continuous(
                rate,
                enable_rate_limit,
                logs_rate_limited,
            )
        else:
            logs_sent, logs_failed, logs_rate_limited = generator.generate_fixed_count(
                count,
                rate,
            )
    except KeyboardInterrupt:
        click.echo("\n\n⛔ Generation interrupted by user")
    finally:
        # Print final stats before cleanup
        # (OTLP flush handled by @with_cleanup decorator)
        total_time = time.time() - start_time
        print_final_stats(logs_sent, logs_failed, logs_rate_limited, total_time, rate, enable_rate_limit)