PageSpeed Admin Pages

The admin pages are a collection of features that provide visibility into the operation of the PageSpeed optimizations.

Note: New feature as of 1.8.31.2

The pagespeed_admin and pagesped_global_admin pages aggregate a set of pages showing server state so they can be accessed from a single handler. By organizing all these features under a single admin page, this can be done once, and can serve as a launching point for future administration features. As of version 1.8.31.2, the admin pages are read-only, but starting in version 1.9.32.1, cache purging is supported.

The name of the currently active page is underlined in the top navigation bar.

Before 1.8.31.2, the main admin page is not available, but there are page-specific handlers for statistics, messages, and the console. In 1.8.31.2 and later, the *_pagespeed_* handlers, such as mod_pagespeed_statistics, will continue to be supported:

• They provide read-only access to server operation. There may be cases where a site owner wants to share statistics or console information but not the ability to purge the cache.
• Existing configurations must continue to work after an upgrade to a release that supports pagespeed_admin.
• The admin pages may later gain support for modifying the server state

Configuring Admin Pages

In this table we use the term "server" for an Apache VirtualHost and an nginx Server Block. We use the term "global" to mean the entire Apache or nginx system, covering all the configured VirtualHost and Server Blocks.

Establishing Handlers in Apache

Each handler is optional; add them individually to enable admin features. Note that when you add handlers for pagespeed_admin and pagespeed_global_admin you are granting read/write access to server-state. The other handlers are read-only. A sample handler that filters on IP address is in the default configuration, whose general form is:

<Location /PATH>
   Order allow,deny
   Allow from localhost
   Allow from 127.0.0.1
   SetHandler HANDLER_NAME
</Location>

You can choose any path for a handler, but you must specify the handler name exactly as it appears in the table above. By convention we use use the handler name for the path. You may also want to employ login-based access to the admin pages, using AllowOverride AuthConfig. Please see the Apache 2.2 or 2.4 Documentation for details.

Establishing Handlers in Nginx

In nginx, the handlers must be specified as location blocks.

location /ngx_pagespeed_statistics { allow 127.0.0.1; deny all; }
location /ngx_pagespeed_global_statistics { allow 127.0.0.1; deny all; }
location /ngx_pagespeed_message { allow 127.0.0.1; deny all; }
location /pagespeed_console { allow 127.0.0.1; deny all; }
location ~ ^/pagespeed_admin { allow 127.0.0.1; deny all; }
location ~ ^/pagespeed_global_admin { allow 127.0.0.1; deny all; }

Note that these handlers must precede the "\.pagespeed\.([a-z]\.)?[a-z]{2}\.[^.]{10}\.[^.]+" location block.

In version 1.8.31.2 and later, the above location blocks are needed for each path you elect to enable in PageSpeed options:

pagespeed StatisticsPath /ngx_pagespeed_statistics;
pagespeed GlobalStatisticsPath /ngx_pagespeed_global_statistics;
pagespeed MessagesPath /ngx_pagespeed_message;
pagespeed ConsolePath /pagespeed_console;
pagespeed AdminPath /pagespeed_admin;
pagespeed GlobalAdminPath /pagespeed_global_admin;

You can choose any path, as long as it's consistent between the pagespeed Path and the location. By convention we use the names as specified in the example.

Prior to version 1.8.31.2, the above "Path" settings do not exist, and the failure to specify location blocks leaves the paths active with no access restrictions. The module will service requests to the paths whether the location blocks are specified or not. This applies to /ngx_pagespeed_statistics, /ngx_pagespeed_global_statistics, /ngx_pagespeed_message, and /pagespeed_console.

If you define access control for /pagespeed_admin or /pagespeed_console, you must do so earlier in the configuration file than the path to handle .pagespeed resources, to ensure that the handlers are disambiguated.

Shared Memory Statistics

By default PageSpeed collects cross-process statistics. While they're mostly intended for debugging and evaluation using /mod_pagespeed_statistics, /ngx_pagespeed_statistics, and the PageSpeed Console, statistics are also necessary for limiting concurrent image rewrites and background fetches. It's not recommended to turn them off, as their performance impact is minimal, but if you need to you can do so with:

Apache:

ModPagespeedStatistics off

Nginx:

pagespeed Statistics off;

Virtual hosts and statistics

Note: New feature as of 1.1.23.1

You can choose whether PageSpeed aggregates its statistics over all virtual hosts (the default), or to keeps separate counts for each. You can chose the latter by specifying UsePerVHostStatistics on. In that case, /pagespeed_admin, /mod_pagespeed_statistics and /ngx_pagespeed_statistics will show the data for whatever virtual host is being accessed. If you do turn per-virtual host statistics on, you can still access the aggregates under /pagespeed_global_admin, /mod_pagespeed_global_statistics or /ngx_pagespeed_global_statistics.

Apache:

ModPagespeedUsePerVhostStatistics on

Nginx:

pagespeed UsePerVhostStatistics on;

Message Buffer Size

Determines the number of bytes of shared memory to allocate as a circular buffer for holding recent PageSpeed log messages. By default, the size of this buffer is zero, and no messages will be retained.

Apache:

ModPagespeedMessageBufferSize 100000

Nginx:

pagespeed MessageBufferSize 100000;

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.