B10-STATS-HTTPD(8)

NAME
b10-stats-httpd - BIND 10 HTTP server for HTTP/XML interface of statistics

SYNOPSIS

b10-stats-httpd [-v]| [--verbose]

DESCRIPTION

b10-stats-httpd is a standalone HTTP server. It is intended for HTTP/XML interface for statistics module. This server process runs as a process separated from the process of the BIND 10 Stats daemon (b10-stats). The server is initially executed by the BIND 10 boss process (bind10) and eventually exited by it. The server is intended to be server requests by HTTP clients like web browsers and third-party modules. When the server is asked, it requests BIND 10 statistics data from b10-stats, and it sends the data back in Python dictionary format and the server converts it into XML format. The server sends it to the HTTP client. The server can send three types of document, which are XML (Extensible Markup Language), XSD (XML Schema definition) and XSL (Extensible Stylesheet Language). The XML document is the statistics data of BIND 10, The XSD document is the data schema of it, and The XSL document is the style sheet to be showed for the web browsers. There is different URL for each document. But please note that you would be redirected to the URL of XML document if you request the URL of the root document. For example, you would be redirected to http://127.0.0.1:8000/bind10/statistics/xml if you request http://127.0.0.1:8000/. Please see the manual and the spec file of b10-stats for more details about the items of BIND 10 statistics. The server uses CC session in communication with b10-stats. CC session is provided by b10-msgq which is started by bind10 in advance. The server is implemented by HTTP-server libraries included in Python 3. The server obtains the configuration from the config manager (b10-cfgmgr) in runtime. Please see below for more details about this spec file and configuration of the server.

OPTIONS

The argument is as follow:

-v, --verbose
    b10-stats-httpd switches to verbose mode and sends verbose messages to STDOUT.

FILES

/usr/local/share/bind10-devel/stats-httpd.spec — the spec file of b10-stats-httpd. This file contains configurable settings of b10-stats-httpd. This setting can be configured in runtime via bindctl(1). Please see the manual of bindctl(1) about how to configure the settings.

/usr/local/share/bind10-devel/stats-httpd-xml.tpl — the template file of XML document.

/usr/local/share/bind10-devel/stats-httpd-xsd.tpl — the template file of XSD document.

/usr/local/share/bind10-devel/stats-httpd-xsl.tpl — the template file of XSL document.

CONFIGURATION AND COMMANDS

The configurable setting in stats-httpd.spec is:

listen_on
    a list of pairs of address and port for b10-stats-httpd to listen HTTP requests on. The pair consists of the address string and port number. The default setting is the list of address 127.0.0.1 port 8000. If the server is started by the default setting being left, for example, the URL for XML document is http://127.0.0.1:8000/bind10/statistics/xml. And also IPv6 addresses can be configured and they works in the runtime environment for dual stack. You can change the settings through bindctl(8).

The commands in stats-httpd.spec are:

status
    shows the status of b10-stats-httpd with its PID.

shutdown
    exits the b10-stats-httpd process. (Note that the BIND 10 boss process will restart this service.)

SEE ALSO

b10-stats(8), b10-msgq(8), b10-cfgmgr(8), bind10(8), bindctl(1), BIND 10 Guide.

HISTORY

b10-stats-httpd was designed and implemented by Naoki Kambe of JPRS in Mar 2011.

COPYRIGHT
Copyright © 2011 Internet Systems Consortium, Inc. ("ISC")