I've installed Version 6.1.1 and sometimes got the following error:

SYMFONY_ENV=prod php bin/cachetool opcache:reset --web --web-path=/var/www/html/example.org/public --web-url=https://example.org

As you can see its a symfony webapplication. An Apache-VHost is configured with the DocumentRoot equal to /var/www/html/example.org/public.

Do you have any hint or suggestions? Its maybe the same issue as #145 .

Now trying to set the symlink target (which is the DocRoot) for --web-path

If the php-fpm systemd unit file has PrivateTmp=true and you run cachetool with this:

cachetool  opcache:status -vvv --fcgi /var/run/php-fpm/php-fpm.sock

then you see this in the logs (snipped to the relevant part):

[2015-01-06 20:55:05] cachetool.DEBUG: Executing code: return extension_loaded('Zend OPcache'); [] []
[2015-01-06 20:55:05] cachetool.INFO: FastCGI: Dumped code to file: /tmp/cachetool-54ac91f90c03f.php [] []
object(CacheTool\Code)#82 (1) {
  ["code":protected]=>
  array(1) {
    [0]=>
    string(40) "return extension_loaded('Zend OPcache');"
  }
}
[2015-01-06 20:55:05] cachetool.DEBUG: FastCGI: Response: {"statusCode":404,"headers":{"status":"404 Not Found","content-type":"text\/html; charset=UTF-8"},"body":"File not found.","stderr":"Primary script unknown\n"} [] []



  [RuntimeException]      
  Primary script unknown  

Even though we are invoking the cachetool during deployment to reset the PHP opcode cache, we encounter internal server errors after the symlink switch to the new release. The error disappears after a short while.

To verify that everything is basically working correct we have also put opcache:status before and after opcache:reset:

$ .../bin/cachetool opcache:status
+----------------------+---------------------------------+
| Name                 | Value                           |
+----------------------+---------------------------------+
| Enabled              | Yes                             |
| Cache full           | No                              |
| Restart pending      | No                              |
| Restart in progress  | No                              |
| Memory used          | 53.81 MiB                       |
| Memory free          | 74.19 MiB                       |
| Memory wasted (%)    | 0 b (0%)                        |
| Strings buffer size  | 16 MiB                          |
| Strings memory used  | 6.73 MiB                        |
| Strings memory free  | 9.27 MiB                        |
| Number of strings    | 335325                          |
+----------------------+---------------------------------+
| Cached scripts       | 1054                            |
| Cached keys          | 1372                            |
| Max cached keys      | 16229                           |
| Start time           | Fri, 12 Feb 2016 14:04:08 +0000 |
| Last restart time    | Tue, 16 Feb 2016 10:32:12 +0000 |
| Oom restarts         | 0                               |
| Hash restarts        | 0                               |
| Manual restarts      | 7                               |
| Hits                 | 8193                            |
| Misses               | 1073                            |
| Blacklist misses (%) | 0 (0%)                          |
| Opcache hit rate     | 88.420030218001                 |
+----------------------+---------------------------------+

$ .../bin/cachetool opcache:reset

$ .../bin/cachetool opcache:status
+----------------------+---------------------------------+
| Name                 | Value                           |
+----------------------+---------------------------------+
| Enabled              | Yes                             |
| Cache full           | No                              |
| Restart pending      | No                              |
| Restart in progress  | No                              |
| Memory used          | 20.87 MiB                       |
| Memory free          | 107.13 MiB                      |
| Memory wasted (%)    | 0 b (0%)                        |
| Strings buffer size  | 16 MiB                          |
| Strings memory used  |  452.05 KiB                     |
| Strings memory free  | 15.56 MiB                       |
| Number of strings    | 335325                          |
+----------------------+---------------------------------+
| Cached scripts       | 0                               |
| Cached keys          | 0                               |
| Max cached keys      | 16229                           |
| Start time           | Fri, 12 Feb 2016 14:04:08 +0000 |
| Last restart time    | Tue, 16 Feb 2016 12:08:43 +0000 |
| Oom restarts         | 0                               |
| Hash restarts        | 0                               |
| Manual restarts      | 8                               |
| Hits                 | 0                               |
| Misses               | 2                               |
| Blacklist misses (%) | 0 (0%)                          |
| Opcache hit rate     | 0                               |
+----------------------+---------------------------------+

While I'm not sure about the memory and string usage, scripts and keys are indeed removed as expected.

This is an environment with an Apache 2.4.10 and PHP 5.6.17 with PHP-FPM. The relevant part of the php.ini:

