Skip to content

Add Traffic Simulation Script and Monitoring Documentation#44

Merged
hatudoggy merged 6 commits intomainfrom
develop
Jun 29, 2025
Merged

Add Traffic Simulation Script and Monitoring Documentation#44
hatudoggy merged 6 commits intomainfrom
develop

Conversation

@Morfusee
Copy link
Owner

1. Traffic Simulation Script

  • New Code:
    • Implemented a Node.js script (simulation/index.js) to simulate real user behavior across the API.
    • Covers core flows: user registration, login, chat creation, message interactions, and cleanup.
  • Environment Config:
    • Added .env.template for required simulation environment variables.
  • Dependencies:
    • Created simulation/package.json and pnpm-lock.yaml with dotenv for environment handling.
  • Usage:
    • Provides a realistic load and interaction model to test performance and monitor metrics under simulated stress.

2. Documentation Enhancements

Simulation Documentation

  • Added Files:
    • simulation/README.md: Quickstart and configuration guide for running the script.
    • docs/simulation-documentation.md: Full usage, structure breakdown, and troubleshooting.

Monitoring Stack

  • New File: docs/monitoring-documentation.md
    • Details setup and usage of Prometheus + Grafana stack.
    • Includes architecture diagrams, PromQL queries, metrics reference, and alerting strategy.
  • Assets:
    • Architecture diagrams and dashboard screenshots added to docs/images/.
  • README Updates:
    • Linked all relevant monitoring and simulation documentation for easier access.

3. Other Changes

  • Added missing hyperlinks to the main README.md for quick navigation to documentation.

@Morfusee Morfusee requested a review from hatudoggy June 29, 2025 11:43
@Morfusee Morfusee self-assigned this Jun 29, 2025
@Morfusee Morfusee added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 29, 2025
@Morfusee Morfusee temporarily deployed to GitHub Actions June 29, 2025 11:43 — with GitHub Actions Inactive
Copy link
Collaborator

@hatudoggy hatudoggy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merging

@hatudoggy hatudoggy merged commit 5f9a641 into main Jun 29, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants