ClickHouse/src/Interpreters/ClientInfo.h

#pragma once

#include <Poco/Net/SocketAddress.h>
#include <Common/UInt128.h>
#include <common/types.h>


namespace DB
{

class WriteBuffer;
class ReadBuffer;


/** Information about client for query.
  * Some fields are passed explicitly from client and some are calculated automatically.
  *
  * Contains info about initial query source, for tracing distributed queries
  *  (where one query initiates many other queries).
  */
class ClientInfo
{
public:
    enum class Interface : uint8_t
    {
        TCP = 1,
        HTTP = 2,
    };

    enum class HTTPMethod : uint8_t
    {
        UNKNOWN = 0,
        GET = 1,
        POST = 2,
    };

    enum class QueryKind : uint8_t
    {
        NO_QUERY = 0,            /// Uninitialized object.
        INITIAL_QUERY = 1,
        SECONDARY_QUERY = 2,    /// Query that was initiated by another query for distributed or ON CLUSTER query execution.
    };


    QueryKind query_kind = QueryKind::NO_QUERY;

    /// Current values are not serialized, because it is passed separately.
    String current_user;
    String current_query_id;
    Poco::Net::SocketAddress current_address;

#if defined(ARCADIA_BUILD)
    /// This field is only used in foreign "Arcadia" build.
    String current_password;
#endif

    /// When query_kind == INITIAL_QUERY, these values are equal to current.
    String initial_user;
    String initial_query_id;
    Poco::Net::SocketAddress initial_address;

    // OpenTelemetry trace information.
    __uint128_t opentelemetry_trace_id = 0;
    // The span id we get the in the incoming client info becomes our parent span
    // id, and the span id we send becomes downstream parent span id.
    UInt64 opentelemetry_span_id = 0;
    UInt64 opentelemetry_parent_span_id = 0;
    // The incoming tracestate header and the trace flags, we just pass them downstream.
    // They are described at https://www.w3.org/TR/trace-context/
    String opentelemetry_tracestate;
    UInt8 opentelemetry_trace_flags = 0;

    /// All below are parameters related to initial query.

    Interface interface = Interface::TCP;

    /// For tcp
    String os_user;
    String client_hostname;
    String client_name;
    UInt64 client_version_major = 0;
    UInt64 client_version_minor = 0;
    UInt64 client_version_patch = 0;
    unsigned client_tcp_protocol_version = 0;

    /// For http
    HTTPMethod http_method = HTTPMethod::UNKNOWN;
    String http_user_agent;

    /// Common
    String quota_key;

    bool empty() const { return query_kind == QueryKind::NO_QUERY; }

    /** Serialization and deserialization.
      * Only values that are not calculated automatically or passed separately are serialized.
      * Revisions are passed to use format that server will understand or client was used.
      */
    void write(WriteBuffer & out, const UInt64 server_protocol_revision) const;
    void read(ReadBuffer & in, const UInt64 client_protocol_revision);

    /// Initialize parameters on client initiating query.
    void setInitialQuery();

    // Parse/compose OpenTelemetry traceparent header.
    // Note that these functions use span_id field, not parent_span_id, same as
    // in native protocol. The incoming traceparent corresponds to the upstream
    // trace span, and the outgoing traceparent corresponds to our current span.
    // We use the same ClientInfo structure first for incoming span, and then
    // for our span: when we switch, we use old span_id as parent_span_id, and
    // generate a new span_id (currently this happens in Context::setQueryId()).
    bool parseTraceparentHeader(const std::string & traceparent, std::string & error);
    std::string composeTraceparentHeader() const;

private:
    void fillOSUserHostNameAndVersionInfo();
};

}