Each file with the .url suffix found in the config directory or
sub-directory contains one complete HTTP or HTTPS URL at which
pmdaopenmetrics
can reach a OpenMetrics endpoint. Local file
access is also supported with a conventional
file:///somepath/somefile URL, in which case somepath/somefile
should contain openmetrics formatted metric data.
The first line of a .url config file should be the URL, as
described above. Subsequent lines, if any, are prefixed with a
keyword that can be used to alter the http GET request. A
keyword must end with ':'
(colon) and the text extends to the end
of the line. Comment lines that start with #
and blank lines are
ignored. The only currently supported keywords are HEADER:
and
FILTER:
.
HEADER:
headername:
value ... to end of line
Adds headername and its value to the headers passed in the http
GET request for the configured URL. An example configuration
file that provides 3 commonly used headers and an authentication
token might be :
http://somehost/path/endpoint.html
# this is a comment
HEADER: Accept: text/html
HEADER: Keep-Alive: 300
HEADER: Connection: keep-alive
HEADER: Authorization: token ABCDEF1234567890
As mentioned above, header values extend to the end of the line.
They may contain any valid characters, including colons.
Multiple spaces will be collapsed to a single space, and leading
and trailing spaces are trimmed. A common use for headers is to
configure a proxy agent and the assorted parameters it may
require.