Skip to content

Support for caching the parsed user agent values #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 31, 2021
Merged

Support for caching the parsed user agent values #241

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63c304a
Support for caching the parsed user agent values
avinashkolluru Jul 30, 2021
8399df3
Merge branch 'main' into optimize_ua_parser
avinashkolluru Jul 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 39 additions & 2 deletions ...rc/main/java/org/hypertrace/traceenricher/enrichment/enrichers/UserAgentSpanEnricher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
package org.hypertrace.traceenricher.enrichment.enrichers;

import com.google.common.cache.CacheBuilder;
import com.google.common.cache.CacheLoader;
import com.google.common.cache.LoadingCache;
import com.typesafe.config.Config;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
import javax.annotation.ParametersAreNonnullByDefault;
import net.sf.uadetector.ReadableUserAgent;
import net.sf.uadetector.UserAgentStringParser;
import net.sf.uadetector.service.UADetectorServiceFactory;
Expand All @@ -16,11 +22,39 @@
import org.hypertrace.traceenricher.enrichedspan.constants.v1.Protocol;
import org.hypertrace.traceenricher.enrichedspan.constants.v1.UserAgent;
import org.hypertrace.traceenricher.enrichment.AbstractTraceEnricher;
import org.hypertrace.traceenricher.enrichment.clients.ClientRegistry;

public class UserAgentSpanEnricher extends AbstractTraceEnricher {

private UserAgentStringParser userAgentStringParser =
private static final String CACHE_CONFIG_KEY = "cache";
private static final String CACHE_CONFIG_MAX_SIZE = "maxSize";
private static final int CACHE_MAX_SIZE_DEFAULT = 10000;
private final UserAgentStringParser userAgentStringParser =
UADetectorServiceFactory.getResourceModuleParser();
@Nullable private LoadingCache<String, ReadableUserAgent> userAgentCache;

@Override
public void init(Config enricherConfig, ClientRegistry clientRegistry) {
if (enricherConfig.hasPath(CACHE_CONFIG_KEY)) {
Config enricherCacheConfig = enricherConfig.getConfig(CACHE_CONFIG_KEY);
int cacheSize =
enricherCacheConfig.hasPath(CACHE_CONFIG_MAX_SIZE)
? enricherCacheConfig.getInt(CACHE_CONFIG_MAX_SIZE)
: CACHE_MAX_SIZE_DEFAULT;
userAgentCache =
CacheBuilder.newBuilder()
.maximumSize(cacheSize)
.recordStats()
.build(
new CacheLoader<>() {
@Override
@ParametersAreNonnullByDefault
public ReadableUserAgent load(String userAgentString) {
return userAgentStringParser.parse(userAgentString);
}
});
}
}

@Override
public void enrichEvent(StructuredTrace trace, Event event) {
Expand All @@ -37,7 +71,10 @@ public void enrichEvent(StructuredTrace trace, Event event) {
Optional<String> mayBeUserAgent = getUserAgent(event);

if (mayBeUserAgent.isPresent()) {
ReadableUserAgent userAgent = userAgentStringParser.parse(mayBeUserAgent.get());
ReadableUserAgent userAgent =
userAgentCache != null
? userAgentCache.getUnchecked(mayBeUserAgent.get())
: userAgentStringParser.parse(mayBeUserAgent.get());
addEnrichedAttribute(
event,
EnrichedSpanConstants.getValue(UserAgent.USER_AGENT_NAME),
Expand Down