Webgrind Docker Container Image

https://github.com/wodby/webgrind
Admin
Webgrind is a Docker container image that provides a web-based PHP profiler interface for analyzing...
Tokens:3,273
Snippets:34
Trust Score:8.5
License:MIT
Update:5 months ago
Show doc for...
Tokens:
Raw
### Start Container Command

Source: https://context7.com/wodby/webgrind/llms.txt

The underlying Docker command executed by `make start` to launch the Webgrind container with specified ports and volumes.

```bash
# docker run -d --name webgrind-1.9.4 -p 8080:8080 -v /tmp/profiles:/tmp wodby/webgrind:1.9.4
```

--------------------------------

### Webgrind Configuration Template Example

Source: https://context7.com/wodby/webgrind/llms.txt

An example of the generated `config.php` file, showing how environment variables are mapped to Webgrind configuration settings. This includes paths, timezone, and source file linking formats.

```php
// Rendered config.php (example output with custom env vars)
class Webgrind_Config extends Webgrind_MasterConfig {
    static $storageDir   = '/tmp/webgrind-storage';
    static $profilerDir  = '/tmp';                     // from WEBGRIND_PROFILER_DIR
    static $graphImageType = 'svg';                    // SVG call graphs via Graphviz
    static $defaultTimezone = 'America/New_York';      // from WEBGRIND_DEFAULT_TIMEZONE
    static $defaultCostformat = 'percent';             // 'percent', 'usec', or 'msec'
    static $defaultFunctionPercentage = 90;            // show top 90% of cost by default
    static $dotExecutable = '/usr/bin/dot';            // Graphviz dot binary
    static $pythonExecutable = '/usr/bin/python3';

    // Source file viewer: links in the UI open the built-in file viewer
    static $fileUrlFormat = 'index.php?op=fileviewer&file=%1$s#line%2$d';
    // Alternatively, link directly to VSCode:
    // static $fileUrlFormat = 'vscode://file/%1$s:%2$d';

    // Map profiled app paths to mounted source paths
    static function exposeServerFile($file) {
        $orig   = '/var/www/html';        // WEBGRIND_ORIG_CODEBASE_PATH
        $mounted = '/mnt/codebase';       // WEBGRIND_MOUNTED_CODEBASE_PATH
        if (substr($file, 0, strlen($orig)) === $orig) {
            return str_replace($orig, $mounted, $file);
        }
        return false;
    }
}

```

--------------------------------

### Start Webgrind Container

Source: https://context7.com/wodby/webgrind/llms.txt

Start the Webgrind container in detached mode, mapping a host port to the container's port and mounting a volume for profile data.

```makefile
make start PORTS="-p 8080:8080" VOLUMES="-v /tmp/profiles:/tmp"
```

--------------------------------

### Test Script Internals

Source: https://context7.com/wodby/webgrind/llms.txt

Illustrates the internal commands executed by the `make test` command, including starting the container and checking its readiness via HTTP.

```bash
# Internally runs: cd ./tests && IMAGE=wodby/webgrind:1.9.4 NAME=webgrind-1.9.4 ./run.sh

# tests/run.sh starts the container and checks readiness:
# docker run -d --name webgrind-1.9.4 wodby/webgrind:1.9.4
# docker run --rm -i --link webgrind-1.9.4:webgrind wodby/webgrind:1.9.4 \
#   make check-ready max_try=5 host=webgrind
#
# check-ready verifies HTTP 200 from http://webgrind:8080
# curl -s -o /dev/null -I -w '%{http_code}' webgrind:8080 | grep -q 200
```

--------------------------------

### Run Tests for Locally Built Image

Source: https://context7.com/wodby/webgrind/llms.txt

Execute the test suite against a locally built Docker image. This command internally runs a script that starts the container and performs an HTTP health check.

```bash
make test
```

--------------------------------

### Build Webgrind Docker Image Locally

Source: https://context7.com/wodby/webgrind/llms.txt

Build the Webgrind Docker image locally using `make`. Supports default builds, specific PHP versions, and multi-platform builds with `docker buildx`.

```bash
# Default single-platform build (linux/amd64)
make build
# Equivalent to:
# docker build -t wodby/webgrind:1.9.4 \
#   --build-arg BASE_IMAGE_TAG=8.2 \
#   --build-arg WEBGRIND_VER=1.9.4 ./

```

```bash
# Build for a specific PHP version
make build PHP_VER=8.3

```

```bash
# Multi-platform build (amd64 + arm64) — does not load locally
make buildx-build PLATFORM=linux/amd64,linux/arm64

```

--------------------------------

### Configure Webgrind with Environment Variables

Source: https://context7.com/wodby/webgrind/llms.txt

Run the Webgrind container with custom environment variables to configure profiler directory, storage, timezone, and codebase paths. Mounts are used for profiler data and application source code.

