minimal readme and enable cache analysis

Signed-off-by: Ava Hahn <a.hahn@f5.com>
This commit is contained in:
Ava Hahn 2025-08-25 16:52:27 -07:00
parent 6d9a140407
commit 5aeb2c7792
2 changed files with 19 additions and 0 deletions

18
README.md Normal file
View file

@ -0,0 +1,18 @@
# Profiling Setup
This is a script that uses a docker-compose environment with custom NGINX
configuration to profile NGINX for CPU and Memory costly calls.
### Dependencies
The following must be installed and configured on your system.
- Valgrind
- Callgrind
- Docker
- Docker Compose
- Rsync
- Go
### Use
Call run.sh like so:
```
$ run.sh ./path/to/nginx/source/directory
```

View file

@ -5,6 +5,7 @@ function p_invoke() {
valgrind --tool=callgrind \ valgrind --tool=callgrind \
--trace-children=no \ --trace-children=no \
--callgrind-out-file=/tmp/callgrind.output \ --callgrind-out-file=/tmp/callgrind.output \
--cache-sim=yes \
/nginx/objs/nginx \ /nginx/objs/nginx \
-p /tmp \ -p /tmp \
-e /tmp/error.log \ -e /tmp/error.log \