io.helidon.security.integration.common.CommonTracing Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of helidon-security-integration-common Show documentation
There is a newer version: 4.1.4
Show newest version
/*
 * Copyright (c) 2019, 2022 Oracle and/or its affiliates.
 *
 * 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.helidon.security.integration.common;

import java.util.Map;
import java.util.Optional;

import io.helidon.security.SecurityResponse;
import io.helidon.tracing.Span;
import io.helidon.tracing.SpanContext;
import io.helidon.tracing.config.SpanTracingConfig;


abstract class CommonTracing {
    static final String LOG_STATUS = "status";

    private final Optional parentSpanContext;
    private final Optional parentSpan;
    private final Optional securitySpan;
    private final Optional span;
    private final SpanTracingConfig spanConfig;

    CommonTracing(Optional parentSpanContext,
                  Optional parentSpan,
                  Optional securitySpan,
                  Optional span,
                  SpanTracingConfig spanConfig) {

        this.parentSpanContext = parentSpanContext;
        this.parentSpan = parentSpan;
        this.securitySpan = securitySpan;
        this.span = span;
        this.spanConfig = spanConfig;
    }

    /**
     * Finish the span.
     */
    public void finish() {
        span.ifPresent(Span::end);
    }

    /**
     * Log error and finish the span.
     *
     * @param message log this message as the cause of failure
     */
    public void error(String message) {
        if (!span.isPresent()) {
            return;
        }

        Span theSpan = span.get();

        theSpan.status(Span.Status.ERROR);
        theSpan.addEvent("error", Map.of("message", message,
                           "error.kind", "SecurityException"));

        theSpan.end();
    }

    /**
     * Log error and finish the span.
     *
     * @param throwable throwable causing security to fail
     */
    public void error(Throwable throwable) {
        if (span.isEmpty()) {
            return;
        }

        Span theSpan = span.get();
        theSpan.end(throwable);
    }

    /**
     * Find closes parent span context.
     *
     * @return span context if found
     */
    public Optional findParent() {
        Optional closest = closestSecuritySpan();

        return closest.map(Span::context)
                .or(() -> parentSpanContext);
    }

    /**
     * Log response status.
     * This is to be used by authorization, authentication and outbound
     * security.
     * Top level security only traces proceed or deny.
     *
     * @param status status to log
     */
    public void logStatus(SecurityResponse.SecurityStatus status) {
        log(LOG_STATUS, LOG_STATUS + ": " + status, true);
    }

    Optional span() {
        return span;
    }

    Optional parentSpanContext() {
        return parentSpanContext;
    }

    Optional parentSpan() {
        return parentSpan;
    }

    Optional securitySpan() {
        return securitySpan;
    }

    void log(String logName, String logMessage, boolean enabledByDefault) {
        span().ifPresent(span -> {
            if (spanConfig().logEnabled(logName, enabledByDefault)) {
                span.addEvent(logMessage);
            }
        });
    }

    protected SpanTracingConfig spanConfig() {
        return spanConfig;
    }

    private Optional closestSecuritySpan() {
        if (span.isPresent()) {
            return span;
        }

        return securitySpan;
    }
}