com.tencent.trpc.opentelemetry.spi.ITrpcAttributesExtractor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of trpc-opentelemetry Show documentation

There is a newer version: 1.3.0

/*
 * Tencent is pleased to support the open source community by making tRPC available.
 *
 * Copyright (C) 2023 THL A29 Limited, a Tencent company. 
 * All rights reserved.
 *
 * If you have downloaded a copy of the tRPC source code from Tencent,
 * please note that tRPC source code is licensed under the Apache 2.0 License,
 * A copy of the Apache 2.0 License can be found in the LICENSE file.
 */

package com.tencent.trpc.opentelemetry.spi;

import com.tencent.trpc.core.rpc.Request;
import java.util.Map;

/**
 * Get the data to be reported in Span from the request,
 * when the default implementation does not meet the requirements of the business side,
 * implement this interface for customization
 */
public interface ITrpcAttributesExtractor {

    /**
     * Get the Attributes to be reported in the Span from the request, unlike the {@link ITrpcRequestExtractor},
     * these attributes are placed outside of Events and are generally indexed to speed up
     * 

     * Note: SPI implementations are responsible for handling exceptions,
     * and throwing exceptions in this method may affect normal business processes.
     *
     * @param request Trpc request object
     * @return Reported key/value pairs.
     */
    Map extract(Request request);

}