opcache.enable=1
opcache.memory_consumption=128
opcache.interned_strings_buffer=16
opcache.max_accelerated_files=8192
opcache.validate_timestamps=0
opcache.revalidate_freq=0

Any idea what could be wrong?

We use cachetool in our (automated) deploys. Once in a while this fails with a RuntimeException

FastCGI error: Not in white list. Check listen.allowed_clients.

It would be nice if cachetool could deal with this more gracefully (e.g. try again a few times and exit) instead of throwing an exception.

This happens on Ubuntu 16.04 + PHP 7.0.21

On PHP 8 command ./cachetool.phar opcache:reset results to the fatal error:

PHP Fatal error:  Declaration of Symfony\Component\DependencyInjection\ServiceLocator::has(string $id) must be compatible with Psr\Container\ContainerInterface::has($id) in phar:///home/longman/project/cachetool.phar/vendor/symfony/dependency-injection/ServiceLocator.php on line 46
PHP Stack trace:
PHP   1. {main}() /home/longman/project/cachetool.phar:0
PHP   2. require() /home/longman/project/cachetool.phar:14
PHP   3. CacheTool\Console\Application->run($input = *uninitialized*, $output = *uninitialized*) phar:///home/longman/project/cachetool.phar/bin/cachetool:26
PHP   4. CacheTool\Console\Application->doRun($input = class Symfony\Component\Console\Input\ArgvInput { private $tokens = [0 => 'opcache:reset']; private $parsed = []; protected $definition = class Symfony\Component\Console\Input\InputDefinition { private $arguments = [...]; private $requiredCount = 1; private $hasAnArrayArgument = FALSE; private $hasOptional = FALSE; private $options = [...]; private $shortcuts = [...] }; protected $stream = NULL; protected $options = []; protected $arguments = ['command' => 'opcache:reset']; protected $interactive = TRUE }, $output = class Symfony\Component\Console\Output\ConsoleOutput { private $stderr = class Symfony\Component\Console\Output\StreamOutput { private $stream = resource(134) of type (stream); private ${Symfony\Component\Console\Output\Output}verbosity = 32; private ${Symfony\Component\Console\Output\Output}formatter = class Symfony\Component\Console\Formatter\OutputFormatter { ... } }; private $consoleSectionOutputs = []; private ${Symfony\Component\Console\Output\StreamOutput}stream = resource(119) of type (stream); private ${Symfony\Component\Console\Output\Output}verbosity = 32; private ${Symfony\Component\Console\Output\Output}formatter = class Symfony\Component\Console\Formatter\OutputFormatter { private $decorated = TRUE; private $styles = [...]; private $styleStack = class Symfony\Component\Console\Formatter\OutputFormatterStyleStack { ... } } }) phar:///home/longman/project/cachetool.phar/vendor/symfony/console/Application.php:166
PHP   5. CacheTool\Console\Application->doRun($input = class Symfony\Component\Console\Input\ArgvInput { private $tokens = [0 => 'opcache:reset']; private $parsed = []; protected $definition = class Symfony\Component\Console\Input\InputDefinition { private $arguments = [...]; private $requiredCount = 1; private $hasAnArrayArgument = FALSE; private $hasOptional = FALSE; private $options = [...]; private $shortcuts = [...] }; protected $stream = NULL; protected $options = []; protected $arguments = ['command' => 'opcache:reset']; protected $interactive = TRUE }, $output = class Symfony\Component\Console\Output\ConsoleOutput { private $stderr = class Symfony\Component\Console\Output\StreamOutput { private $stream = resource(134) of type (stream); private ${Symfony\Component\Console\Output\Output}verbosity = 32; private ${Symfony\Component\Console\Output\Output}formatter = class Symfony\Component\Console\Formatter\OutputFormatter { ... } }; private $consoleSectionOutputs = []; private ${Symfony\Component\Console\Output\StreamOutput}stream = resource(119) of type (stream); private ${Symfony\Component\Console\Output\Output}verbosity = 32; private ${Symfony\Component\Console\Output\Output}formatter = class Symfony\Component\Console\Formatter\OutputFormatter { private $decorated = TRUE; private $styles = [...]; private $styleStack = class Symfony\Component\Console\Formatter\OutputFormatterStyleStack { ... } } }) phar:///home/longman/project/cachetool.phar/src/Console/Application.php:129
PHP   6. CacheTool\Console\Application->doRunCommand($command = class CacheTool\Command\OpcacheResetCommand { protected $container = NULL; private ${Symfony\Component\Console\Command\Command}application = class CacheTool\Console\Application { protected $config = class CacheTool\Console\Config { ... }; protected $logger = class Monolog\Logger { ... }; private ${Symfony\Component\Console\Application}commands = [...]; private ${Symfony\Component\Console\Application}wantHelps = FALSE; private ${Symfony\Component\Console\Application}runningCommand = ...; private ${Symfony\Component\Console\Application}name = 'CacheTool'; private ${Symfony\Component\Console\Application}version = '6.3.1'; private ${Symfony\Component\Console\Application}commandLoader = NULL; private ${Symfony\Component\Console\Application}catchExceptions = TRUE; private ${Symfony\Component\Console\Application}autoExit = TRUE; private ${Symfony\Component\Console\Application}definition = class Symfony\Component\Console\Input\InputDefinition { ... }; private ${Symfony\Component\Console\Application}helperSet = class Symfony\Component\Console\Helper\HelperSet { ... }; private ${Symfony\Component\Console\Application}dispatcher = NULL; private ${Symfony\Component\Console\Application}terminal = class Symfony\Component\Console\Terminal { ... }; private ${Symfony\Component\Console\Application}defaultCommand = 'list'; private ${Symfony\Component\Console\Application}singleCommand = FALSE; private ${Symfony\Component\Console\Application}initialized = TRUE; private ${Symfony\Component\Console\Application}signalRegistry = class Symfony\Component\Console\SignalRegistry\SignalRegistry { ... }; private ${Symfony\Component\Console\Application}signalsToDispatchEvent = [...] }; private ${Symfony\Component\Console\Command\Command}name = 'opcache:reset'; private ${Symfony\Component\Console\Command\Command}processTitle = NULL; private ${Symfony\Component\Console\Command\Command}aliases = []; private ${Symfony\Component\Console\Command\Command}definition = class Symfony\Component\Console\Input\InputDefinition { private $arguments = [...]; private $requiredCount = 0; private $hasAnArrayArgument = FALSE; private $hasOptional = FALSE; private $options = [...]; private $shortcuts = [...] }; private ${Symfony\Component\Console\Command\Command}hidden = FALSE; private ${Symfony\Component\Console\Command\Command}help = ''; private ${Symfony\Component\Console\Command\Command}description = 'Resets the contents of the opcode cache'; private ${Symfony\Component\Console\Command\Command}fullDefinition = NULL; private ${Symfony\Component\Console\Command\Command}ignoreValidationErrors = FALSE; private ${Symfony\Component\Console\Command\Command}code = NULL; private ${Symfony\Component\Console\Command\Command}synopsis = []; private ${Symfony\Component\Console\Command\Command}usages = []; private ${Symfony\Component\Console\Command\Command}helperSet = class Symfony\Component\Console\Helper\HelperSet { private $helpers = [...]; private $command = NULL } }, $input = class Symfony\Component\Console\Input\ArgvInput { private $tokens = [0 => 'opcache:reset']; private $parsed = []; protected $definition = class Symfony\Component\Console\Input\InputDefinition { private $arguments = [...]; private $requiredCount = 1; private $hasAnArrayArgument = FALSE; private $hasOptional = FALSE; private $options = [...]; private $shortcuts = [...] }; protected $stream = NULL; protected $options = []; protected $arguments = ['command' => 'opcache:reset']; protected $interactive = TRUE }, $output = class Symfony\Component\Console\Output\ConsoleOutput { private $stderr = class Symfony\Component\Console\Output\StreamOutput { private $stream = resource(134) of type (stream); private ${Symfony\Component\Console\Output\Output}verbosity = 32; private ${Symfony\Component\Console\Output\Output}formatter = class Symfony\Component\Console\Formatter\OutputFormatter { ... } }; private $consoleSectionOutputs = []; private ${Symfony\Component\Console\Output\StreamOutput}stream = resource(119) of type (stream); private ${Symfony\Component\Console\Output\Output}verbosity = 32; private ${Symfony\Component\Console\Output\Output}formatter = class Symfony\Component\Console\Formatter\OutputFormatter { private $decorated = TRUE; private $styles = [...]; private $styleStack = class Symfony\Component\Console\Formatter\OutputFormatterStyleStack { ... } } }) phar:///home/longman/project/cachetool.phar/vendor/symfony/console/Application.php:290
PHP   7. CacheTool\Console\Application->buildContainer($input = class Symfony\Component\Console\Input\ArgvInput { private $tokens = [0 => 'opcache:reset']; private $parsed = []; protected $definition = class Symfony\Component\Console\Input\InputDefinition { private $arguments = [...]; private $requiredCount = 1; private $hasAnArrayArgument = FALSE; private $hasOptional = FALSE; private $options = [...]; private $shortcuts = [...] }; protected $stream = NULL; protected $options = []; protected $arguments = ['command' => 'opcache:reset']; protected $interactive = TRUE }) phar:///home/longman/project/cachetool.phar/src/Console/Application.php:142
PHP   8. Composer\Autoload\ClassLoader->loadClass($class = 'Symfony\\Component\\DependencyInjection\\Container') phar:///home/longman/project/cachetool.phar/src/Console/Application.php:166
PHP   9. Composer\Autoload\includeFile($file = 'phar:///home/longman/project/cachetool.phar/vendor/composer/../symfony/dependency-injection/Container.php') phar:///home/longman/project/cachetool.phar/.box/vendor/composer/ClassLoader.php:322
PHP  10. include() phar:///home/longman/project/cachetool.phar/.box/vendor/composer/ClassLoader.php:444
PHP  11. class_exists($class = 'Symfony\\Component\\DependencyInjection\\Argument\\ServiceLocator') phar:///home/longman/project/cachetool.phar/vendor/symfony/dependency-injection/Container.php:29
PHP  12. Composer\Autoload\ClassLoader->loadClass($class = 'Symfony\\Component\\DependencyInjection\\Argument\\ServiceLocator') phar:///home/longman/project/cachetool.phar/vendor/symfony/dependency-injection/Container.php:29
PHP  13. Composer\Autoload\includeFile($file = 'phar:///home/longman/project/cachetool.phar/vendor/composer/../symfony/dependency-injection/Argument/ServiceLocator.php') phar:///home/longman/project/cachetool.phar/.box/vendor/composer/ClassLoader.php:322
PHP  14. include() phar:///home/longman/project/cachetool.phar/.box/vendor/composer/ClassLoader.php:444
PHP  15. Composer\Autoload\ClassLoader->loadClass($class = 'Symfony\\Component\\DependencyInjection\\ServiceLocator') phar:///home/longman/project/cachetool.phar/vendor/symfony/dependency-injection/Argument/ServiceLocator.php:21
PHP  16. Composer\Autoload\includeFile($file = 'phar:///home/longman/project/cachetool.phar/vendor/composer/../symfony/dependency-injection/ServiceLocator.php') phar:///home/longman/project/cachetool.phar/.box/vendor/composer/ClassLoader.php:322
PHP  17. include() phar:///home/longman/project/cachetool.phar/.box/vendor/composer/ClassLoader.php:444

