debug.ErrorReporter Extends goog.events.EventTarget
Constructs an error reporter. Internal Use Only. To install an error reporter see the method below.

Inheritance

Constructor

goog.debug.ErrorReporter(handlerUrlopt_contextProvideropt_noAutoProtect)

Parameters

handlerUrl : string
The URL to which all errors will be reported.
opt_contextProvider : function(!Error, !Object.<string, string>)>
When a report is to be sent to the server, this method will be called, and given an opportunity to modify the context object before submission to the server.
opt_noAutoProtect : boolean=
Whether to automatically add handlers for onerror and to protect entry points. If apps have other error reporting facilities, it may make sense for them to set these up themselves and use the ErrorReporter just for transmission of reports.

Instance Methods

Public Protected Private
contextProvider_()
Context provider, if one was provided.
code »
disposeInternal()
No description.
code »
handleException(eopt_context)
Handler for caught exceptions. Sends report to the LoggingServlet and notifies any listeners.
Arguments:
e : Object
The exception.
opt_context : !Object.<string, string>>
Context values to optionally include in the error report.
code »
protectAdditionalEntryPoint(fn) Function
Installs exception protection for an entry point function in addition to those that are protected by default. Has no effect in IE because window.onerror is used for reporting exceptions in that case.
Arguments:
fn : Function
An entry point function to be protected.
Returns: Function  A protected wrapper function that calls the entry point function or null if the entry point could not be protected.
code »
sendErrorReport(messagefileNamelineopt_traceopt_context)
Sends an error report to the logging URL. This will not consult the context provider, the report will be sent exactly as specified.
Arguments:
message : string
Error description.
fileName : string
URL of the JavaScript file with the error.
line : number
Line number of the error.
opt_trace : string=
Call stack trace of the error.
opt_context : !Object.<string, string>>
Context information to include in the request.
code »
setAdditionalArguments(urlArgs)
No description.
Arguments:
urlArgs : !Object.<string,string>
Set of key-value pairs to append to handlerUrl_ before sending XHR.
code »
setContextPrefix(prefix)
No description.
Arguments:
prefix : string
The prefix to appear prepended to all context variables in the error report body.
code »
setLoggingHeaders(loggingHeaders)
Add headers to the logging url.
Arguments:
loggingHeaders : Object | goog.structs.Map
Extra headers to send to the logging URL.
code »
setTruncationLimit(limit)
No description.
Arguments:
limit : ?number
Size in bytes to begin truncating POST body. Set to null to prevent truncation. The limit must be >= 0.
code »
setXhrSender(xhrSender)
Set the function used to send error reports to the server.
Arguments:
xhrSender : function(string, string, string, (Object | goog.structs.Map)=)
If provided, this will be used to send a report to the server instead of the default method. The function will be given the URI, HTTP method request content, and (optionally) request headers to be added.
code »
setup_()
Sets up the error reporter.
code »
xhrSender_()
XHR sender.
code »
addEventListener(typeopt_captureopt_handlerScope)
Use #listen instead, when possible. Otherwise, use goog.events.listen if you are passing Object (instead of Function) as handler. Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
opt_capture : boolean=
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope : Object=
Object in whose scope to call the listener.
code »
assertInitialized_()
Asserts that the event target instance is initialized properly.
code »
dispatchEvent()
No description.
code »
disposeInternal()
Removes listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.
code »
fireListeners()
No description.
code »
getListener()
No description.
code »
getListeners()
No description.
code »
getParentEventTarget() goog.events.EventTarget
Returns the parent of this event target to use for bubbling.
Returns: goog.events.EventTarget  The parent EventTarget or null if there is no parent.
code »
hasListener()
No description.
code »
listen()
No description.
code »
listenOnce()
No description.
code »
removeAllListeners()
No description.
code »
removeEventListener(typeopt_captureopt_handlerScope)
Use #unlisten instead, when possible. Otherwise, use goog.events.unlisten if you are passing Object (instead of Function) as handler. Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
opt_capture : boolean=
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope : Object=
Object in whose scope to call the listener.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for capture/bubble mechanism.
Arguments:
parent : goog.events.EventTarget
Parent listenable (null if none).
code »
setTargetForTesting(target)
Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.
Arguments:
target : !Object
The target.
code »
unlisten()
No description.
code »
unlistenByKey()
No description.
code »
addOnDisposeCallback(callbackopt_scope)
Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.
Arguments:
callback : function(this:T):?
The callback function.
opt_scope : T=
An optional scope to call the callback in.
code »
dispose() void
Disposes of the object. If the object hasn't already been disposed of, calls #disposeInternal. Classes that extend goog.Disposable should override #disposeInternal in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.
Returns: void  Nothing.
code »
disposeInternal()
Deletes or nulls out any references to COM objects, DOM nodes, or other disposable objects. Classes that extend goog.Disposable should override this method. Not reentrant. To avoid calling it twice, it must only be called from the subclass' disposeInternal method. Everywhere else the public dispose method must be used. For example:
  mypackage.MyClass = function() {
    mypackage.MyClass.base(this, 'constructor');
    // Constructor logic specific to MyClass.
    ...
  };
  goog.inherits(mypackage.MyClass, goog.Disposable);

  mypackage.MyClass.prototype.disposeInternal = function() {
    // Dispose logic specific to MyClass.
    ...
    // Call superclass's disposeInternal at the end of the subclass's, like
    // in C++, to avoid hard-to-catch issues.
    mypackage.MyClass.base(this, 'disposeInternal');
  };
