io.servicetalk.opentelemetry.http.OpenTelemetryOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of servicetalk-opentelemetry-http Show documentation
A networking framework that evolves with your application
There is a newer version: 0.42.52
Show newest version
/*
 * Copyright © 2023 Apple Inc. and the ServiceTalk project authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.servicetalk.opentelemetry.http;

import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder;
import io.opentelemetry.instrumentation.api.instrumenter.OperationMetrics;
import io.opentelemetry.instrumentation.api.instrumenter.http.HttpClientAttributesExtractorBuilder;
import io.opentelemetry.instrumentation.api.instrumenter.http.HttpClientMetrics;
import io.opentelemetry.instrumentation.api.instrumenter.http.HttpServerAttributesExtractorBuilder;
import io.opentelemetry.instrumentation.api.instrumenter.http.HttpServerMetrics;

import java.util.ArrayList;
import java.util.List;

import static java.util.Collections.emptyList;
import static java.util.Collections.unmodifiableList;

/**
 * A set of options for configuring OpenTelemetry filters.
 */
public final class OpenTelemetryOptions {

    private final List capturedRequestHeaders;
    private final List capturedResponseHeaders;
    private final boolean enableMetrics;

    OpenTelemetryOptions(final List capturedRequestHeaders,
                         final List capturedResponseHeaders,
                         final boolean enableMetrics) {
        this.capturedRequestHeaders = capturedRequestHeaders;
        this.capturedResponseHeaders = capturedResponseHeaders;
        this.enableMetrics = enableMetrics;
    }

    /**
     * List of request headers to be captured as extra span attributes.
     *
     * @return List of request headers to be captured as extra span attributes
     * @see HttpClientAttributesExtractorBuilder#setCapturedRequestHeaders(List)
     * @see HttpServerAttributesExtractorBuilder#setCapturedRequestHeaders(List)
     */
    public List capturedRequestHeaders() {
        return capturedRequestHeaders;
    }

    /**
     * List of response headers to be captured as extra span attributes.
     *
     * @return List of response headers to be captured as extra span attributes.
     * @see HttpClientAttributesExtractorBuilder#setCapturedResponseHeaders(List)
     * @see HttpServerAttributesExtractorBuilder#setCapturedResponseHeaders(List)
     */
    public List capturedResponseHeaders() {
        return capturedResponseHeaders;
    }

    /**
     * Whether to enable operation metrics or not.
     *
     * @return {@code true} when operation metrics should be enabled, {@code false} otherwise
     * @see InstrumenterBuilder#addOperationMetrics(OperationMetrics)
     * @see HttpClientMetrics
     * @see HttpServerMetrics
     */
    public boolean enableMetrics() {
        return enableMetrics;
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof OpenTelemetryOptions)) {
            return false;
        }

        final OpenTelemetryOptions that = (OpenTelemetryOptions) o;
        if (enableMetrics != that.enableMetrics) {
            return false;
        }
        if (!capturedRequestHeaders.equals(that.capturedRequestHeaders)) {
            return false;
        }
        return capturedResponseHeaders.equals(that.capturedResponseHeaders);
    }

    @Override
    public int hashCode() {
        int result = capturedRequestHeaders.hashCode();
        result = 31 * result + capturedResponseHeaders.hashCode();
        result = 31 * result + (enableMetrics ? 1 : 0);
        return result;
    }

    @Override
    public String toString() {
        return getClass().getSimpleName() +
                "{capturedRequestHeaders=" + capturedRequestHeaders +
                ", capturedResponseHeaders=" + capturedResponseHeaders +
                ", enableMetrics=" + enableMetrics +
                '}';
    }

    /**
     * A builder for {@link OpenTelemetryOptions}.
     */
    public static final class Builder {
        private List capturedRequestHeaders = emptyList();
        private List capturedResponseHeaders = emptyList();
        private boolean enableMetrics;

        /**
         * Add the headers to be captured as extra span attributes.
         *
         * @param capturedRequestHeaders extra headers to be captured in client/server requests and added as extra span
         * attributes
         * @return an instance of itself
         * @see #capturedRequestHeaders()
         * @see HttpClientAttributesExtractorBuilder#setCapturedRequestHeaders(List)
         * @see HttpServerAttributesExtractorBuilder#setCapturedRequestHeaders(List)
         */
        public Builder capturedRequestHeaders(final List capturedRequestHeaders) {
            this.capturedRequestHeaders = capturedRequestHeaders.isEmpty() ? emptyList() :
                    unmodifiableList(new ArrayList<>(capturedRequestHeaders));
            return this;
        }

        /**
         * Add the headers to be captured as extra span attributes.
         *
         * @param capturedResponseHeaders extra headers to be captured in client/server response and added as extra span
         * attributes
         * @return an instance of itself
         * @see #capturedResponseHeaders()
         * @see HttpClientAttributesExtractorBuilder#setCapturedResponseHeaders(List)
         * @see HttpServerAttributesExtractorBuilder#setCapturedResponseHeaders(List)
         */
        public Builder capturedResponseHeaders(final List capturedResponseHeaders) {
            this.capturedResponseHeaders = capturedResponseHeaders.isEmpty() ? emptyList() :
                    unmodifiableList(new ArrayList<>(capturedResponseHeaders));
            return this;
        }

        /**
         * Whether to enable operation metrics or not.
         *
         * @param enableMetrics whether to enable operation metrics or not
         * @return an instance of itself
         * @see #enableMetrics()
         * @see InstrumenterBuilder#addOperationMetrics(OperationMetrics)
         * @see HttpClientMetrics
         * @see HttpServerMetrics
         */
        public Builder enableMetrics(final boolean enableMetrics) {
            this.enableMetrics = enableMetrics;
            return this;
        }

        /**
         * Builds a new {@link OpenTelemetryOptions}.
         *
         * @return a new {@link OpenTelemetryOptions}
         */
        public OpenTelemetryOptions build() {
            return new OpenTelemetryOptions(capturedRequestHeaders, capturedResponseHeaders, enableMetrics);
        }
    }
}