Contents:
|
|
|
Event Details are accessed when clicking on an Event In the Dashboard and the Event List (The Event list for a selected server is also accessible from the System Health Tab.
Event Details are generated in accordance to Event Triggers. Event Details are a diagnostic tool that provides a complete audit trail and options for investigating and resolving events.
Event Details are viewed in several ways. The regular way of viewing events is from Platform. Events can be configured to be sent by e-mail recipients or to a URL (in XML format). However, Event Details always include the same information regardless of the viewed output (Regular Event Details, XML or e-mail).
Event Details
Event Details include five sections:
The information included in Event Details varies according to event type. For example: PHP Error Event Details include different information than a Slow Script Execution Event Details, simply because these events require different information to perform diagnostic analysis.
For example: A PHP Error will include in the General Information, the error’s text and in the Event Context, the Function’s Data. However, in a Slow Script Execution Error there is no need for the error text or the function’s data and there will be information on how long the script ran for, included files and the load average at the time of the event.
Note:
If there is not relevant data to display in an Event Details screen, the section will not be included rather than appearing empty.
The general information section of the Event Details provides basic information about the event (depending on the event’s type) as follows:
Event Details - General Information
Title - The top of the Event Details, displays the event that generated the Error and the Event ID (Error #). The Event ID can later be used, to locate the event in the Event List or the Console in the filter's Find section.
Severity Level - An additional notification is added to severe events.
Event Status - The Status of the event is indicated for all statuses except Opened.
Requested URL - The requested URL
Main Filename - The URL’s main file
Source File - The path to the Source File and line in the code that triggered the event.
Note:
Especially with code related errors, this information can provide an immediate indication to the source of the error in the code.
Trigger Value - The value type that triggered the event (runtime,output size,memory consumption etc.).
CPU Load - The CPU load when the event occurred.
Aggregate Hint - Shows the Aggregate Hint for this event
PHP Error - Shows the type of error that triggered the event.
*Not all the parameters (above) are included in all events, only in events that require this information.
To prevent an event from being continually reported for the same or similar event, PHP Intelligence enforces Aggregation Rules. These rules are based on a set of predetermined algorithms that determine which events are identical or are similar, to the extent they can be reported as a single Event. Aggregation Rules are also aware of events that occur on nodes belonging to a cluster (grouped servers).
Aggregation information is displayed in event details to identify the number of times the event occurred and in case of Groups the information is expanded to include the servers on which the event occurred and the number of occurrences.
Event Details - Event Occurrence Info
The Event Occurrence Info section shows, the total number of occurrences, the time and date of the first and last occurrence and the first server (and virtual host) on which the event occurred.
In cases where an event occurred on several servers belonging to the same group, an additional expandable list is added. This list displays occurrences per server, i.e. the server’s name, and total number of times the event occurred on the server.
Event Details - Aggregated Event
The Studio Diagnostics section shows the advanced diagnostic options that can be performed on the event’s data.
These diagnostic options reconstruct the precise conditions that generated the event by recreating the request with the same parameters that were in the original request (Information such as: GET/POST/COOKIE/etc.).
Note:
The recreation process will not create an additional event.
Event Details - Event Diagnostic Options
The diagnostic options that can be applied to event information are as follows:
Test URL - Loads the exact same URL from the event with the exact same parameters (GET/POST/COOKIE/HTTP HEADERS/etc.) and shows the script’s output in the browser.
Note:
The Test URL option does not require the Integration with Zend Studio.
Reproduce in Debugger - Initiates a Debug session of this URL in Studio.
Reproduce in Profiler - Profiles the URL, using the Studio Profiler with the same parameters (GET/POST/COOKIE/HTTP HEADERS/etc).
Show Source Code - Opens the file where the event occurred in Studio. This option provides a means for editing files and implementing changes to multiple servers using Studio.
Change Server - This link opens the "Event Diagnostics Settings" dialog. Through this dialog an event can be configured to be reproduced on a server other than the one that initially triggered the Event.
Important: Debug URL, Profile URL and Show Source Code can be activated when the following conditions are met:
Zend Debugger is installed on the server where the event occurred.
Studio is open.
The Platform Administration preferences (Zend Central | Preferences) are configured to the correct port (The port on which Studio is listening), the Studio IP is correct (the exact IP of the computer where Studio resides), and the Debugger allows a debug session from Platform Administration (by going to: Zend Central | Configure PHP Settings | Zend | Zend Debugger and verifying the correct IP/S in the zend_debugger.allow_hosts directive).
Event context includes relevant information available at the time of the occurrence. This information varies according to the type of event generated.
When defining Security settings for excluding information collected by PHP Intelligence the message <blocked value> will appear instead of variable's parameters.
There are four main Event context categories:
Event Details - Event Context
Sensitive content such as passwords and credit card details can be excluded from the Event Context. These parameters will be replaced by the message: <blocked value>.
To find out more about excluding values see "Security".
Function Data is only added to function related Event Details. This addition shows the function’s name and parameters at the time the event occurred.
The function always appears as a link. This link directs to the function’s description in the online PHP manual at: http://devzone.zend.com/manual
Note:
The link to the PHP manual also appears for user-defined functions. These functions naturally, will not be found in the PHP manual however, it is a good indication as to which functions are PHP functions and which are user-defined.
The information included in the Variables section, includes all variables data saved when the event occurred, such as: GET, POST, COOKIE, SERVER, etc.
The GET, POST, COOKIE and SERVER sections will always be displayed even if they are empty. This indicates that there was no available data at the time the event occurred.
Users may choose to change the type of information collected and displayed in an event (Change Event Details).
Backtrace only appears in function related events. The listed functions are the functions that lead to the actual function (occurrence) that triggered the error.
Functions are listed in chronological order from the most recent to the first function that was called.
There are two options for viewing Backtraced functions, in a pop-up screen or in Zend Studio.
- Shows the function call in a pop-up screen.
- Shows the function call in Zend Studio.
The Included Files section only appears in slow script error events. The files listed are all the files that are included in the PHP script that caused the error to occur.
Shows event data in the Event details in the form of an expandable text field. This option opens the file in the section of code where the event occurred.
To view the source code in Event Details:
Click Show Source Code to expand the text area.
Show Source Code
The Event Administration section includes all the actions that can be applied to an event. See Controlling Information Displayed in an Event, to learn how to disable these options for certain users.
Event Details - Event Administration Actions
The applicable actions (Buttons) are as follows:
Ignore - Ignores future instances of this event (i.e., changes the event status to ignore). Therefore, if the same event occurs again, Platform will not open a new event.
Preserve - Keeps the event in the database even during database cleanups.
Close - Closes the event (i.e., changes the event status to closed). Therefore, if this event occurs again, Platform will open a new event.
Delete - Deletes the event (i.e., removes the event entirely from the database.)
Reopen - Changes the event’s status from closed to open.
Report - Adds an additional dialog for selecting an action to apply to a single event. The options are Save as XML and e-mail (the e-mail address is as defined in PHP Intelligence | Event Actions in the Actions tab).
The ability to reproduce an Event on a different server provides an additional option for strengthening the link between development and production by enabling development teams to reproduce an event that occurred on a production server on a development server. Reproducing an Event on a development server will allow to diagnose and investigate the event without causing and additional disruption to the production server.
The "Reproduce Event on Another Server" option is only available from "Event Details".
Important: Reproduce Event on Another Server can be activated when the following conditions are met:
Zend Debugger is installed on the server where the event occurred.
Studio is open.
The Platform Administration preferences (Zend Central | Preferences) are configured to the correct port (The port on which Studio is listening), the Studio IP is correct (the exact IP of the computer where Studio resides), and the Debugger allows a debug session from Platform Administration (by going to: Zend Central | Configure PHP Settings | Zend | Zend Debugger and verifying the correct IP/S in the zend_debugger.allow_hosts directive).
|
|
|
|
|
Related Links: Choosing and Defining Event Triggers |
|
|
|
