Skip to content

Commit c18b15a

Browse files
committed
docs: tune readme file
1 parent 291b9d2 commit c18b15a

File tree

1 file changed

+31
-8
lines changed

1 file changed

+31
-8
lines changed

README.MD

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,33 @@
1-
**aws-client-monitor** is created for analysing locally running applications that are interacting with **AWS**.
1+
## AWS Client Monitor
22

3-
Very useful on local development, troubleshooting or profiling 3rd party apps.
3+
AWS Client Monitor is a tool designed to analyze applications interacting with AWS services. It's particularly useful during local development, troubleshooting, or profiling third-party applications.
44

5-
Setup is simple:
5+
## Features
6+
- Real-time Monitoring: Capture and display AWS API invocations from your applications in real-time.
7+
- Easy Integration: Minimal setup required; configure environment variables, and you're ready to go.
8+
- Dockerized Deployment: Run the monitor effortlessly using Docker.
69

7-
1. for each app set following environment variables:
10+
## Prerequisites
11+
Docker: Ensure Docker is installed on your system.
12+
13+
14+
## Setup Instructions
15+
16+
1. Configure Your Application: Set the following environment variables in each application you wish to monitor:
817

918
```shell
1019
export AWS_CSM_ENABLED=true
1120
export AWS_CSM_CLIENT_ID=my-app-service-name
1221
```
1322

1423
Optional:
24+
1525
```shell
1626
export AWS_CSM_HOST=127.0.0.1
1727
export AWS_CSM_PORT=31000
1828
```
1929

20-
2. Start ``aws-client-monitor``
30+
2. Start AWS Client Monitor: Run the monitor using Docker:
2131

2232
```shell
2333
docker run -p 8080:8080 -p 31000:31000/udp rtsypuk/aws-client-monitor:development
@@ -36,9 +46,22 @@ export AWS_CSM_PORT=31000
3646
2024-12-22 16:35:27 UTC [Client:subscirption-service(aws-cli/1.27.92 md/Botoco) ==========> AWS:Lambda:ListFunctions] : 226ms eu-west-1 Code:403
3747

3848
```
49+
3. Access the Dashboard: Open your browser and navigate to http://localhost:8080 to view the monitoring dashboard.
50+
51+
![ui_screen.png](ui.png)
52+
53+
## How It Works
54+
55+
Once your applications are configured and the monitor is running, any AWS SDK calls made by your applications will be captured and displayed in the AWS Client Monitor dashboard. This provides visibility into the AWS API interactions of your applications, aiding in development and troubleshooting.
56+
57+
## Contributing
58+
59+
Contributions are welcome! Feel free to open issues or submit pull requests to enhance the functionality of AWS Client Monitor.
60+
61+
## License
3962

40-
## Browser UI-based mode:
63+
This project is licensed under the MIT License. See the LICENSE file for details.
4164

42-
Information is also available on UI (http://localhost:8080)
65+
## Note:
4366

44-
![ui_screen.png](ui.png)
67+
This project is not affiliated with AWS. Use it responsibly and ensure it complies with your organization's security policies.

0 commit comments

Comments
 (0)