```bash
docker run -d \
  --name webgrind \
  -p 8080:8080 \
  -e WEBGRIND_PROFILER_DIR=/tmp \
  -e WEBGRIND_STORAGE_DIR=/tmp/webgrind-storage \
  -e WEBGRIND_DEFAULT_TIMEZONE=America/New_York \
  -e WEBGRIND_ORIG_CODEBASE_PATH=/var/www/html \
  -e WEBGRIND_MOUNTED_CODEBASE_PATH=/mnt/codebase \
  -v /var/xdebug/profiles:/tmp \
  -v /path/to/app/source:/mnt/codebase:ro \
  wodby/webgrind:1.9-4.68.5
```

--------------------------------

### Build and Release Docker Image

Source: https://context7.com/wodby/webgrind/llms.txt

Build the Docker image and push it to Docker Hub with specific version and stability tags. Ensure you are authenticated to Docker Hub before running.

```makefile
make release TAG=1.9 STABILITY_TAG=4.68.5
```

--------------------------------

### Pull and Run Webgrind Docker Image

Source: https://context7.com/wodby/webgrind/llms.txt

Pull the latest stable Webgrind image and run a container, mounting a local directory for Xdebug profiler output. Access the UI via http://localhost:8080.

```bash
docker pull wodby/webgrind:1.9-4.68.5
```

```bash
docker run -d \
  --name webgrind \
  -p 8080:8080 \
  -v /path/to/xdebug/profiles:/tmp \
  wodby/webgrind:1.9-4.68.5
```

```bash
open http://localhost:8080
```

--------------------------------

### Build Docker Image with Custom Version

Source: https://context7.com/wodby/webgrind/llms.txt

Build the Docker image for Webgrind, specifying a custom version. This is useful for development or testing specific releases.

```makefile
make build WEBGRIND_VER=1.9.3
```

--------------------------------

### GitHub Actions Workflow Configuration

Source: https://context7.com/wodby/webgrind/llms.txt

A simplified GitHub Actions workflow configuration for automatically building, testing, and pushing multi-platform Webgrind Docker images on code pushes or tag creations.

```yaml
# .github/workflows/workflow.yml (simplified)
jobs:
  webgrind-1:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: docker/setup-qemu-action@v3
        with:
          platforms: amd64,arm64
      - uses: docker/setup-buildx-action@v3
      - uses: ./.github/actions
        with:
          version: '1.9.4'
          tags: 1.9,1,latest
          platform: linux/amd64,linux/arm64
```

--------------------------------

### Tail Container Logs

Source: https://context7.com/wodby/webgrind/llms.txt

View the logs of the Webgrind container in real-time. This is essential for monitoring the application and troubleshooting issues.

```makefile
make logs
```

--------------------------------

### Open Interactive Shell in Container

Source: https://context7.com/wodby/webgrind/llms.txt

Access an interactive shell within the running Webgrind container. This is useful for debugging or manual inspection.

```makefile
make shell PORTS="-p 8080:8080" VOLUMES="-v /tmp/profiles:/tmp"
```

--------------------------------

### Docker Compose for PHP Application Integration

Source: https://context7.com/wodby/webgrind/llms.txt

A Docker Compose configuration to run a PHP application alongside Webgrind. It sets up Xdebug profiling in the PHP container and mounts the output directory to Webgrind.

```yaml
# docker-compose.yml
version: '3.8'
services:
  php:
    image: wodby/php:8.2
    environment:
      PHP_XDEBUG: 1
      PHP_XDEBUG_MODE: profile
      PHP_XDEBUG_OUTPUT_DIR: /tmp/xdebug
    volumes:
      - ./src:/var/www/html
      - xdebug_profiles:/tmp/xdebug

  webgrind:
    image: wodby/webgrind:1.9-4.68.5
    ports:
      - "8080:8080"
    environment:
      WEBGRIND_PROFILER_DIR: /tmp/xdebug
      WEBGRIND_DEFAULT_TIMEZONE: UTC
      WEBGRIND_ORIG_CODEBASE_PATH: /var/www/html
      WEBGRIND_MOUNTED_CODEBASE_PATH: /mnt/codebase
    volumes:
      - xdebug_profiles:/tmp/xdebug
      - ./src:/mnt/codebase:ro

volumes:
  xdebug_profiles:

# Usage:
# 1. Make an HTTP request to your PHP app — Xdebug writes cachegrind.out.* to the shared volume
# 2. Open http://localhost:8080 to view and analyze the profiler output
```

--------------------------------

### Stop Webgrind Container

Source: https://context7.com/wodby/webgrind/llms.txt

Stop the running Webgrind container gracefully.

```makefile
make stop
```

--------------------------------

### Remove Webgrind Container

Source: https://context7.com/wodby/webgrind/llms.txt

Remove the Webgrind container and its associated resources. This is typically done after stopping the container.

```makefile
make clean
```
Tokens:
Raw