https://github.com/davidjeddy/php_flame_graph
https://github.com/davidjeddy/php_flame_graph
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/davidjeddy/php_flame_graph
- Owner: davidjeddy
- License: other
- Created: 2023-07-04T11:44:03.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-05T07:44:51.000Z (over 1 year ago)
- Last Synced: 2025-01-16T11:32:47.616Z (5 months ago)
- Language: PHP
- Size: 294 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING_GUIDELINES.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# PHP Flame Graphs
## Purpose
Project implementing flame graph visualization for PHP via xDebug traces.
## Table of Contents
- [PHP Flame Graphs](#php-flame-graphs)
- [Purpose](#purpose)
- [Table of Contents](#table-of-contents)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Contributing Guidelines](#contributing-guidelines)
- [Development Documentation](#development-documentation)
- [Requirements](#requirements)
- [How to](#how-to)
- [Acquire](#acquire)
- [Build](#build)
- [Configure](#configure)
- [Execute](#execute)
- [Terminate](#terminate)
- [Development Resources](#development-resources)
- [Versioning](#versioning)
- [Contributors](#contributors)
- [Additional Information](#additional-information)
## Contributing
### Code of Conduct
Please see [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
### Contributing Guidelines
Please see [CONTRIBUTING_GUIDELINES.md](./CONTRIBUTING_GUIDELINES.md).
### Development Documentation
Please see [DEVDOCS.md](./DEVDOCS.md).
## Requirements
- Linux/Unix shell
- container orchestration solution (Docker, Podman, ContainerD)
- [podman](https://podman.io/) and [podman-compose](https://github.com/containers/podman-compose) recommended
## How to
### Acquire
```sh
cd /path/to/your/projects
mkdir -p github.com/davidjeddy/php_flame_graph
cd github.com/davidjeddy/php_flame_graph
git clone https://github.com/davidjeddy/php_flame_graph.git .
git clone https://github.com/brendangregg/FlameGraph.git ./services/shared/var/www/html/brendangregg/FlameGraph
# (As needed)
# If a Podman machine is already running we need to restart to enable the volume mounts
podman machine stop || true
podman machine start
podman-compose up -d
```
### Build
```sh
podman-compose up -d
```
### Configure
No configuration needed.
### Execute
Generate some traffic
```sh
# request
curl --head "http://localhost:8080/?XDEBUG_TRIGGER=1"
# response
HTTP/1.1 200 OK
Server: nginx/1.25.1
Date: Tue, 04 Jul 2023 19:21:26 GMT
Content-Type: text/html; charset=UTF-8
Connection: keep-alive
X-Powered-By: PHP/8.2.7
X-Xdebug-Profile-Filename: /tmp/xdebug.profilel.2373089536-1688498486
# request
curl --head "http://localhost:8080/?XDEBUG_TRIGGER=1"
# response
HTTP/1.1 200 OK
Server: nginx/1.25.1
Date: Tue, 04 Jul 2023 19:21:27 GMT
Content-Type: text/html; charset=UTF-8
Connection: keep-alive
X-Powered-By: PHP/8.2.7
X-Xdebug-Profile-Filename: /tmp/xdebug.profilel.2373089536-1688498487
# request
curl --head "http://localhost:8080/?XDEBUG_TRIGGER=1"
# response
HTTP/1.1 200 OK
Server: nginx/1.25.1
Date: Tue, 04 Jul 2023 19:21:28 GMT
Content-Type: text/html; charset=UTF-8
Connection: keep-alive
X-Powered-By: PHP/8.2.7
X-Xdebug-Profile-Filename: /tmp/xdebug.profilel.2373089536-1688498488
```
Now we can view the traces by opening the browser and visiting `http://localhost:8080/graph.php`.
### Terminate
```sh
podman-compose down
```
## Development Resources
- https://gist.github.com/xameeramir/a5cb675fb6a6a64098365e89a239541d
## Versioning
This project follows [SemVer 2.0](https://semver.org/).
```quote
Given a version number MAJOR.MINOR.PATCH, increment the:
1. MAJOR version when you make incompatible API changes,
2. MINOR version when you add functionality in a backwards compatible manner, and
3. PATCH version when you make backwards compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
```
## Contributors
- [davidjeddy](https://github.com/davidjeddy)
## Additional Information
- Adding visual aids to any / all the above sections above is recommended.
- [Contributes](##Contributors) sources from [all-contributors](https://github.com/all-contributors/all-contributors).
- Based on [README Maturity Model](https://github.com/LappleApple/feedmereadmes/blob/master/README-maturity-model.md); strive for a Level 5 `Product-oriented README`.
- This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
- [CONTRIBUTING.md](./CONTRIBUTING.md) is based on the [Ruby on Rails Contributing](https://github.com/rails/rails/blob/master/CONTRIBUTING.md) document, credit is due to them.
- [LICENSE](./LICENSE.md) sources from:
- [https://choosealicense.com](https://choosealicense.com)
- [https://en.wikipedia.org/wiki/All_rights_reserved](https://en.wikipedia.org/wiki/All_rights_reserved)