com.atlassian.analytics.client.extractor

Class PropertyExtractorHelper

java.lang.Object

com.atlassian.analytics.client.extractor.PropertyExtractorHelper

Direct Known Subclasses:

CoreJavaPropertyExtractorHelper

public class PropertyExtractorHelper
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	excludeProperties
protected Iterable<PropertyContributor>	propertyDecorators

Constructor Summary

Constructors

Constructor and Description
PropertyExtractorHelper(Set<String> excludeProperties, PropertyContributor... propertyContributors)

Method Summary

Modifier and Type	Method and Description
String	extractName(Object event)
Map<String,Object>	extractProperty(String name, Object value)
String	extractRequestCorrelationId(RequestInfo requestInfo)
String	extractSubProduct(Object event, String product) Produce a 'sub product' identifier that can help identify exactly where this event comes from.
boolean	isExcluded(String name)
protected void	putNonCoreJavaTypes(com.google.common.collect.ImmutableMap.Builder<String,Object> result, String name, Object value) Put types in addition to the core Java types.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

propertyDecorators

protected final Iterable<PropertyContributor> propertyDecorators

excludeProperties

protected final Set<String> excludeProperties

Constructor Detail

PropertyExtractorHelper

public PropertyExtractorHelper(Set<String> excludeProperties,
                               PropertyContributor... propertyContributors)

Method Detail

extractProperty

public Map<String,Object> extractProperty(String name,
                                          Object value)

putNonCoreJavaTypes

protected void putNonCoreJavaTypes(com.google.common.collect.ImmutableMap.Builder<String,Object> result,
                                   String name,
                                   Object value)

Put types in addition to the core Java types.

isExcluded

public boolean isExcluded(String name)

extractSubProduct

public String extractSubProduct(Object event,
                                String product)

Produce a 'sub product' identifier that can help identify exactly where this event comes from.

In some cases event names overlap, for example usercreated from embedded Crowd and the JIRA user event. In these cases we need to include some mechanism to disambiguate them.

This method tries to strike a balance between specificity, readability and size. For this reason we take the package name then: - If it's a BrowserEvent make it just 'browser' - Strip any com?.atlassian?.(product e.g 'jira')? at the start - Remove the words 'event(s)' or 'plugin(s)' from any components of the package

Some examples: - com.atlassian.confluence.plugins.macros.dashboard.recentupdates.events.DashboardRecentlyUpdatedViewEvent = macros.dashboard.recentupdates - com.atlassian.confluence.event.events.content.mail.notification.SpaceNotificationRemovedEvent = content.mail.notification - com.atlassian.crowd.event.monitor.poller.PollingFinishedEvent = crowd.monitor.poller - com.fakevendor.events.UserCreatedEvent = fakevendor - com.atlassian.jira.event.config.ApplicationPropertyChangeEvent = config

N.B. Client side events will all show 'browser' because they are processed by the same endpoint in this plugin (and use a com.atlassian.analytics.client.api.browser.BrowserEvent). There's nothing we can do really, we could try to introspect the Javascript stack to see which .js file triggered the event (by overriding the push prototype on the AJS.EventQueue array), but this is very problematic cross browser (and not possible at all in IE less than 10)

extractName

public String extractName(Object event)

extractRequestCorrelationId

@Nullable
public String extractRequestCorrelationId(RequestInfo requestInfo)