Version of cachetool is 6.3.1

I'd like to monitor Memory free every two minutes.

It would be nice to have cachetool opcache:status --format=json

In WP-CLI there are:

– table – csv – json – yaml

On some systems it is not possible use the php-binary from path. Therefore it would be useful, to utilize the same php binary used to invoke the cachetool in the cli-adapters process. This PR makes it possible. It does not change the default behaviour, so if one uses the cachetool like …

cachetool.phar --cli opcache:reset (with cachetool.phar being executable) php cachetool.phar --cli opcache:reset (with explicit php-binary)

… the same php-binary will be used, as without this PR.

In my case I run cachetool like …

/opt/local/bin/php72 cachetool.phar --cli opcache:reset

… and without this PR, it fails because there is a php-binary in PATH (/usr/bin/php), which does not have the Opcache enabled. And actually it would be wrong to clear the opcache in this binaries context.

I appreciate any Feedback on this … Cheers, Stephan

I'm a bit baffled by this.

CacheTool: 8.4.0 PHP: 8.1.5

Running the command with arguments cachetool opcache:status --fcgi=127.0.0.1:9000 works as expected but as soon as I use a .cachetool.yml I always get an error:

In FastCGI.php line 114:

  Error: File not found.

This is my .cachetool.yml:

adapter: fastcgi
fastcgi: 127.0.0.1:9000

