Skip to main content

Event Logging Parameters

Event Logging Parameters

The Event Log Level field allows you to control what information the CSP Gateway writes to the Event Log. Logging options are defined as a string of characters, each character representing a logging command. The value set here for the Event Log Level is the default for the system (that is, all Caché servers); however, you may set a different value for individual Caché Servers.

The CSP Gateway writes the Event Log to the serial file named CSP.log. This file is placed in the same directory as the CSP Gateway runtime module. You can view or clear the Event Log from the CSP Web Management page menu. The logging parameters are used mainly for troubleshooting. The following table shows the logging options, which can be expressed in lower- or uppercase.

Logging Option Function
E Record all errors. This option allows you to monitor connection failures.
V Verbose: Record the basic connection dialog between the CSP Gateway and a Caché system. Use this option to record the strategic points of communication between the CSP Gateway and a Caché server. There are 7 levels to this command (1 to 7). Each successive level records more detailed information. The levels are accumulative. For example, level V3 includes all log information specified for V1 and V2.
EV Enter EV to turn on basic event logging. The higher log levels generate a large volume of data in the log file and should only be used for diagnosing problems. For production systems it is recommended that the log level should be set to no higher than EV.
V1 Same as V.
V2 In addition to the information specified for previous levels, this level records:
  • Information regarding basic connection management between the CSP Gateway and Caché (Start and Close points for each connection).

  • Transmission interrupts received from the browser.

  • Cases where connections to Caché are forcefully closed (Due to no response from Caché or other errors where the connection can't be recovered).

  • Access violations in state-aware (preserve mode 1) sessions (For example, Invalid Session ID).

V3 In addition to the information specified for previous levels, this level records: Caché headers and HTTP headers.
V4 In addition to the information specified for previous levels, this level records: Information regarding the serialization of state-aware sessions.
V5 This is reserved for future use.
V6 In addition to the information specified for previous levels, this level records:
  • Headers to the data blocks sent to Caché.

  • Request Data from the Web Server (except multipart attachments).

  • Headers to the data blocks received from Caché.

V7 In addition to the information specified for previous levels, this level records: The full content returned from Caché.
V9 Record incoming HTTP request data. The HTTP headers and posted content (where applicable) are recorded. (Does not record info for levels 1–7.) This log directive can be further extended and refined.
  • v9r: In addition to logging all HTTP requests, record all HTTP responses.

  • v9a: Record all HTTP requests to http.log in the Gateway home directory.

  • v9b: Record all HTTP requests on a per-session basis. Log files of the form http[session_id].log is created in the Gateway home directory, where session_id is the 10-Byte session ID.

  • v9m: Log all multi-part posts in the Gateway home directory. The raw incoming HTTP request are recorded together with the individual components in both their encoded and decoded form.

s

Sessions: Record information about the management of session tokens:

  • The point at which new session IDs are allocated.

  • For existing sessions: an indication as to whether the session token was extracted from a cookie or the form/URL variable CSPCHD.

  • For all requests: the final session ID transmitted to Caché.

c

Connections: Record information about connections made using the Kerberos Library (CCONNECT).

Instruct the Gateway to record all CCONNECT functions called, the input parameters, and results. For the sake of brevity, the content of the input and output buffers to and from Caché are not recorded at this level. Set a log level of C (upper-case C) to record, in addition to the CCONNECT function calls, the contents of the input and output buffers.

t Transmission: Record the contents of the raw data buffers as they are dispatched to Caché. Raising the log level further to T (uppercase T) results in the raw response buffers being captured too. All non printable characters are recorded in their escaped form.
p[n]

Performance: Instructs Gateway to capture information to assess the performance of the CSP installation.

n is the number of seconds (total service time) below which data is not recorded for a request. For example, a directive of p records data for all requests, p2 records data for requests taking longer than 2 seconds to service.

The following information is recorded.

  • Total time to service request: The total time spent in servicing the request (from the time it reaches the Gateway to the time at which the last Byte of response data leaves the Gateway environment.

  • Obtain [NEW] connection to Caché: Time taken between the request reaching the Gateway and a connection to Caché being reserved for the purpose of servicing the request. The message recorded indicates if a new connection is created during this time (as opposed to an existing one being reused).

  • Send request to Caché: Time taken between the first and last Byte of request data being read from the web server and dispatched to Caché.

  • Processing request in Caché: Time taken between the last Byte of request data being dispatched to Caché and the first Byte of response data being received by the Gateway.

  • Receive response from Caché: Time taken between the first and last Byte of response data being received from Caché and dispatched to the web server.

pp[n]

Provides detailed timing information as follows:

  • Pre-processing of request: Time taken to identify the target Cache server; includes the initial handover from the web server and basic request processing to identify the server.

  • Obtain [NEW] connection to Cache: Time taken to allocate a connection to the appropriate Cache server. Indicates whether a new connection is created (instead of an existing one reused).

  • Format request: Time taken to parse and format the request message for transmission to Cache.

  • Send request to Cache: Time taken between the first and last byte of request data read from the web server and dispatched to Cache.

  • Processing request in Cache: Time taken between the last byte of request data dispatched to Cache and the first byte of response data received by the Gateway.

  • Post-processing of response(b): When a content-length header is required, this reports the time taken for the dispatch of the response data back to the client via the web server.

  • Post-processing of response(c): Time taken between the dispatch of the response and the Gateway being ready to read the response footer data from Cache. The footer data is part of the internal communication protocol between the Gateway and Cache and includes control information (For example: instructions to change the preserve setting for the session).

  • Receive footers from Cache: Time taken to receive the response footer data from Cache.

  • Post-processing of footers: Time taken to process footer data and respond to instructions received.

  • Release connection to Cache: Time taken to release the active connection to Cache.

  • Cleanup: Time taken to release resources used in servicing the request and return control back to the hosting web server.

FeedbackOpens in a new tab