Package io.micronaut.starter.feature.opentelemetry

Class OpenTelemetryExporterFeature

java.lang.Object

io.micronaut.starter.feature.opentelemetry.OpenTelemetryExporterFeature

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, OpenTelemetryFeature

Direct Known Subclasses:

OpenTelemetryExporterGoogleCloudTrace, OpenTelemetryExporterJaeger, OpenTelemetryExporterLogging, OpenTelemetryExporterOtlp, OpenTelemetryExporterZipkin

public abstract class OpenTelemetryExporterFeature
extends Object
implements OpenTelemetryFeature

Field Summary

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
OpenTelemetryExporterFeature()

Method Summary

Modifier and Type	Method	Description
protected void	addConfiguration(GeneratorContext generatorContext)
void	apply(GeneratorContext generatorContext)	If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
protected @NonNull String	exporterArtifactId()
protected @NonNull Dependency	exporterDependency()
protected abstract @NonNull String	exporterName()
protected @NonNull String	exporterValue()
@NonNull String	getDescription()
String	getMicronautDocumentation()
@NonNull String	getName()	The name of the feature.
@NonNull String	getTitle()
boolean	isVisible()	Some features should not be visible to the user because they are a common parent of other selectable features, or they should always be applied, or any other reason.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.naming.Described

getDescription

Methods inherited from interface io.micronaut.starter.feature.Feature

getOrder, isCommunity, isPreview, processSelectedFeatures

Methods inherited from interface io.micronaut.starter.feature.opentelemetry.OpenTelemetryFeature

getCategory, getThirdPartyDocumentation, supports

Constructor Details

OpenTelemetryExporterFeature

public OpenTelemetryExporterFeature()

Method Details

isVisible

public boolean isVisible()

Description copied from interface: Feature

Some features should not be visible to the user because they are a common parent of other selectable features, or they should always be applied, or any other reason.

Specified by:

isVisible in interface Feature

Returns:

True if the feature should able to be selected by the user

getName

@NonNull
public @NonNull String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Specified by:

getName in interface Feature

Specified by:

getName in interface io.micronaut.core.naming.Named

Specified by:

getName in interface OpenTelemetryFeature

Returns:

the name of the feature

getTitle

@NonNull
public @NonNull String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

@NonNull
public @NonNull String getDescription()

Specified by:

getDescription in interface io.micronaut.core.naming.Described

Specified by:

getDescription in interface Feature

apply

public void apply(GeneratorContext generatorContext)

Description copied from interface: Feature

If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature). At this point the feature list is set and cannot change. This method can be implemented to modify the generated project. The feature can add templates by executing GeneratorContext.addTemplate(String, io.micronaut.starter.template.Template), modify configuration by modifying GeneratorContext.getConfiguration() or GeneratorContext.getBootstrapConfiguration(), or modify build properties through GeneratorContext.getBuildProperties().

Specified by:

apply in interface Feature

Parameters:

generatorContext - THe generator context

addConfiguration

protected void addConfiguration(GeneratorContext generatorContext)

exporterValue

@NonNull
protected @NonNull String exporterValue()

exporterDependency

@NonNull
protected @NonNull Dependency exporterDependency()

getMicronautDocumentation

public String getMicronautDocumentation()

Specified by:

getMicronautDocumentation in interface Feature

Specified by:

getMicronautDocumentation in interface OpenTelemetryFeature

Returns:

Returns a link to Micronaut documentation about the feature. eg. https://micronaut-projects.github.io/micronaut-cache/latest/guide/index.html#hazelcast

exporterName

@NonNull
protected abstract @NonNull String exporterName()

exporterArtifactId

@NonNull
protected @NonNull String exporterArtifactId()