{"id":24761670,"url":"https://github.com/driebit/puppet-xhgui","last_synced_at":"2026-05-06T00:33:39.649Z","repository":{"id":11950757,"uuid":"14521377","full_name":"driebit/puppet-xhgui","owner":"driebit","description":"A Puppet module that installs and configures XHGui","archived":false,"fork":false,"pushed_at":"2014-06-24T08:45:57.000Z","size":232,"stargazers_count":1,"open_issues_count":0,"forks_count":4,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-01-28T19:18:38.942Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Puppet","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/driebit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-11-19T10:35:48.000Z","updated_at":"2014-06-24T08:45:57.000Z","dependencies_parsed_at":"2022-09-11T14:12:14.640Z","dependency_job_id":null,"html_url":"https://github.com/driebit/puppet-xhgui","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/driebit%2Fpuppet-xhgui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/driebit%2Fpuppet-xhgui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/driebit%2Fpuppet-xhgui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/driebit%2Fpuppet-xhgui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/driebit","download_url":"https://codeload.github.com/driebit/puppet-xhgui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245104527,"owners_count":20561380,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-28T19:18:40.415Z","updated_at":"2026-05-06T00:33:39.632Z","avatar_url":"https://github.com/driebit.png","language":"Puppet","funding_links":[],"categories":[],"sub_categories":[],"readme":"driebit/puppet-xhgui\n====================\n\nIntroduction\n-----------\nA Puppet module that installs [XHGui](https://github.com/perftools/xhgui),\na MongoDB-backed GUI for [XHProf](https://github.com/facebook/xhprof).\n\nConfiguration\n-------------\n\n### Requirements\n\n* [Vcsrepo Puppet module](https://github.com/puppetlabs/puppetlabs-vcsrepo)\n* [Composer Puppet module](https://forge.puppetlabs.com/tPl0ch/composer)\n\n### Puppet configuration\n\nIn your Puppet manifest:\n\n```puppet\nclass { 'xhgui': }\n```\n\nYou can set the following parameters:\n\n* `version`: either a tagged version or a commit hash to install; defaults to\n  `master`\n* `sample_size`: see below (defaults to `100`)\n* `query_trigger`: a URL query string that will enable profiling for the request\n  (disabled by default)\n* `dir`: directory where to install XHGui; defaults to `/var/www/xhgui/{version}`\n* `vhost_name`: used to create an Apache vhost; if you want no vhost, set this\n  to `undef`\n* `mongo_host`: host your MongoDB server can be reached at; defaults to `127.0.0.1:27017`\n* `mongo_db`: MongoDB database name; defaults to `xhprof`\n* `xhprof_package`: custom XHProf package name\n* `php_mongo_package`: custom PHP MongoDB module name\n* `www_user`: custom webserver user\n\nFor instance:\n\n```puppet\nclass { 'xhgui':\n  vhost_name        =\u003e 'stats.my_app.dev',\n  php_mongo_package =\u003e 'php53u-pecl-mongo'\n}\n```\n\nIn your application's Virtual host configuration (for instance the `.htaccess` file):\n\n```apache\nphp_value auto_prepend_file \"/var/www/xhgui/external/header-custom.php\"\nSetEnv XHGUI_SAMPLE_SIZE 100\n```\n\nThe `XHGUI_SAMPLE_SIZE` environment variable determines how often requests will\nbe profiled: a sample size of 100 means one in every 100 requests will be\nprofiled. To profile all requests, set `XHGUI_SAMPLE_SIZE` to 1.\n\nUsage\n-----\n\n### Web interface\n\nBy default, you can access XHGui at http://xhgui.domain.extension.\n\n### Trigger profiling by query string\n\nEnable the query string trigger in your Puppet manifest:\n\n```puppet\nclass { 'xhgui':\n    # ...\n    query_trigger =\u003e 'profile'\n    # ...\n}\n```\n\nAnd then request the URI with your query string, e.g., http://dev.local/some/url?profile.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdriebit%2Fpuppet-xhgui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdriebit%2Fpuppet-xhgui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdriebit%2Fpuppet-xhgui/lists"}