Package io.honeycomb.beeline.spring.autoconfig

Class BeelineMetaFieldProvider

java.lang.Object

io.honeycomb.beeline.spring.autoconfig.BeelineMetaFieldProvider

All Implemented Interfaces:

EventListener, org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>

public class BeelineMetaFieldProvider
extends Object
implements org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>

This class class helps setting various "meta.*" fields so that all Spans and Events sent through the Beeline's HoneyClient contain them.

Laziness

Laziness here is used to avoid a circular dependency issue. Namely, this provider is required by the Beelines's HoneyClient. But the provider requires itself a list of all BeelineInstrumentations. BeelineInstrumentations in turn require HoneyClient to be already initialised.

To break this cycle, we use Spring's @Lazy annotation, which means the instrumentation list is effectively a placeholder and not usable until the application context is fully initialised - it will throw exceptions upon any interaction with it.

In order to make invocations of this class safe even before the context is ready, we use the isInit flag as a guard. It flips when we get the ContextRefreshedEvent.

Constructor Summary

Constructors

Constructor	Description
BeelineMetaFieldProvider(String packageName, String packageVersion, String beelineVersion, String localHostname, List<BeelineInstrumentation> instrumentations)

Method Summary

Modifier and Type	Method	Description
String	getBeelineVersion()
Map<String,io.honeycomb.libhoney.ValueSupplier<?>>	getDynamicFields()
int	getInstrumentationCount()
Set<String>	getInstrumentations()
String	getLocalHostname()
String	getPackageName()
String	getPackageVersion()
Map<String,?>	getStaticFields()
void	onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event)

Methods inherited from class java.lang.Object

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

Constructor Detail

BeelineMetaFieldProvider

public BeelineMetaFieldProvider(String packageName,
                                String packageVersion,
                                String beelineVersion,
                                String localHostname,
                                @Lazy
                                List<BeelineInstrumentation> instrumentations)

Method Detail

getPackageName

public String getPackageName()

getPackageVersion

public String getPackageVersion()

getBeelineVersion

public String getBeelineVersion()

getLocalHostname

@Nullable
public String getLocalHostname()

getInstrumentations

public Set<String> getInstrumentations()

getInstrumentationCount

public int getInstrumentationCount()

getDynamicFields

public Map<String,io.honeycomb.libhoney.ValueSupplier<?>> getDynamicFields()

getStaticFields

public Map<String,?> getStaticFields()

onApplicationEvent

public void onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>