Without any .cachetool.yml:

$ cachetool opcache:status --fcgi=127.0.0.1:9000
+----------------------+---------------------------------+
| Name                 | Value                           |
+----------------------+---------------------------------+
| Enabled              | Yes                             |
| Cache full           | No                              |
| Restart pending      | No                              |
| Restart in progress  | No                              |
| Memory used          | 106.33 MiB                      |
| Memory free          | 21.67 MiB                       |
| Memory wasted (%)    | 0 b (0%)                        |
| Strings buffer size  | 6 MiB                           |
| Strings memory used  | 6 MiB                           |
| Strings memory free  | 0 b                             |
| Number of strings    | 53224                           |
+----------------------+---------------------------------+
| Cached scripts       | 3424                            |
| Cached keys          | 6742                            |
| Max cached keys      | 16229                           |
| Start time           | Wed, 11 May 2022 11:02:52 +0100 |
| Last restart time    | Never                           |
| Oom restarts         | 0                               |
| Hash restarts        | 0                               |
| Manual restarts      | 0                               |
| Hits                 | 67059                           |
| Misses               | 3434                            |
| Blacklist misses (%) | 0 (0%)                          |
| Opcache hit rate     | 95.128594328515                 |
+----------------------+---------------------------------+

With the .cachetool.yml as described above:

