ClickHouse/src/Interpreters/ClientInfo.h

118 lines
3.2 KiB
C++
Raw Normal View History

#pragma once
#include <Poco/Net/SocketAddress.h>
2020-08-27 18:44:20 +00:00
#include <Common/UInt128.h>
2020-09-15 09:55:57 +00:00
#include <common/types.h>
2020-11-18 17:43:18 +00:00
#include <Common/OpenTelemetryTraceContext.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:
2020-01-03 14:44:29 +00:00
enum class Interface : uint8_t
{
TCP = 1,
HTTP = 2,
2020-09-21 22:12:55 +00:00
GRPC = 3,
MYSQL = 4,
POSTGRESQL = 5,
};
2020-01-03 14:44:29 +00:00
enum class HTTPMethod : uint8_t
{
UNKNOWN = 0,
GET = 1,
POST = 2,
};
2020-01-03 14:44:29 +00:00
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;
2020-08-28 19:02:50 +00:00
2020-11-18 17:43:18 +00:00
// OpenTelemetry trace context we received from client, or which we are going
// to send to server.
OpenTelemetryTraceContext client_trace_context;
/// 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;
2020-09-17 12:15:05 +00:00
unsigned client_tcp_protocol_version = 0;
/// For http
HTTPMethod http_method = HTTPMethod::UNKNOWN;
String http_user_agent;
2021-01-21 22:55:45 +00:00
String http_referer;
2021-03-02 10:53:06 +00:00
/// For mysql
UInt64 connection_id = 0;
/// Comma separated list of forwarded IP addresses (from X-Forwarded-For for HTTP interface).
/// It's expected that proxy appends the forwarded address to the end of the list.
/// The element can be trusted only if you trust the corresponding proxy.
/// NOTE This field can also be reused in future for TCP interface with PROXY v1/v2 protocols.
String forwarded_for;
/// Common
String quota_key;
UInt64 distributed_depth = 0;
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);
2020-04-15 01:58:10 +00:00
/// Initialize parameters on client initiating query.
void setInitialQuery();
private:
void fillOSUserHostNameAndVersionInfo();
};
}