Skip to content

Commit

Permalink
Merge pull request #38 from wednesday-solutions/feat/percona_docs
Browse files Browse the repository at this point in the history
Added doc for percona
  • Loading branch information
anasnadeemws authored Mar 20, 2024
2 parents 13c35c9 + cf62150 commit 855511d
Showing 1 changed file with 41 additions and 1 deletion.
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This repository provides a template for creating and deploying a FastAPI project
- Formatting using black
- Code quality analysis using SonarQube
- Feature flagging added - User can enabled/disabled

- Database Monitoring using percona
### Getting Started

#### Requirements:
Expand Down Expand Up @@ -142,3 +142,43 @@ async def external_service_endpoint():
except CircuitBreakerError:
raise HTTPException(status_code=503, detail="Service temporarily unavailable")
```

### Database Monitoring Using Percona

To monitor your database using Percona, follow these steps:

1. **Run Application Inside Docker Container:**
- Ensure that your application is running inside a Docker container.

2. **Open Dashboard:**
- Open your web browser and navigate to `https://localhost:443`.

3. **Login:**
- Use the following credentials to log in:
```shell
Username: admin
Password: admin
```

4. **Access Settings:**
- Once logged in, navigate to the settings section of the dashboard.

5. **Add Service:**
- Within the settings, locate the "Add Service" option.

6. **Select MySQL:**
- Choose MySQL as the service you want to monitor.

7. **Provide Database Details:**
- Enter the hostname, username, password, and any other necessary environment variables required to connect to your MySQL database.

8. **Finish Configuration:**
- Click add service.

By following these steps, you'll successfully configure Percona to monitor your MySQL database.
### Dashboard Links
- Percona: https://localhost:443
- flower: http://localhost:5556
- server: http://localhost:8000
- server-healthcheck: http://localhost:8000/home

1 comment on commit 855511d

@github-actions
Copy link

Choose a reason for hiding this comment

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

Coverage

Coverage Report
FileStmtsMissCoverMissing
app
   app.py372824%12–67
app/config
   __init__.py3167%6
   base.py37295%53–54
   celery_config.py17170%1–27
   celery_utils.py21210%1–30
   redis_config.py5260%8–9
app/constants
   jwt_utils.py161131%11–23
app/daos
   home.py10550%11–18
   users.py706211%12–133
app/middlewares
   cache_middleware.py51510%1–67
   rate_limiter_middleware.py25250%1–35
   request_id_injection.py17170%1–25
app/models
   __init__.py330%1–5
   users.py27270%1–38
app/routes
   __init__.py12120%1–15
app/routes/cache_router
   __init__.py330%1–5
   cache_samples.py12120%1–18
app/routes/celery_router
   __init__.py330%1–5
   celery_samples.py12120%1–17
app/routes/home
   __init__.py330%1–5
   home.py33330%1–45
app/routes/users
   __init__.py330%1–5
   users.py38380%1–57
app/schemas/users
   users_request.py42420%1–73
   users_response.py10100%1–14
app/sessions
   db.py53530%1–82
app/tests
   test_basic.py201525%10–34
   test_daos_home.py231057%15–22, 28–37, 41
   test_daos_users.py1109514%19–208
app/utils
   exception_handler.py19190%1–36
   redis_utils.py440%1–7
   slack_notification_utils.py14140%1–32
   user_utils.py25250%1–36
app/wrappers
   cache_wrappers.py26260%1–32
TOTAL82170414% 

Tests Skipped Failures Errors Time
2 0 💤 0 ❌ 2 🔥 0.828s ⏱️

Please sign in to comment.