Class OTLPConfig

    • Constructor Detail

      • OTLPConfig

        public OTLPConfig()
        No args constructor for use in serialization
      • OTLPConfig

        public OTLPConfig​(Boolean convertHistogramsToNHCB,
                          List<String> ignoreResourceAttributes,
                          Boolean keepIdentifyingResourceAttributes,
                          Boolean promoteAllResourceAttributes,
                          List<String> promoteResourceAttributes,
                          Boolean promoteScopeMetadata,
                          String translationStrategy)
    • Method Detail

      • getConvertHistogramsToNHCB

        public Boolean getConvertHistogramsToNHCB()
        convertHistogramsToNHCB defines optional translation of OTLP explicit bucket histograms into native histograms with custom buckets. It requires Prometheus >= v3.4.0.
      • setConvertHistogramsToNHCB

        public void setConvertHistogramsToNHCB​(Boolean convertHistogramsToNHCB)
        convertHistogramsToNHCB defines optional translation of OTLP explicit bucket histograms into native histograms with custom buckets. It requires Prometheus >= v3.4.0.
      • getIgnoreResourceAttributes

        public List<String> getIgnoreResourceAttributes()
        ignoreResourceAttributes defines the list of OpenTelemetry resource attributes to ignore when `promoteAllResourceAttributes` is true.


        It requires `promoteAllResourceAttributes` to be true. It requires Prometheus >= v3.5.0.

      • setIgnoreResourceAttributes

        public void setIgnoreResourceAttributes​(List<String> ignoreResourceAttributes)
        ignoreResourceAttributes defines the list of OpenTelemetry resource attributes to ignore when `promoteAllResourceAttributes` is true.


        It requires `promoteAllResourceAttributes` to be true. It requires Prometheus >= v3.5.0.

      • getKeepIdentifyingResourceAttributes

        public Boolean getKeepIdentifyingResourceAttributes()
        keepIdentifyingResourceAttributes enables adding `service.name`, `service.namespace` and `service.instance.id` resource attributes to the `target_info` metric, on top of converting them into the `instance` and `job` labels.


        It requires Prometheus >= v3.1.0.

      • setKeepIdentifyingResourceAttributes

        public void setKeepIdentifyingResourceAttributes​(Boolean keepIdentifyingResourceAttributes)
        keepIdentifyingResourceAttributes enables adding `service.name`, `service.namespace` and `service.instance.id` resource attributes to the `target_info` metric, on top of converting them into the `instance` and `job` labels.


        It requires Prometheus >= v3.1.0.

      • getPromoteAllResourceAttributes

        public Boolean getPromoteAllResourceAttributes()
        promoteAllResourceAttributes promotes all resource attributes to metric labels except the ones defined in `ignoreResourceAttributes`.


        Cannot be true when `promoteResourceAttributes` is defined. It requires Prometheus >= v3.5.0.

      • setPromoteAllResourceAttributes

        public void setPromoteAllResourceAttributes​(Boolean promoteAllResourceAttributes)
        promoteAllResourceAttributes promotes all resource attributes to metric labels except the ones defined in `ignoreResourceAttributes`.


        Cannot be true when `promoteResourceAttributes` is defined. It requires Prometheus >= v3.5.0.

      • getPromoteResourceAttributes

        public List<String> getPromoteResourceAttributes()
        promoteResourceAttributes defines the list of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none. Cannot be defined when `promoteAllResourceAttributes` is true.
      • setPromoteResourceAttributes

        public void setPromoteResourceAttributes​(List<String> promoteResourceAttributes)
        promoteResourceAttributes defines the list of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none. Cannot be defined when `promoteAllResourceAttributes` is true.
      • getPromoteScopeMetadata

        public Boolean getPromoteScopeMetadata()
        promoteScopeMetadata controls whether to promote OpenTelemetry scope metadata (i.e. name, version, schema URL, and attributes) to metric labels. As per the OpenTelemetry specification, the aforementioned scope metadata should be identifying, i.e. made into metric labels. It requires Prometheus >= v3.6.0.
      • setPromoteScopeMetadata

        public void setPromoteScopeMetadata​(Boolean promoteScopeMetadata)
        promoteScopeMetadata controls whether to promote OpenTelemetry scope metadata (i.e. name, version, schema URL, and attributes) to metric labels. As per the OpenTelemetry specification, the aforementioned scope metadata should be identifying, i.e. made into metric labels. It requires Prometheus >= v3.6.0.
      • getTranslationStrategy

        public String getTranslationStrategy()
        translationStrategy defines how the OTLP receiver endpoint translates the incoming metrics.


        It requires Prometheus >= v3.0.0.

      • setTranslationStrategy

        public void setTranslationStrategy​(String translationStrategy)
        translationStrategy defines how the OTLP receiver endpoint translates the incoming metrics.


        It requires Prometheus >= v3.0.0.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()
      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                          Object value)
      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)