code »
getDisposed() boolean
Use #isDisposed instead. No description.
Returns: boolean  Whether the object has been disposed of.
code »
isDisposed() boolean
No description.
Returns: boolean  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable : goog.disposable.IDisposable
that will be disposed when this object is disposed.
code »

Instance Properties

additionalArguments_ :
Additional arguments to append to URL before sending XHR.
Code »
constructor :
No description.
Code »
contextPrefix_ :
The string prefix of any optional context parameters logged with the error.
Code »
errorHandler_ : goog.debug.ErrorHandler
The internal error handler used to catch all errors.
Code »
extraHeaders_ :
Extra headers for the error-reporting XHR.
Code »
handlerUrl_ :
The URL at which all errors caught by this handler will be logged.
Code »
truncationLimit_ :
The number of bytes after which the ErrorReporter truncates the POST body. If null, the ErrorReporter won't truncate the body.
Code »
actualEventTarget_ : goog.events.EventTarget
The object to use for event.target. Useful when mixing in an EventTarget to another object.
Code »
constructor :
No description.
Code »
eventTargetListeners_ : goog.events.ListenerMap
Maps of event type to an array of listeners.
Code »
parentEventTarget_ : goog.events.EventTarget
Parent event target, used during event bubbling. TODO(user): Change this to goog.events.Listenable. This currently breaks people who expect getParentEventTarget to return goog.events.EventTarget.
Code »
creationStack :
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
Code »
disposed_ :
Whether the object has been disposed of.
Code »
onDisposeCallbacks_ :
Callbacks to invoke when this object is disposed.
Code »

Static Methods

goog.debug.ErrorReporter.defaultXhrSender(urimethodcontentopt_headers)
Default implementation of XHR sender interface.
Arguments:
uri : string
URI to make request to.
method : string
Send method.
content : string
Post data.
opt_headers : Object | goog.structs.Map=
Map of headers to add to the request.
code »
goog.debug.ErrorReporter.install(loggingUrlopt_contextProvideropt_noAutoProtect) !goog.debug.ErrorReporter
Installs an error reporter to catch all JavaScript errors raised.
Arguments:
loggingUrl : string
The URL to which the errors caught will be reported.
opt_contextProvider : function(!Error, !Object.<string, string>)>
When a report is to be sent to the server, this method will be called, and given an opportunity to modify the context object before submission to the server.
opt_noAutoProtect : boolean=
Whether to automatically add handlers for onerror and to protect entry points. If apps have other error reporting facilities, it may make sense for them to set these up themselves and use the ErrorReporter just for transmission of reports.
Returns: !goog.debug.ErrorReporter  The error reporter.
code »

Static Properties

goog.debug.ErrorReporter.ALLOW_AUTO_PROTECT :
No description.
Code »
goog.debug.ErrorReporter.logger_ : goog.debug.Logger
Logging object.
Code »
goog.debug.ErrorReporter.superClass_ :
No description.
Code »

Package debug

Package Reference