com.mantledillusion.metrics.trail.GeneralVaadinMetrics Maven / Gradle / Ivy
Show all versions of trail-metrics-support-vaadin-core Show documentation
package com.mantledillusion.metrics.trail;
import com.mantledillusion.metrics.trail.api.Event;
/**
* Enum for all {@link Event} types that are thrown by the metrics system itself.
*
* The {@link Event#getIdentifier()} of each entry is always the {@link Enum#name()} in lower case with '_' replaced
* to '.' and prefixed by {@value #METRICS_DOMAIN}.
*
* For example the name of {@link #SESSION_BEGIN} is 'general.session.begin'.
*/
public enum GeneralVaadinMetrics implements EnumeratedEvent {
/**
* The {@link Event} an observer creates when a new session is started.
*
* Contains the attributes:
* - {@link AbstractVaadinMetricsTrailSupport#ATTRIBUTE_KEY_SESSION_ID}: The session ID
*/
SESSION_BEGIN,
/**
* The {@link Event} an observer creates when a session ends.
*/
SESSION_END,
/**
* The {@link Event} an observer creates about the browser beginning a session.
*
* Contains the attributes:
* - {@link BrowserInfo#ATTRIBUTE_KEY_APPLICATION}: The application name
* - {@link BrowserInfo#ATTRIBUTE_KEY_TYPE}: The {@link BrowserInfo.BrowserType}
* - {@link BrowserInfo#ATTRIBUTE_KEY_VERSION}: The browser's version
* - {@link BrowserInfo#ATTRIBUTE_KEY_ENVIRONMENT}: The {@link BrowserInfo.SystemEnvironmentType}
*/
BROWSER_INFO,
/**
* The {@link Event} an observer creates when the URL changes.
*
* Contains the attributes:
* - {@link AbstractVaadinMetricsTrailSupport#ATTRIBUTE_KEY_PATH}: The path navigated to
* - {@link AbstractVaadinMetricsTrailSupport#ATTRIBUTE_KEY_PARAM_PREFIX}[query parameter key]: Query parameter values, comma separated
*/
NAVIGATION,
/**
* The {@link Event} an {@link AbstractMetricsWrappingErrorHandler} creates when an uncatched {@link Throwable} occurs.
*
* Contains the attributes:
* - {@link AbstractMetricsWrappingErrorHandler#ATTRIBUTE_KEY_SIMPLE_TYPE} : The simple name of the {@link Throwable}'s class
* - {@link AbstractMetricsWrappingErrorHandler#ATTRIBUTE_KEY_TYPE} : The fully qualified class name of the {@link Throwable}'s class
* - {@link AbstractMetricsWrappingErrorHandler#ATTRIBUTE_KEY_MESSAGE} : The {@link Throwable}'s message
* - {@link AbstractMetricsWrappingErrorHandler#ATTRIBUTE_KEY_STACKTRACE} : The {@link Throwable}'s stack trace
*/
ERROR;
public static final String METRICS_DOMAIN = "vaadin.";
@Override
public String getPrefix() {
return METRICS_DOMAIN;
}
}