Package org.forgerock.opendj.server.config.meta

Class OpenTelemetryPluginCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<OpenTelemetryPluginCfgClient,OpenTelemetryPluginCfg>
org.forgerock.opendj.server.config.meta.OpenTelemetryPluginCfgDefn
public final class OpenTelemetryPluginCfgDefn extends ManagedObjectDefinition<OpenTelemetryPluginCfgClient,OpenTelemetryPluginCfg>
An interface for querying the OpenTelemetry Plugin managed object definition meta information.

The OpenTelemetry Plugin configures the OpenTelemetry library within PingDS for collecting telemetry data and pushing it to an OTLP endpoint.

  • Method Details

    • getInstance

      public static OpenTelemetryPluginCfgDefn getInstance()
      Get the OpenTelemetry Plugin configuration definition singleton.
      Returns:
      Returns the OpenTelemetry Plugin configuration definition singleton.

    • createClientConfiguration

      public OpenTelemetryPluginCfgClient createClientConfiguration(ManagedObject<? extends OpenTelemetryPluginCfgClient> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.
      Specified by:
      createClientConfiguration in class ManagedObjectDefinition<OpenTelemetryPluginCfgClient,OpenTelemetryPluginCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

      public OpenTelemetryPluginCfg createServerConfiguration(ServerManagedObject<? extends OpenTelemetryPluginCfg> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a server configuration view of the provided server managed object.
      Specified by:
      createServerConfiguration in class ManagedObjectDefinition<OpenTelemetryPluginCfgClient,OpenTelemetryPluginCfg>
      Parameters:
      impl - The server managed object.
      Returns:
      Returns a server configuration view of the provided server managed object.

    • getServerConfigurationClass

      public Class<OpenTelemetryPluginCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<OpenTelemetryPluginCfgClient,OpenTelemetryPluginCfg>
      Returns:
      Returns the server configuration class instance associated with this managed object definition.

    • getEnabledPropertyDefinition

      public BooleanPropertyDefinition getEnabledPropertyDefinition()
      Get the "enabled" property definition.

      Indicates whether the plug-in is enabled for use.

      Returns:
      Returns the "enabled" property definition.

    • getInvokeForInternalOperationsPropertyDefinition

      public BooleanPropertyDefinition getInvokeForInternalOperationsPropertyDefinition()
      Get the "invoke-for-internal-operations" property definition.

      Indicates whether the plug-in should be invoked for internal operations.

      Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operations that can cause the same plug-in to be re-invoked.

      Returns:
      Returns the "invoke-for-internal-operations" property definition.

    • getJavaClassPropertyDefinition

      public ClassPropertyDefinition getJavaClassPropertyDefinition()
      Get the "java-class" property definition.

      Specifies the fully-qualified name of the Java class that provides the plug-in implementation.

      Returns:
      Returns the "java-class" property definition.

    • getKeyManagerProviderPropertyDefinition

      public AggregationPropertyDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg> getKeyManagerProviderPropertyDefinition()
      Get the "key-manager-provider" property definition.

      Specifies the name of the key manager that should be used with this OpenTelemetry Plugin.

      Returns:
      Returns the "key-manager-provider" property definition.

    • getPluginTypePropertyDefinition

      public EnumPropertyDefinition<PluginCfgDefn.PluginType> getPluginTypePropertyDefinition()
      Get the "plugin-type" property definition.

      Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.

      Returns:
      Returns the "plugin-type" property definition.

    • getSslCertNicknamePropertyDefinition

      public StringPropertyDefinition getSslCertNicknamePropertyDefinition()
      Get the "ssl-cert-nickname" property definition.

      Specifies the nicknames (also called the aliases) of the keys or key pairs that the OpenTelemetry Plugin should use when performing SSL communication.

      The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key. This is only applicable when the OpenTelemetry Plugin is configured to use SSL.

      Returns:
      Returns the "ssl-cert-nickname" property definition.

    • getTracerExporterBatchEnabledPropertyDefinition

      public BooleanPropertyDefinition getTracerExporterBatchEnabledPropertyDefinition()
      Get the "tracer-exporter-batch-enabled" property definition.

      Whether spans are exported in batches, or one at a time as they finish.

      Setting this value to "false" is highly discouraged unless you know what you're doing. This should only be used for troubleshooting very specific scenarios. It will cause all spans to be exported directly as they finish, meaning each export request will have a single

      Returns:
      Returns the "tracer-exporter-batch-enabled" property definition.

    • getTracerExporterBatchExporterTimeoutPropertyDefinition

      public DurationPropertyDefinition getTracerExporterBatchExporterTimeoutPropertyDefinition()
      Get the "tracer-exporter-batch-exporter-timeout" property definition.

      The maximum time an export will be allowed to run before being cancelled and spans are dropped.

      Returns:
      Returns the "tracer-exporter-batch-exporter-timeout" property definition.

    • getTracerExporterBatchMaxExportBatchSizePropertyDefinition

      public IntegerPropertyDefinition getTracerExporterBatchMaxExportBatchSizePropertyDefinition()
      Get the "tracer-exporter-batch-max-export-batch-size" property definition.

      The maximum number of spans that can be sent in a batch for each export.

      Returns:
      Returns the "tracer-exporter-batch-max-export-batch-size" property definition.

    • getTracerExporterBatchMaxQueueSizePropertyDefinition

      public IntegerPropertyDefinition getTracerExporterBatchMaxQueueSizePropertyDefinition()
      Get the "tracer-exporter-batch-max-queue-size" property definition.

      The maximum number of spans that are kept in the queue. Excess spans are dropped.

      Returns:
      Returns the "tracer-exporter-batch-max-queue-size" property definition.

    • getTracerExporterBatchScheduleDelayPropertyDefinition

      public DurationPropertyDefinition getTracerExporterBatchScheduleDelayPropertyDefinition()
      Get the "tracer-exporter-batch-schedule-delay" property definition.

      The interval between two consecutive exports.

      Returns:
      Returns the "tracer-exporter-batch-schedule-delay" property definition.

    • getTracerExporterConnectTimeoutPropertyDefinition

      public DurationPropertyDefinition getTracerExporterConnectTimeoutPropertyDefinition()
      Get the "tracer-exporter-connect-timeout" property definition.

      Maximum time to wait for new connections to be established

      Returns:
      Returns the "tracer-exporter-connect-timeout" property definition.

    • getTracerExporterExportUnsampledSpansPropertyDefinition

      public BooleanPropertyDefinition getTracerExporterExportUnsampledSpansPropertyDefinition()
      Get the "tracer-exporter-export-unsampled-spans" property definition.

      Whether unsampled spans should be exported.

      Returns:
      Returns the "tracer-exporter-export-unsampled-spans" property definition.

    • getTracerExporterHeaderPropertyDefinition

      public StringPropertyDefinition getTracerExporterHeaderPropertyDefinition()
      Get the "tracer-exporter-header" property definition.

      Headers that will be added to requests made to the OTLP endpoint.

      Returns:
      Returns the "tracer-exporter-header" property definition.

    • getTracerExporterOtlpEndpointPropertyDefinition

      public StringPropertyDefinition getTracerExporterOtlpEndpointPropertyDefinition()
      Get the "tracer-exporter-otlp-endpoint" property definition.

      Sets the OTLP/HTTP endpoint where the span exporter sends sampled spans.

      The endpoint must start with either http:// or https://, and include the full HTTP path.

      Returns:
      Returns the "tracer-exporter-otlp-endpoint" property definition.

    • getTracerExporterRetryBackoffMultiplierPropertyDefinition

      public StringPropertyDefinition getTracerExporterRetryBackoffMultiplierPropertyDefinition()
      Get the "tracer-exporter-retry-backoff-multiplier" property definition.

      The backoff multiplier

      Once the next random backoff interval has been chosen randomly, it is multiplied by this value.

      Returns:
      Returns the "tracer-exporter-retry-backoff-multiplier" property definition.

    • getTracerExporterRetryInitialBackoffPropertyDefinition

      public DurationPropertyDefinition getTracerExporterRetryInitialBackoffPropertyDefinition()
      Get the "tracer-exporter-retry-initial-backoff" property definition.

      The initial backoff before retrying exporting spans

      Returns:
      Returns the "tracer-exporter-retry-initial-backoff" property definition.

    • getTracerExporterRetryMaxAttemptsPropertyDefinition

      public IntegerPropertyDefinition getTracerExporterRetryMaxAttemptsPropertyDefinition()
      Get the "tracer-exporter-retry-max-attempts" property definition.

      The maximum number of attempts to retry exporting spans, including the original request.

      After the maximum number of unsuccessful attempts is reached, the spans are dropped.

      Returns:
      Returns the "tracer-exporter-retry-max-attempts" property definition.

    • getTracerExporterRetryMaxBackoffPropertyDefinition

      public DurationPropertyDefinition getTracerExporterRetryMaxBackoffPropertyDefinition()
      Get the "tracer-exporter-retry-max-backoff" property definition.

      Set the maximum backoff interval before attempting again to export spans.

      The next random backoff interval is chosen randomly, whose upper bound is the maximum backoff interval.

      Returns:
      Returns the "tracer-exporter-retry-max-backoff" property definition.

    • getTracerExporterTimeoutPropertyDefinition

      public DurationPropertyDefinition getTracerExporterTimeoutPropertyDefinition()
      Get the "tracer-exporter-timeout" property definition.

      Maximum time to wait for the collector to process an exported batch of spans

      Returns:
      Returns the "tracer-exporter-timeout" property definition.

    • getTracerSamplerPropertyDefinition

      public EnumPropertyDefinition<OpenTelemetryPluginCfgDefn.TracerSampler> getTracerSamplerPropertyDefinition()
      Get the "tracer-sampler" property definition.

      The strategy used by the span exporter to sample spans. The sampling strategy is evaluated each time a span is started.

      Returns:
      Returns the "tracer-sampler" property definition.

    • getTracerSamplerRatioPropertyDefinition

      public IntegerPropertyDefinition getTracerSamplerRatioPropertyDefinition()
      Get the "tracer-sampler-ratio" property definition.

      The sampling ratio (as a percentage) when the "traceidratio" or "parentbased-traceidratio" samplers are used.

      Returns:
      Returns the "tracer-sampler-ratio" property definition.

    • getTracerSpanAttributeCountLimitPropertyDefinition

      public IntegerPropertyDefinition getTracerSpanAttributeCountLimitPropertyDefinition()
      Get the "tracer-span-attribute-count-limit" property definition.

      The maximum number of attributes recorded per span. Excess attributes are dropped.

      Returns:
      Returns the "tracer-span-attribute-count-limit" property definition.

    • getTracerSpanAttributeCountLimitPerEventPropertyDefinition

      public IntegerPropertyDefinition getTracerSpanAttributeCountLimitPerEventPropertyDefinition()
      Get the "tracer-span-attribute-count-limit-per-event" property definition.

      The maximum number of attributes recorded per event. Excess attributes are dropped.

      Returns:
      Returns the "tracer-span-attribute-count-limit-per-event" property definition.

    • getTracerSpanAttributeCountLimitPerLinkPropertyDefinition

      public IntegerPropertyDefinition getTracerSpanAttributeCountLimitPerLinkPropertyDefinition()
      Get the "tracer-span-attribute-count-limit-per-link" property definition.

      The maximum number of attributes recorded per link. Excess attributes are dropped.

      Returns:
      Returns the "tracer-span-attribute-count-limit-per-link" property definition.

    • getTracerSpanEventCountLimitPropertyDefinition

      public IntegerPropertyDefinition getTracerSpanEventCountLimitPropertyDefinition()
      Get the "tracer-span-event-count-limit" property definition.

      The maximum number of events per span. Excess events are dropped.

      Returns:
      Returns the "tracer-span-event-count-limit" property definition.

    • getTracerSpanLinkCountLimitPropertyDefinition

      public IntegerPropertyDefinition getTracerSpanLinkCountLimitPropertyDefinition()
      Get the "tracer-span-link-count-limit" property definition.

      The maximum number of links per span. Excess links are dropped.

      Returns:
      Returns the "tracer-span-link-count-limit" property definition.

    • getTrustManagerProviderPropertyDefinition

      public AggregationPropertyDefinition<TrustManagerProviderCfgClient,TrustManagerProviderCfg> getTrustManagerProviderPropertyDefinition()
      Get the "trust-manager-provider" property definition.

      Specifies the name of the trust manager that should be used when negotiating SSL connections with the remote authorization server.

      Returns:
      Returns the "trust-manager-provider" property definition.