Locust: Index page and starter tutorial

[amotl]

About

Continue adding integration guides from the community forum.

Preview

• https://cratedb-guide--293.org.readthedocs.build/integrate/locust/

References

• Consolidate Integration Guides I vs. II #102

[coderabbitai]

Walkthrough

Adds two documentation pages under docs/integrate/locust: an index introducing Locust integration and a detailed tutorial. The tutorial covers cluster setup, schema and data loading, Locust installation, minimal and advanced Locustfile examples with a CrateDB client, run instructions, and references. No exported/public code changes.

Changes

Cohort / File(s)	Summary
Docs: Locust integration index docs/integrate/locust/index.md	New index page for Locust integration with About/Learn sections, logo, toctree linking the tutorial, and external Locust site reference.
Docs: Locust tutorial docs/integrate/locust/tutorial.md	New end-to-end guide: local 3-node CrateDB via Docker, schema and data load (~70k rows), user/privileges, Locust setup, minimal and advanced Locustfile examples with CrateDBClient, run steps, and UI interpretation.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    actor U as User
    participant L as Locust CLI/Web
    participant LT as Locustfile Tasks
    participant C as CrateDBClient
    participant D as CrateDB (SQL)

    U->>L: Start test (users, spawn rate, host)
    L->>LT: Schedule tasks per weights
    LT->>C: run_query(sql, params)
    C->>D: Execute SQL via Python driver
    D-->>C: Rows / result
    C->>L: fire_request_success(name, response_time, length)
    Note over L: Stats aggregator updates per request
    L-->>U: Web UI metrics (RPS, latency, per-query stats)

    alt Error
        D-->>C: Exception
        C->>L: fire_request_failure(name, error)
        L-->>U: Error rate and traces visible
    end

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

cross linking

Suggested reviewers

• hammerhead
• surister

Poem

A rabbit hops through docs so bright,
New Locust trails take flight tonight.
Queries buzz, a gentle swarm,
CrateDB hums—performance warm.
With weights and waits, we race the clock,
Stats bloom quick—tick, tock, tick, tock.
Hippity-hop, ship the stock! 🐇📊

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title "Locust: Index page and starter tutorial" succinctly and accurately summarizes the primary additions in the changeset (an index page and a starter tutorial for Locust) and matches the modified documentation files, so it clearly communicates the main intent.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.
Description Check	✅ Passed	The PR description states the intent to add integration guides from the community forum, provides a preview link for the Locust integration, and references GH-102; these items directly relate to the new docs/integrate/locust files in the changeset, so the description is on-topic and meets the lenient criteria for this check.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch locust

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[amotl]

@coderabbitai review and please convert all spots to active voice.

[coderabbitai]

@amotl I'll review the PR and focus on converting all instances to active voice as requested. This aligns with the documentation guidance I have about using active voice instead of first-person or passive voice.

---

🧠 Learnings used

Learnt from: amotl
PR: crate/cratedb-guide#0
File: :0-0
Timestamp: 2025-09-15T17:42:25.449Z
Learning: When reviewing documentation, use active voice instead of first-person or passive voice, and emit corresponding suggestions.

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.