Skip to content

DOCS/FEAT: Add Monitoring System & Simulation Script Documentation; Introduce API Simulation Tool#43

Merged
hatudoggy merged 5 commits intomainfrom
develop
Jun 26, 2025
Merged

DOCS/FEAT: Add Monitoring System & Simulation Script Documentation; Introduce API Simulation Tool#43
hatudoggy merged 5 commits intomainfrom
develop

Conversation

@Morfusee
Copy link
Owner

@Morfusee Morfusee commented Jun 24, 2025

1. Monitoring System Documentation

Added docs/monitoring-documentation.md:

  • Detailed setup, configuration, and usage guide for the Prometheus-Grafana monitoring stack.
  • Includes architecture diagrams, metrics catalog, PromQL query reference, alert rules, and operational procedures.
  • Provides screenshots for verification of Prometheus and Grafana integration.

Added monitoring-related images in docs/images/:

  • Architecture diagrams and dashboard screenshots for easy reference.

Updated docs/system-design-documentation.md:

  • Now references the new monitoring documentation and reflects current use of Grafana and Prometheus.

2. Simulation Script & Documentation

Added simulation/index.js:

  • Node.js script that simulates typical user interactions with the API-based chat application for load testing and traffic simulation.
  • Covers registration, login, chat creation, message sending, retrieval, update, and clean-up.

Added simulation/README.md and docs/simulation-documentation.md:

  • Usage instructions, requirements, and troubleshooting guide for the simulation script.
  • README provides a quick intro and links to the full guide.

Added simulation/.env.template:

  • Template for required environment variables.

Added simulation/package.json and pnpm-lock.yaml:

  • Ensures reproducible package management using pnpm.
  • Declares dotenv as a dependency for environment management.

Morfusee and others added 5 commits June 24, 2025 04:20
feat: implement traffic simulation code
additional docs:
- Metrics Catalog and Query Reference
- Screenshot evidences
- Cloud Architecture w Monitoring System
- Monitoring System Architecture
@Morfusee Morfusee requested a review from hatudoggy June 24, 2025 09:11
@Morfusee Morfusee self-assigned this Jun 24, 2025
@Morfusee Morfusee added the documentation Improvements or additions to documentation label Jun 24, 2025
@Morfusee Morfusee temporarily deployed to GitHub Actions June 24, 2025 09:12 — 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 8ff5ebe into main Jun 26, 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants