Skip to content

Commit 29ead51

Browse files
Document that telemetry is not available on Windows.
Add notes to the WSGITelemetryService, WSGISlowRequests and WSGITelemetryOptions directive references and the external telemetry service user guide, matching how the daemon mode directives already document their unavailability on Windows.
1 parent 0f6ac6d commit 29ead51

4 files changed

Lines changed: 24 additions & 0 deletions

File tree

docs/configuration-directives/WSGISlowRequests.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ Setting ``WSGISlowRequests`` without ``WSGITelemetryService`` is
2727
not treated as a configuration error: the per-request bookkeeping
2828
runs and the records are constructed, but nothing reads them.
2929

30+
Note that, like the telemetry reporter it feeds, this directive is
31+
not available on Windows. See :doc:`WSGITelemetryService` for
32+
details.
33+
3034
Each slow-request record carries:
3135

3236
* The originating process PID and worker thread ID.

docs/configuration-directives/WSGITelemetryOptions.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ This is a server-wide directive: it may only appear at the top
1616
level of the Apache configuration, outside any ``<VirtualHost>``
1717
block.
1818

19+
Note that, like the telemetry reporter it configures, this directive
20+
is not available on Windows. See :doc:`WSGITelemetryService` for
21+
details.
22+
1923
Syntax follows the Apache ``Options`` directive convention. Two
2024
argument forms are supported, and may not be mixed within one
2125
line:

docs/configuration-directives/WSGITelemetryService.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,14 @@ configuration line enables the reporter for the entire Apache
3939
instance, covering every daemon process group and every
4040
embedded-mode Apache child.
4141

42+
Note that the telemetry reporter, and so the ``WSGITelemetryService``,
43+
:doc:`WSGISlowRequests` and :doc:`WSGITelemetryOptions` directives, are
44+
not available on Windows. The reporter delivers its datagrams over a
45+
UNIX ``SOCK_DGRAM`` socket, which Windows does not provide, so the
46+
feature is not built there and these directives are not registered.
47+
Using one of them on Windows is reported by Apache as an unknown
48+
directive.
49+
4250
Arguments
4351
---------
4452

docs/user-guides/external-telemetry-service.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,14 @@ using the operating-system ``mod_wsgi`` package (or any other
3434
manually-configured Apache) can use the telemetry pipeline without
3535
adopting ``mod_wsgi-express`` as well.
3636

37+
.. note::
38+
39+
The telemetry reporter is not available on Windows. It delivers its
40+
datagrams over a UNIX ``SOCK_DGRAM`` socket, which Windows does not
41+
provide, so the feature is not built there and the
42+
``WSGITelemetryService``, ``WSGISlowRequests`` and
43+
``WSGITelemetryOptions`` directives are not registered.
44+
3745
How it works
3846
------------
3947

0 commit comments

Comments
 (0)