Chapter 3. Base Server Resources
There are certain server types that are supported by default in JBoss Operations Network, both for JBoss and non-JBoss resource types.
3.1. Apache
3.1.1. Configuring Apache for Monitoring
JBoss Operations Network uses SNMP to monitor an Apache server for things like availability. JBoss ON can also monitor URLs hosted by the Apache server and return response time metrics for each URL.
For JBoss Operations Network to gather metrics about the Apache web server or its URL, the appropriate module (SNMP or Response Time) must be configured in the Apache server. Both JBoss ON modules are Apache Dynamically Shared Object (DSO), so the general implementation for these modules is similar to deploying other Apache modules:
- Make sure the Apache server was compiled with DSO support.
- Compile and install the module.
- Configure the Apache server to use the module.
- Restart the Apache server.
3.1.1.1. Configuring the Response Time Module for Apache 2.x
To collect response time metrics for each URL for an Apache server, the Response Time module must be configured on that Apache server.
Important
To use the Response Time module, the Apache server needs to have been compiled with shared object support. For Red Hat Enterprise Linux systems and EWS servers, this is enabled by default.
To verify that the Apache server was compiled with shared object support, use the
apachectl -l command to list the compiled modules and look for the mod_so.c module:
[root@server ~]# apachectl -l Compiled in modules: core.c prefork.c http_core.c mod_so.c
When compiling Apache from source, on 2.0.x versions, use the
--enable-so option:
$ ./configure --enable-so $ make install
For Apache 2.2.x versions, use the
--enable-module=so option:
$ ./configure --enable-module=so $ make install
- Download the Apache binaries from the JBoss ON UI.
- Log into the JBoss ON UI.
https://server.example.com:7080
- In the Administration tab in the top menu, click the item.
- Scroll to Connector Downloads, and click the
connector-apache.ziplink to download the Apache connectors.
- Unzip the Apache connectors.
unzip connector-apache.zip
- Compile the Response Time module.
Note
apxsmust be installed, andmakemust be installed and in the user PATH.cd apacheMOduleRoot/apache-rt/sources chmod +x build_apache_module.sh ./build_apache_module.sh 2.x apache_install_directory/bin/apxs
- Then, install the Response Time module on the Apache server. On Red Hat Enterprise Linux:
cp apache2.x/.libs/mod_rt.so apache_install_directory/modules
For Solaris:cp apache2.x/.libs/mod_rt.so APACHE_2.x_INSTALL_DIR/modules
For Windows:xcopy /e JON_AGENT_INSTALL_DIR\product_connectors\apache-rt\binaries \x86-winnt-apache2.0\* apache_install_directory
- Open the
httpd.conffile. For example, on Red Hat Enterprise Linux:vim apache_install_directory/conf/httpd.conf
- Enable the module in the Apache's
httpd.conffile by appending this line to the end of the file:LoadModule rt_module modules/mod_rt.so LogFormat "%S" rt_log
When setting the log format, the variable%Shas a capital S. - To configure response time logging for the main Apache server, add the following line at the top level of the file:
CustomLog logs/myhost.com80_rt.log rt_log
To configure response time logging for a virtual host, add the following line somewhere within the<VirtualHost>block:CustomLog logs/myhost.com8080_rt.log rt_log
Make sure the response time log file name is different for the main server and each virtual host. Consider using the the host and port from theServerNamedirective be used to form the file name, such as host_port_rt.log. - Restart the Apache server:
apache_install_directory/bin/apachectl restart
- To confirm that the Response Time module was installed successfully, check that the response time log files configured via the CustomLog directive now exist.
3.1.1.2. Configuring the Apache SNMP Module
To discover an Apache server's virtual hosts and collect metrics for them, the SNMP module must be configured on that Apache server.
Apache 2.0 and 2.2 are supported on Red Hat Enterprise Linux. Only Apache 2.0 is supported on Windows.
Important
To use the Response Time module, the Apache server needs to have been compiled with shared object support. For Red Hat Enterprise Linux systems and EWS servers, this is enabled by default.
To verify that the Apache server was compiled with shared object support, use the
apachectl -l command to list the compiled modules and look for the mod_so.c module:
[root@server ~]# apachectl -l Compiled in modules: core.c prefork.c http_core.c mod_so.c
When compiling Apache from source, on 2.0.x versions, use the
--enable-so option:
$ ./configure --enable-so $ make install
For Apache 2.2.x versions, use the
--enable-module=so option:
$ ./configure --enable-module=so $ make install
- Download the Apache binaries from the JBoss ON UI.
- Log into the JBoss ON UI.
https://server.example.com:7080
- In the Administration tab in the top menu, click the item.
- Scroll to Connector Downloads, and click the
connector-apache.ziplink to download the Apache connectors.
- Unzip the Apache connectors in a directory that is accessible to the JBoss ON agent.
unzip connector-apache.zip
- Each Apache version and platform has its own package that contains the Apache-SNMP connectors. Unzip the Apache connectors in a directory that is accessible to the JBoss ON agent. Binaries are available for Red Hat Enterprise Linux 32-bit and 64-bit and Windows.For example, on Red Hat Enterprise Linux 32-bit:
cd apacheModuleRoot/apache-snmp/binaries/ tar xjvf snmp_module-x86-linux-apache#.tar.bz2
# is the Apache server version number.Note
Apache connectors can be compiled for other platforms, like Solaris, from the source files inapacheMOduleRoot/apache-snmp/sources. For example:cd JON_AGENT_INSTALL_DIR/product_connectors/apache-snmp/sources ./build_apache_snmp.sh APACHE_VERSION APACHE_2.x_INSTALL_DIR/bin/apxs
(To compile the Apache-SNMP connector,apxs,perl,make, andautomakemust all be installed and in userPATH.) - Install the module.For example, on Red Hat Enterprise Linux:
# cd apacheModuleRoot/apache-snmp/binaries/snmp_module_# # cp module/* apache_install_directory/modules # cp conf/* apache_install_directory/conf # mkdir apache_install_directory/var
On Windows:> xcopy /e JON_AGENT_INSTALL_DIR\product_connectors\apache-snmp\binaries\x86-winnt-apache2.0\* APACHE_2.0_INSTALL_DIR
- Open the
httpd.conffile. For example, on Red Hat Enterprise Linux:vim apache_install_directory/conf/httpd.conf
- Enable the module by adding these lines to the
httpd.confon both Red Hat Enterprise Linux and Windows:LoadModule snmpcommon_module modules/snmpcommon.so LoadModule snmpagt_module modules/snmpmonagt.so SNMPConf conf SNMPVar var
- Make sure the main Apache configuration section, as well as each
<VirtualHost>configuration block, contains aServerNamedirective with a port. The SNMP module uses this directive to uniquely identify the main server and each virtual host, so eachServerNamedirective must contain a unique value. For example:ServerName main.example.com:80 ... <VirtualHost vhost1.example.com:80> ServerName vhost1.example.com:80 ... </VirtualHost>
- If there is more than one Apache instance on the same machine, it is possible to use different SNMP files for each instance.
- Each Apache instance has its own
httpd.conffile. Set theSNMPConfdirectory in each file to its own SNMP configuration directory. For example, for instance1:vim instance1-httpd.conf SNMPConf /opt/apache-instance1/conf
Then, for instance2:vim instance2-httpd.conf SNMPConf /opt/apache-instance2/conf
Eachsnmpd.conffile should be in the specified directory. - Edit the
agentaddressproperty in apache_install_directory/conf/snmpd.confso that each instance has a different value agent address and port, so there is no conflict between instances.See the snmpd.conf documentation for a description of this property's syntax.
- Restart the Apache server. For example:
apache_installation_dir/bin/Apache -k restart
- Verify that the SNMP module was properly installed. If the module is loaded, then there will be lines referencing the SNMP module in the errors log:
grep SNMP apache_installation_dir/logs/error_log [Wed Mar 19 09:54:34 2008] [notice] Apache/2.0.63 (Unix) CovalentSNMP/2.3.0 configured -- resuming normal operations [Wed Mar 19 09:54:35 2008] [notice] SNMP: CovalentSNMP/2.3.0 started (user '1000' - SNMP address '1610' - pid '26738')
3.1.2. Apache HTTP Server
Overview
| Description: | an Apache HTTP Server instance |
| Singleton: | no |
| Plugin: | Apache |
Parent Resource Types
Child Resource Types
Autodiscovery Process Scans
| Name | Query |
|---|---|
| HttpdOnUnix | process|basename|match=httpd.*,process|basename|nomatch|parent=httpd.* |
| HttpdOnWindows | process|basename|match=(?i)httpd.exe,process|basename|match|parent=(?i)httpd.exe |
| Apache2OnUnix | process|basename|match=apache2,process|basename|nomatch|parent=apache2 |
| ApacheOnWindows | process|basename|match=(?i)Apache.exe,process|basename|match|parent=(?i)Apache.exe |
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Enable augeas support | Enable augeas support | yes | augeasEnabled |
| Augeas Module Name | the name of the Augeas module/lens to use for loading and updating this resource's configuration | yes | augeasModuleName |
| Httpd config file | Location of the Apache main configuration file. | yes | configurationFilesInclusionPatterns |
| Virtual Hosts Configuration Placement | How should the new virtual host definitions be put in the configuration | yes | vhostCreationPolicy |
| Path To Contain Virtual Hosts Files | If the new virtual hosts should be created in standalone files, this mask determines where to create those files. The '*' in the path is replaced by the name of the virtual host. If the path is relative, it is considered relative to server root. | yes | vhostFilesMask |
| Error Log File Path | The absolute path to the error log file - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default will be 'logs/error_log' on UNIX or 'logs\error.log' on Windows. | no | errorLogFilePath |
| Error Log Events Enabled | A flag indicating whether or not generation of Events for new error log entries is enabled. | yes | errorLogEventsEnabled |
| Error Log Minimum Severity | The minimum severity of error log entry Events that should be collected. If not specified, there is no minimum severity (i.e. all events will be collected). | no | errorLogMinimumSeverity |
| Error Log Includes Pattern | A regular expression against which an error log entry's detail is matched to determine if an Event should be fired for that entry. If not specified, no filtering of log entries will be done based on their detail. | no | errorLogIncludesPattern |
| Custom Module Names | Apache can use 2 values to identify a module. Either its module name that is used in the LoadModule directive or its source file that can be used in the IfModule directive (as of Apache 2.1 the IfModule directive can but doesn't have to use the module name, too). The plugin contains the mappings of the module names to module files for all the standard apache modules mentioned on the http://httpd.apache.org/docs/current/mod/ plus the SNMP module and mod_jk. If you use any non-standard modules and use their source file in the IfModule directives, you have to add the module-name-to-module-file mapping to this list so that the plugin can determine the correct runtime configuration of the apache instance. | yes | customModuleNames |
| Server Root | the absolute path of the Apache server root directory | yes | serverRoot |
| Executable Path | the path to the Apache executable - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default value is 'bin/httpd' on UNIX or 'bin\Apache.exe' on Windows | no | executablePath |
| Control Script Path | the path to the Apache control script - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default will be 'bin/apachectl' on UNIX or the Apache executable on Windows | no | controlScriptPath |
| Config File | the path to the httpd.conf file - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default will be 'conf/httpd.conf' on UNIX | yes | configFile |
| URL | The http or https URL that will be used to check availability for this Apache server; if not set, availablity will be determined based on whether plugin can connect to the Apache server's SNMP agent. Note that SSL certificate validation is disabled during availability checks if this is an HTTPS URL. | no | url |
| SNMP Agent Host | the host name or IP address of the Apache SNMP agent (typically '127.0.0.1') | yes | snmpAgentHost |
| SNMP Agent Port | the UDP port of the Apache SNMP agent (typically '1610') | yes | snmpAgentPort |
| SNMP Agent Community | the SNMP community of the Apache SNMP agent (typically 'public') | yes | snmpAgentCommunity |
| Restart After Configuration Update | If set to true, each configuration update of the server or any underlying virtual host or directory is followed by the restart of the Apache instance so that the configuration changes are applied immediately. If set to false, you have to manually restart the server (for example using the restart operation in the operations tab) once all the configuration updates are finished. | yes | restartAfterConfigurationUpdate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Number of Concurrent Connections | measurement | Number of Concurrent Connections | applInboundAssociations |
| Server Built | trait | the date and time this Apache server's binary was compiled | serverBuilt |
| Start Time | trait | the date and time this Apache server was last started | wwwServiceStartTime |
| Time to ping the server for availability | measurement | Time it took to ping the server for availability over http; this includes DNS lookup time. | rhq_avail_ping_time |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Listen | yes | Listen | |
| Name Virtual Host | A required directive if you want to configure name-based virtual hosts. Although the value can be hostname it is recommended that you always use an IP address. IPv6 addresses must be enclosed in square brackets. To receive requests on all interfaces, you can set the value to *. Note that the IP address of a name-based virtual host must exactly match the value of this property. The address may be optionally followed by the port specification to further limit the directive effect. | no | NameVirtualHost |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
| Name | Description |
|---|---|
| Start | Starts this Apache server, or returns an error if it is already running. The control script used is specified in the Connection Properties. |
| Stop | Stops this Apache server, or returns an error if it is not running. The control script used is specified in the Connection Properties. |
| Restart | Restarts the Apache server by sending its process a SIGHUP. If the server is not running, it is started. This command automatically checks the server's configuration files via configtest before initiating the restart to make sure Apache doesn't die. The control script used is specified in the Connection Properties. Only supported on UNIX platforms. |
| Start with SSL Support | Starts this Apache server with support for SSL. The control script used is specified in the Connection Properties. Only supported on Apache 1.3. |
| Restart Gracefully | Gracefully restarts the Apache server by sending it a SIGUSR1. If the daemon is not running, it is started. This differs from a normal restart in that currently open connections are not aborted. A side effect is that old log files will not be closed immediately. This means that if used in a log rotation script, a substantial delay may be necessary to ensure that the old log files are closed before processing them. This command automatically checks the configuration files via configtest before initiating the restart to make sure Apache doesn't die. The control script used is specified in the Connection Properties. |
| Check Configuration File Syntax | Run a configuration file syntax test. It parses the configuration files and either reports Syntax Ok or detailed information about the particular syntax error. The control script used is specified in the Connection Properties. Only supported on UNIX platforms. |
| Install mod_jk configuration | Tries to install a mod_jk configuration in httpd.conf if none is detected. This includes a workers.properties file and urimap file |
Package Types
none
3.1.2.1. Apache Virtual Host Service
Overview
| Description: | |
| Singleton: | no |
| Plugin: | Apache |
Parent Resource Types
Child Resource Types
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Response Time Log File | the full path to the log file containing response-time stats for this virtual host | no | responseTimeLogFile |
| Response Time Url Excludes | a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection | no | responseTimeUrlExcludes |
| Response Time Url Transforms | a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|) | no | responseTimeUrlTransforms |
| URL | The http or https URL that will be used to check availability for this virtual host. Note that SSL certificate validation is disabled during availability checks if this is an HTTPS URL. If the URL is not set, the availability is determined by pinging the configured SNMP location. | no | url |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Host | trait | the host name or IP address of this virtual host | wwwServiceName |
| Port | trait | the TCP port of this virtual host | wwwServiceProtocol |
| Administrator | trait | the administrator of this virtual host | wwwServiceContact |
| Total Number of Requests | measurement | The number of inbound requests on the service | wwwSummaryInRequests |
| Total Number of Requests per Minute | measurement | The number of inbound requests on the service | wwwSummaryInRequests |
| Total Number of Bytes Received | measurement | The number of bytes received by the service | wwwSummaryInLowBytes |
| Total Number of Bytes Received per Minute | measurement | The number of bytes received by the service. When using the SNMP module to monitor Apache, this value will always be zero. SNMP provides various length values for the request body and a GET request does not have a body, so GET responses are not calculated and, therefore, have a value of zero. Additionally, Apache does not calculate a request body size if there is request chunking, which results in a value of zero. | wwwSummaryInLowBytes |
| Total Number of Responses | measurement | The number of outbound requests on the service | wwwSummaryOutResponses |
| Total Number of Responses per Minute | measurement | The number of outbound requests on the service | wwwSummaryOutResponses |
| Total Number of Bytes Sent | measurement | The number of bytes sent by the service | wwwSummaryOutLowBytes |
| Total Number of Bytes Sent per Minute | measurement | The number of bytes sent by the service | wwwSummaryOutLowBytes |
| Number of GET Requests | measurement | The number of inbound GET requests on the service | wwwRequestInRequests.GET |
| Number of GET Requests per Minute | measurement | The number of inbound GET requests on the service | wwwRequestInRequests.GET |
| Number of HEAD Requests | measurement | The number of inbound HEAD requests on the service | wwwRequestInRequests.HEAD |
| Number of HEAD Requests per Minute | measurement | The number of inbound HEAD requests on the service | wwwRequestInRequests.HEAD |
| Number of POST Requests | measurement | The number of inbound POST requests on the service | wwwRequestInRequests.POST |
| Number of POST Requests per Minute | measurement | The number of inbound POST requests on the service | wwwRequestInRequests.POST |
| Number of PUT Requests | measurement | The number of inbound PUT requests on the service | wwwRequestInRequests.PUT |
| Number of PUT Requests per Minute | measurement | The number of inbound PUT requests on the service | wwwRequestInRequests.PUT |
| Bytes Received for GET Requests | measurement | The number of bytes received by GET requests on the service | wwwRequestInBytes.GET |
| Bytes Received for GET Requests per Minute | measurement | The number of bytes received by GET requests on the service. When using the SNMP module to monitor Apache, this value will always be zero. SNMP provides various length values for the request body and a GET request does not have a body, so GET responses are not calculated and, therefore, have a value of zero. Additionally, Apache does not calculate a request body size if there is request chunking, which results in a value of zero. | wwwRequestInBytes.GET |
| Bytes Received for HEAD Requests | measurement | The number of bytes received by HEAD requests on the service | wwwRequestInBytes.HEAD |
| Bytes Received for HEAD Requests per Minute | measurement | The number of bytes received by HEAD requests on the service | wwwRequestInBytes.HEAD |
| Bytes Received for POST Requests | measurement | The number of bytes received by POST requests on the service. When using the SNMP module to monitor Apache, this value will always be zero. SNMP provides various length values for the request body and a GET request does not have a body, so GET responses are not calculated and, therefore, have a value of zero. Additionally, Apache does not calculate a request body size if there is request chunking, which results in a value of zero. | wwwRequestInBytes.POST |
| Bytes Received for POST Requests per Minute | measurement | The number of bytes received by POST requests on the service | wwwRequestInBytes.POST |
| Bytes Received for PUT Requests | measurement | The number of bytes received by PUT requests on the service | wwwRequestInBytes.PUT |
| Bytes Received for PUT Requests per Minute | measurement | The number of bytes received by PUT requests on the service | wwwRequestInBytes.PUT |
| Number of 200 Responses | measurement | The number of 200 responses generated by this service | wwwResponseOutResponses.200 |
| Number of 200 Responses per Minute | measurement | The number of 200 responses generated by this service | wwwResponseOutResponses.200 |
| Number of 301 Responses | measurement | The number of 301 responses generated by this service | wwwResponseOutResponses.301 |
| Number of 301 Responses per Minute | measurement | The number of 301 responses generated by this service | wwwResponseOutResponses.301 |
| Number of 302 Responses | measurement | The number of 302 responses generated by this service | wwwResponseOutResponses.302 |
| Number of 302 Responses per Minute | measurement | The number of 302 responses generated by this service | wwwResponseOutResponses.302 |
| Number of 401 Responses | measurement | The number of 401 responses generated by this service | wwwResponseOutResponses.401 |
| Number of 401 Responses per Minute | measurement | The number of 401 responses generated by this service | wwwResponseOutResponses.401 |
| Number of 403 Responses | measurement | The number of 403 responses generated by this service | wwwResponseOutResponses.403 |
| Number of 403 Responses per Minute | measurement | The number of 403 responses generated by this service | wwwResponseOutResponses.403 |
| Number of 404 Responses | measurement | The number of 404 responses generated by this service | wwwResponseOutResponses.404 |
| Number of 404 Responses per Minute | measurement | The number of 404 responses generated by this service | wwwResponseOutResponses.404 |
| Number of 500 Responses | measurement | The number of 500 responses generated by this service | wwwResponseOutResponses.500 |
| Number of 500 Responses per Minute | measurement | The number of 500 responses generated by this service | wwwResponseOutResponses.500 |
| Bytes Sent for 200 Responses | measurement | The number of bytes sent for 200 responses generated by this service | wwwResponseOutBytes.200 |
| Bytes Sent for 200 Responses per Minute | measurement | The number of bytes sent for 200 responses generated by this service | wwwResponseOutBytes.200 |
| Bytes Sent for 301 Responses | measurement | The number of bytes sent for 301 responses generated by this service | wwwResponseOutBytes.301 |
| Bytes Sent for 301 Responses per Minute | measurement | The number of bytes sent for 301 responses generated by this service | wwwResponseOutBytes.301 |
| Bytes Sent for 302 Responses | measurement | The number of bytes sent for 302 responses generated by this service | wwwResponseOutBytes.302 |
| Bytes Sent for 302 Responses per Minute | measurement | The number of bytes sent for 302 responses generated by this service | wwwResponseOutBytes.302 |
| Bytes Sent for 401 Responses | measurement | The number of bytes sent for 401 responses generated by this service | wwwResponseOutBytes.401 |
| Bytes Sent for 401 Responses per Minute | measurement | The number of bytes sent for 401 responses generated by this service | wwwResponseOutBytes.401 |
| Bytes Sent for 403 Responses | measurement | The number of bytes sent for 403 responses generated by this service | wwwResponseOutBytes.403 |
| Bytes Sent for 403 Responses per Minute | measurement | The number of bytes sent for 403 responses generated by this service | wwwResponseOutBytes.403 |
| Bytes Sent for 404 Responses | measurement | The number of bytes sent for 404 responses generated by this service | wwwResponseOutBytes.404 |
| Bytes Sent for 404 Responses per Minute | measurement | The number of bytes sent for 404 responses generated by this service | wwwResponseOutBytes.404 |
| Bytes Sent for 500 Responses | measurement | The number of bytes sent for 500 responses generated by this service | wwwResponseOutBytes.500 |
| Bytes Sent for 500 Responses per Minute | measurement | The number of bytes sent for 500 responses generated by this service | wwwResponseOutBytes.500 |
| HTTP Response Time | calltime | The minimum, maximum, and average response times for HTTP requests serviced by this virtual host | ResponseTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Error Log | Sets the name of the file to which the server will log any errors it encounters. If the file-path is not absolute then it is assumed to be relative to the ServerRoot. If the file-path begins with a pipe (|) then it is assumed to be a command to spawn to handle the error log. Using syslog instead of a filename enables logging via syslogd(8) if the system supports it. The default is to use syslog facility local7, but you can override this by using the syslog:facility syntax where facility can be one of the names usually documented in syslog(1). | no | ErrorLog |
| Request logs | Configure the logging of requests to the server. | yes | CustomLog |
| Server Name | Sets the request scheme, hostname and port that the server uses to identify itself. This is used when creating redirection URLs. If no ServerName is specified, then the server attempts to deduce the hostname by performing a reverse lookup on the IP address. If no port is specified in the ServerName, then the server will use the port from the incoming request. For optimal reliability and predictability, you should specify an explicit hostname and port using the ServerName directive. If you are using name-based virtual hosts, the ServerName inside a <VirtualHost> section specifies what hostname must appear in the request's Host: header to match this virtual host. | no | ServerName |
| Server Alias | yes | ServerAlias | |
| Server Admin | The email address or URL to contact the server administrator in case of errors. This address is used in various Apache generated error messages. | no | ServerAdmin |
| Document Root | This directive sets the directory from which httpd will serve files. Unless matched by a directive like Alias, the server appends the path from the requested URL to the document root to make the path to the document. If the directory-path is not absolute then it is assumed to be relative to the ServerRoot. The DocumentRoot should be specified without a trailing slash. | yes | DocumentRoot |
| Add Default Charset | This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types. | no | AddDefaultCharset |
| Alias | The Alias directive allows documents to be stored in the local filesystem other than under the DocumentRoot. With " Alias /image /ftp/pub/image", a request for http://myserver/image/foo.gif would cause the server to return the file /ftp/pub/image/foo.gif. Only complete path segments are matched, so the above alias would not match a request for http://myserver/imagefoo.gif. Note that you may need to specify additional <Directory> sections which cover the destination of aliases. In particular, if you are creating an Alias to a directory outside of your DocumentRoot, you may need to explicitly permit access to the target directory. | yes | Alias |
| Default Type | There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType. | no | DefaultType |
| Directory Index | Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory. | no | DirectoryIndex |
| Error Document | In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error. | yes | ErrorDocument |
| Timeout | The TimeOut directive defines the length of time Apache will wait for I/O in various circumstances. | no | Timeout |
| Options | The Options directive controls which server features are available in a particular directory. | no | Options |
| Use Canonical Name | With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs. | no | UseCanonicalName |
| Use Canonical Physical Port | In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number. | no | UseCanonicalPhysicalPort |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.1.2.1.1. Directory Service
Overview
| Description: | |
| Singleton: | no |
| Plugin: | Apache |
Parent Resource Types
Child Resource Types
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Regular Expression | Does the name of this directory denote a regular expression? | yes | regexp |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| IfModule Conditions | List of modules which must be loaded to use directive configuration. | yes | IfModules |
| Order | The Order directive, along with the Allow and Deny directives, controls a three-pass access control system. The first pass processes either all Allow or all Deny directives, as specified by the Order directive. The second pass parses the rest of the directives (Deny or Allow). The third pass applies to all requests which do not match either of the first two. | no | Order |
| Allow | The Allow directive affects which hosts can access an area of the server. Access can be controlled by hostname, IP address, IP address range. The environment variables settings are not supported in the user interface. | no | Allow |
| Deny | The arguments for the Deny directive are identical to the arguments for the Allow directive. | no | Deny |
| Allow Override | no | AllowOverride | |
| Add Default Charset | This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types. | no | AddDefaultCharset |
| Default Type | There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType. | no | DefaultType |
| Directory Index | Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory. | no | DirectoryIndex |
| Error Document | In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error. | yes | ErrorDocument |
| Options | The Options directive controls which server features are available in a particular directory. | no | Options |
| Use Canonical Name | With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs. | no | UseCanonicalName |
| Use Canonical Physical Port | In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number. | no | UseCanonicalPhysicalPort |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.1.2.1.1.1. IfModule Parameters Service
| Description: | |
| Singleton: | no |
| Plugin: | Apache |
none
none
none
| Name | Description | Required | Internal Name |
|---|---|---|---|
| IfModule Conditions | List of modules which must be loaded to use directive configuration. | yes | IfModules |
| Order | The Order directive, along with the Allow and Deny directives, controls a three-pass access control system. The first pass processes either all Allow or all Deny directives, as specified by the Order directive. The second pass parses the rest of the directives (Deny or Allow). The third pass applies to all requests which do not match either of the first two. | no | Order |
| Allow | The Allow directive affects which hosts can access an area of the server. Access can be controlled by hostname, IP address, IP address range. The environment variables settings are not supported in the user interface. | no | Allow |
| Deny | The arguments for the Deny directive are identical to the arguments for the Allow directive. | no | Deny |
| Allow Override | no | AllowOverride | |
| Add Default Charset | This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types. | no | AddDefaultCharset |
| Default Type | There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType. | no | DefaultType |
| Directory Index | Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory. | no | DirectoryIndex |
| Error Document | In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error. | yes | ErrorDocument |
| Options | The Options directive controls which server features are available in a particular directory. | no | Options |
| Use Canonical Name | With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs. | no | UseCanonicalName |
| Use Canonical Physical Port | In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number. | no | UseCanonicalPhysicalPort |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.1.2.1.2. IfModule Service
Overview
| Description: | |
| Singleton: | no |
| Plugin: | Apache |
Parent Resource Types
Child Resource Types
none
Connection Properties
none
Metrics
none
Configuration Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| IfModule Conditions | List of modules which must be loaded to use directive configuration. | yes | IfModules |
| Order | The Order directive, along with the Allow and Deny directives, controls a three-pass access control system. The first pass processes either all Allow or all Deny directives, as specified by the Order directive. The second pass parses the rest of the directives (Deny or Allow). The third pass applies to all requests which do not match either of the first two. | no | Order |
| Allow | The Allow directive affects which hosts can access an area of the server. Access can be controlled by hostname, IP address, IP address range. The environment variables settings are not supported in the user interface. | no | Allow |
| Deny | The arguments for the Deny directive are identical to the arguments for the Allow directive. | no | Deny |
| Allow Override | no | AllowOverride | |
| Add Default Charset | This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types. | no | AddDefaultCharset |
| Default Type | There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType. | no | DefaultType |
| Directory Index | Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory. | no | DirectoryIndex |
| Error Document | In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error. | yes | ErrorDocument |
| Options | The Options directive controls which server features are available in a particular directory. | no | Options |
| Use Canonical Name | With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs. | no | UseCanonicalName |
| Use Canonical Physical Port | In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number. | no | UseCanonicalPhysicalPort |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.1.2.2. Mod JK Service
Overview
| Description: | Management of mod_jk |
| Singleton: | yes |
| Plugin: | Apache |
Parent Resource Types
Child Resource Types
none
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path to workers.properties | The path to the file containing worker properties. If this is a relative path, it will be looked up in the server root of the parent Apache server | no | workerFile |
| Path to the uriworkers file | The path to the file containing uri to worker mappings. If this is a relative path, it will be looked up in the server root of the parent Apache server | no | uriWorkerFile |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
