You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.MD
+31-8Lines changed: 31 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff 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
2
2
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.
4
4
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.
6
9
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:
8
17
9
18
```shell
10
19
export AWS_CSM_ENABLED=true
11
20
export AWS_CSM_CLIENT_ID=my-app-service-name
12
21
```
13
22
14
23
Optional:
24
+
15
25
```shell
16
26
export AWS_CSM_HOST=127.0.0.1
17
27
export AWS_CSM_PORT=31000
18
28
```
19
29
20
-
2. Start ``aws-client-monitor``
30
+
2. Start AWS Client Monitor: Run the monitor using Docker:
21
31
22
32
```shell
23
33
docker run -p 8080:8080 -p 31000:31000/udp rtsypuk/aws-client-monitor:development
3. Access the Dashboard: Open your browser and navigate to http://localhost:8080 to view the monitoring dashboard.
50
+
51
+

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
39
62
40
-
## Browser UI-based mode:
63
+
This project is licensed under the MIT License. See the LICENSE file for details.
41
64
42
-
Information is also available on UI (http://localhost:8080)
65
+
## Note:
43
66
44
-

67
+
This project is not affiliated with AWS. Use it responsibly and ensure it complies with your organization's security policies.
0 commit comments