$ cachetool opcache:status

In FastCGI.php line 114:

  Error: File not found.


opcache:status

You get a 404 on the fastgi response because it doesn't have the permission to read the cachetool generated file.

I'm not sure if this is really solvable without changing selinux configuration, but i do wonder if the stdin option of the fastcgi client would fix it.

Can you think of a quick hack to try that out?

after instalation cachetool via dockerfile (php:8.1-fpm)

&& curl --fail -sOL https://gordalina.github.io/cachetool/downloads/cachetool-8.0.2.phar && chmod +x cachetool-8.0.2.phar && mv cachetool-8.0.2.phar /usr/local/bin/cachetool \

it shows deprecated messages:

Deprecated: Return type of HumbugBox3100\KevinGH\RequirementChecker\RequirementCollection::getIterator() should either be compatible with IteratorAggregate::getIterator(): Traversable, or the #[\ReturnTypeWillChange] attribute should be used to temporarily suppress the notice in phar:///usr/local/bin/cachetool/.box/src/RequirementCollection.php on line 12

Deprecated: Return type of HumbugBox3100\KevinGH\RequirementChecker\RequirementCollection::count() should either be compatible with Countable::count(): int, or the #[\ReturnTypeWillChange] attribute should be used to temporarily suppress the notice in phar:///usr/local/bin/cachetool/.box/src/RequirementCollection.php on line 16

Hi

I use the symfony/dependency-injection on my project using Symfony 5.3, which is locked in composer.lock to "version": "v5.3.0" This packages requires psr/container ^1.1.1

Due to recent changes in the composer.json of gordalina/cachetool, I cannot require it in the project since the two packages require different versions of psr/container

  Problem 1
    - Root composer.json requires gordalina/cachetool ^6.5 -> satisfiable by gordalina/cachetool[6.5.0].
    - gordalina/cachetool 6.5.0 requires psr/container 1.0.0 -> found psr/container[1.0.0] but the package is fixed to 1.1.1 (lock file version) by a partial update and that version does not match. Make sure you list it as an argument for the update command.

Is there any fix that you can push to make it work ? Thanks!

• Using parsed valued via getOption where possible
• Merge flags with preset value consistently
• Use VALUE_NONE for option --web-allow-insecure which does not allow for a value to be set.

In case sslip.io DNS is not configured correctly on the running host the tests will fail, skip instead in this case as the failure would not be related to a failing code but dependend on the running hosts DNS configuration.

On some hosters' storage systems it happens that although the cache busting PHP file is created fine, the subsequent access via HTTP fails (404).

This PR is to explore possiblities how to make cachetool more resilient against that.

The first step is just to see if sleep() between creation and HTTP-accessing would help. Of course that would have to be configurable if that approach is chosen.

Other possiblities might be to retry $this->http->fetch() some times (maybe each second or so, max. 5 tries?).

If others want to try that in their pipelines: In a composer project, the easiest is to install cweagans/composer-patches and configure by:

"extra": {
  "patches": {
    "gordalina/cachetool": {
      "Try fixing race conditions between --web file creation and HTTP access": "https://patch-diff.githubusercontent.com/raw/gordalina/cachetool/pull/210.patch"
    }
  }
}

The patch applies to v7 and v8.

I am happy to get feedback.

Relates: #209

With the --web adapter it happens that we get 404 because it might be just too fast for some hosters to create the file and access it through the web near-instantaneously. I guess this is related to their storage and file system caches, maybe also PHP stat cache?

Current workaround: It will usually succeed after some tries...

./cachetool stat:clear --web=SymfonyHttpClient --web-url=https://.../ --web-path=./public/ --web-host

It is currently holding us a bit back on systems where we can't use --fcgi.

Splitting this off from #199 which is about retrying the whole procedure which can probably mostly be avoided in this case.

Hello,

Wouldn't it be better to have in composer.json just PHP version dependancy? And deal with everything else via phar. Similar to https://github.com/phpstan/phpstan.

I would like to install it via composer but sometimes I have dependencies in my project which conflicts with those in cachetool. Then I need to install it via

curl -sLO https://github.com/gordalina/cachetool/releases/latest/download/cachetool.phar
chmod +x cachetool.phar

but I'm losing PHP version check.

Thank you.