LocalLB::ProfileRequestLogging

Introduced : BIG-IP_v11.0.0
The request logging profile configures the high-speed logging of L7 requests. The logging can be performed both before and after the request is processed (or connection is made). The logging can also be re-directed if an error has occurred when logging. Thus configuration exists to control five independent different cases. request logs a request before its processing to the primary log servers. request_secondary logs error messages to secondary log servers if pre-request logging fails. proxy sends an alternate response to the client if pre-request logging fails. response logs the response after its processing to the primary log servers. response_secondary logs error messages to secondary log servers if response logging fails. Each case can be configured separately.

Methods

Method Description Introduced
create Creates a set of request logging profiles. BIG-IP_v11.0.0
delete_all_profiles Deletes all request logging profiles. BIG-IP_v11.0.0
delete_profile Deletes a set of request logging profiles. BIG-IP_v11.0.0
get_default_profile Gets the name of the profile from which this profile inherits its values for a set of request logging profiles. BIG-IP_v11.0.0
get_description Gets the description for a set of request logging profiles. BIG-IP_v11.0.0
get_list Gets the names of all request logging profiles. BIG-IP_v11.0.0
get_proxy_close_state Gets the state to close the client connection after sending the specified response to the client after a pre-request logging error for a set of request logging profiles. BIG-IP_v11.0.0
get_proxy_response Gets the response to send to the client on behalf of the server after a pre-request logging error for a set of request logging profiles. BIG-IP_v11.0.0
get_proxy_response_state Gets the state to respond on behalf of the server if an error occurs while logging a pre-request entry for a set of request logging profiles. BIG-IP_v11.0.0
get_request_pool Gets the pre-request pool for a set of request logging profiles. BIG-IP_v11.0.0
get_request_protocol Gets the protocol for sending pre-request log entries to the primary log servers for a set of request logging profiles. BIG-IP_v11.0.0
get_request_secondary_pool Gets the pre-request secondary pool for a set of request logging profiles. BIG-IP_v11.0.0
get_request_secondary_protocol Gets the protocol for sending pre-request entries to the secondary log servers for a set of request logging profiles. BIG-IP_v11.0.0
get_request_secondary_state Gets the state to log pre-request logging errors to a secondary log server pool for a set of request logging profiles. BIG-IP_v11.0.0
get_request_secondary_template Gets the template used to format pre-request secondary log entries for a set of request logging profiles. BIG-IP_v11.0.0
get_request_state Gets the state to log an entry before each request is processed for a set of request logging profiles. BIG-IP_v11.0.0
get_request_template Gets the template used for format entries for pre-request log entries for a set of request logging profiles. BIG-IP_v11.0.0
get_response_log_by_default_state Gets the state to log a post-request entry by default for a set of request logging profiles. BIG-IP_v11.0.0
get_response_pool Gets the pool holding the post-request primary log servers for a set of request logging profiles. BIG-IP_v11.0.0
get_response_protocol Gets the protocol for sending post-request entries to the primary log servers for a set of request logging profiles. BIG-IP_v11.0.0
get_response_secondary_pool Gets the pool holding the post-request secondary log servers for a set of request logging profiles. BIG-IP_v11.0.0
get_response_secondary_protocol Gets the protocol for sending post-request entries to the secondary log servers for a set of request logging profiles. BIG-IP_v11.0.0
get_response_secondary_state Gets the state to log post-request logging errors to the secondary log server pool for a set of request logging profiles. BIG-IP_v11.0.0
get_response_secondary_template Gets the template used to format post-request secondary log entries for a set of request logging profiles. BIG-IP_v11.0.0
get_response_state Gets the state to log an entry to the primary logging servers after each request is processed for a set of request logging profiles. BIG-IP_v11.0.0
get_response_template Gets the template used to format post-request log entries for a set of request logging profiles. BIG-IP_v11.0.0
get_version Gets the version information for this interface. BIG-IP_v11.0.0
is_base_profile Determines whether the specified request logging profiles are base profiles. A base profile sits at the base of the profile&aposs inheritance tree, supplying the defaults for every profile derived from it. (See also is_system_profile). BIG-IP_v11.0.0
is_system_profile Determines whether the specified request logging profiles are system profiles. A system profile is a profile pre-configured on the system, ready for use. Non-system profiles are profiles created or modified by a user. Note that if a system profile is modified, it is no longer considered a system profile. (See also is_base_profile). BIG-IP_v11.0.0
set_default_profile Sets the name of the profile from which this profile inherits its values for a set of request logging profiles. BIG-IP_v11.0.0
set_description Sets the description for a set of request logging profiles. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.0.0
set_proxy_close_state Sets the state to close the client connection after sending the specified response to the client after a pre-request logging error for a set of request logging profiles. BIG-IP_v11.0.0
set_proxy_response Sets the response to send to the client on behalf of the server after a pre-request logging error for a set of request logging profiles. BIG-IP_v11.0.0
set_proxy_response_state Sets the state to respond on behalf of the server if an error occurs while logging a pre-request entry for a set of request logging profiles. BIG-IP_v11.0.0
set_request_pool Sets the pre-request pool for a set of request logging profiles. BIG-IP_v11.0.0
set_request_protocol Sets the protocol for sending pre-request log entries to the primary log servers for a set of request logging profiles. BIG-IP_v11.0.0
set_request_secondary_pool Sets the pre-request secondary pool for a set of request logging profiles. BIG-IP_v11.0.0
set_request_secondary_protocol Sets the protocol for sending pre-request entries to the secondary log servers for a set of request logging profiles. BIG-IP_v11.0.0
set_request_secondary_state Sets the state to log pre-request logging errors to a secondary log server pool for a set of request logging profiles. BIG-IP_v11.0.0
set_request_secondary_template Sets the template used to format pre-request secondary log entries for a set of request logging profiles. BIG-IP_v11.0.0
set_request_state Sets the state to log an entry before each request is processed for a set of request logging profiles. BIG-IP_v11.0.0
set_request_template Sets the template used for format entries for pre-request log entries for a set of request logging profiles. BIG-IP_v11.0.0
set_response_log_by_default_state Sets the state to log a post-request entry by default for a set of request logging profiles. If set, each request is logged after processing unless it is suppressed by a filter or iRule. If not set, a request is logged after processing only if requested by a filter or iRule. BIG-IP_v11.0.0
set_response_pool Sets the pool holding the post-request primary log servers for a set of request logging profiles. BIG-IP_v11.0.0
set_response_protocol Sets the protocol for sending post-request entries to the primary log servers for a set of request logging profiles. BIG-IP_v11.0.0
set_response_secondary_pool Sets the pool holding the post-request secondary log servers for a set of request logging profiles. BIG-IP_v11.0.0
set_response_secondary_protocol Sets the protocol for sending post-request entries to the secondary log servers for a set of request logging profiles. BIG-IP_v11.0.0
set_response_secondary_state Sets the state to log post-request logging errors to the secondary log server pool for a set of request logging profiles. BIG-IP_v11.0.0
set_response_secondary_template Sets the template used to format post-request secondary log entries for a set of request logging profiles. BIG-IP_v11.0.0
set_response_state Sets the state to log an entry to the primary logging servers after each request is processed for a set of request logging profiles. BIG-IP_v11.0.0
set_response_template Sets the template used to format post-request log entries for a set of request logging profiles. BIG-IP_v11.0.0

Structures

Structure

Description

ProfileProtocol

Wrap the Protocol enumeration suitable for use in a profile attribute.


Enumerations

Enumeration Description
Protocol Protocols used to communicate with the log servers.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
ProfileProtocolSequence ProfileProtocol [] Sequence of profile-based logging server protocol values

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.