Package io.opentelemetry.sdk.trace.config

Class TraceConfig.Builder

    • Method Detail

      • fromConfigMap

        protected TraceConfig.Builder fromConfigMap​(Map<String,​String> configMap,
                                            io.opentelemetry.sdk.common.export.ConfigBuilder.NamingConvention namingConvention)
        Sets the configuration values from the given configuration map for only the available keys.
        Specified by:
        fromConfigMap in class io.opentelemetry.sdk.common.export.ConfigBuilder<TraceConfig.Builder>
        Parameters:
        configMap - Map holding the configuration values.
        Returns:
        this

      • readProperties

        public TraceConfig.Builder readProperties​(Properties properties)
        * Sets the configuration values from the given properties object for only the available keys.
        Overrides:
        readProperties in class io.opentelemetry.sdk.common.export.ConfigBuilder<TraceConfig.Builder>
        Parameters:
        properties - Properties holding the configuration values.
        Returns:
        this

      • readEnvironmentVariables

        public TraceConfig.Builder readEnvironmentVariables()
        * Sets the configuration values from environment variables for only the available keys.
        Overrides:
        readEnvironmentVariables in class io.opentelemetry.sdk.common.export.ConfigBuilder<TraceConfig.Builder>
        Returns:
        this.

      • readSystemProperties

        public TraceConfig.Builder readSystemProperties()
        * Sets the configuration values from system properties for only the available keys.
        Overrides:
        readSystemProperties in class io.opentelemetry.sdk.common.export.ConfigBuilder<TraceConfig.Builder>
        Returns:
        this.

      • setSampler

        public abstract TraceConfig.Builder setSampler​(Sampler sampler)
        Sets the global default Sampler. It must be not null otherwise build() will throw an exception.
        Parameters:
        sampler - the global default Sampler.
        Returns:
        this.

      • setTraceIdRatioBased

        public TraceConfig.Builder setTraceIdRatioBased​(double samplerRatio)
        Sets the global default Sampler. It must be not null otherwise build() will throw an exception.
        Parameters:
        samplerRatio - the global default ratio used to make decisions on Span sampling.
        Returns:
        this.

      • setMaxNumberOfAttributes

        public abstract TraceConfig.Builder setMaxNumberOfAttributes​(int maxNumberOfAttributes)
        Sets the global default max number of attributes per Span.
        Parameters:
        maxNumberOfAttributes - the global default max number of attributes per Span. It must be positive otherwise build() will throw an exception.
        Returns:
        this.

      • setMaxNumberOfEvents

        public abstract TraceConfig.Builder setMaxNumberOfEvents​(int maxNumberOfEvents)
        Sets the global default max number of events per Span.
        Parameters:
        maxNumberOfEvents - the global default max number of events per Span. It must be positive otherwise build() will throw an exception.
        Returns:
        this.

      • setMaxNumberOfLinks

        public abstract TraceConfig.Builder setMaxNumberOfLinks​(int maxNumberOfLinks)
        Sets the global default max number of links per Span.
        Parameters:
        maxNumberOfLinks - the global default max number of links per Span. It must be positive otherwise build() will throw an exception.
        Returns:
        this.

      • setMaxNumberOfAttributesPerEvent

        public abstract TraceConfig.Builder setMaxNumberOfAttributesPerEvent​(int maxNumberOfAttributesPerEvent)
        Sets the global default max number of attributes per event.
        Parameters:
        maxNumberOfAttributesPerEvent - the global default max number of attributes per event. It must be positive otherwise build() will throw an exception.
        Returns:
        this.

      • setMaxNumberOfAttributesPerLink

        public abstract TraceConfig.Builder setMaxNumberOfAttributesPerLink​(int maxNumberOfAttributesPerLink)
        Sets the global default max number of attributes per link.
        Parameters:
        maxNumberOfAttributesPerLink - the global default max number of attributes per link. It must be positive otherwise build() will throw an exception.
        Returns:
        this.

      • setMaxLengthOfAttributeValues

        public abstract TraceConfig.Builder setMaxLengthOfAttributeValues​(int maxLengthOfAttributeValues)
        Sets the global default max length of string attribute value in characters.
        Parameters:
        maxLengthOfAttributeValues - the global default max length of string attribute value in characters. It must be non-negative (or TraceConfig.UNLIMITED_ATTRIBUTE_LENGTH) otherwise build() will throw an exception.
        Returns:
        this.

      • build

        public TraceConfig build()
        Builds and returns a TraceConfig with the desired values.
        Returns:
        a TraceConfig with the desired values.
        Throws:
        IllegalArgumentException - if any of the max numbers are not positive.