Skip to content

Commit 889b6f5

Browse files
committed
fix(sql): add comments to libp2p_identify and libp2p_identify_local tables for better documentation and understanding of fields
feat(sql): enhance libp2p_identify and libp2p_identify_local tables with descriptive comments, improving clarity for future references
1 parent f6f3409 commit 889b6f5

2 files changed

Lines changed: 98 additions & 96 deletions

File tree

Lines changed: 49 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,53 @@
11
CREATE TABLE default.libp2p_identify
22
(
3-
`updated_date_time` DateTime CODEC(DoubleDelta, ZSTD(1)),
4-
`event_date_time` DateTime64(3) CODEC(DoubleDelta, ZSTD(1)),
5-
`remote_peer_id_unique_key` Int64 CODEC(ZSTD(1)),
6-
`success` Bool CODEC(ZSTD(1)),
7-
`error` Nullable(String) CODEC(ZSTD(1)),
8-
`remote_protocol` LowCardinality(String),
9-
`remote_transport_protocol` LowCardinality(String),
10-
`remote_port` UInt16 CODEC(ZSTD(1)),
11-
`remote_ip` Nullable(IPv6) CODEC(ZSTD(1)),
12-
`remote_geo_city` LowCardinality(String) CODEC(ZSTD(1)),
13-
`remote_geo_country` LowCardinality(String) CODEC(ZSTD(1)),
14-
`remote_geo_country_code` LowCardinality(String) CODEC(ZSTD(1)),
15-
`remote_geo_continent_code` LowCardinality(String) CODEC(ZSTD(1)),
16-
`remote_geo_longitude` Nullable(Float64) CODEC(ZSTD(1)),
17-
`remote_geo_latitude` Nullable(Float64) CODEC(ZSTD(1)),
18-
`remote_geo_autonomous_system_number` Nullable(UInt32) CODEC(ZSTD(1)),
19-
`remote_geo_autonomous_system_organization` Nullable(String) CODEC(ZSTD(1)),
20-
`remote_agent_implementation` LowCardinality(String),
21-
`remote_agent_version` LowCardinality(String),
22-
`remote_agent_version_major` LowCardinality(String),
23-
`remote_agent_version_minor` LowCardinality(String),
24-
`remote_agent_version_patch` LowCardinality(String),
25-
`remote_agent_platform` LowCardinality(String),
26-
`protocol_version` LowCardinality(String),
27-
`protocols` Array(String) CODEC(ZSTD(1)),
28-
`listen_addrs` Array(String) CODEC(ZSTD(1)),
29-
`observed_addr` String CODEC(ZSTD(1)),
30-
`transport` LowCardinality(String),
31-
`security` LowCardinality(String),
32-
`muxer` LowCardinality(String),
33-
`direction` LowCardinality(String),
34-
`remote_multiaddr` String CODEC(ZSTD(1)),
35-
`meta_client_name` LowCardinality(String),
36-
`meta_client_id` String CODEC(ZSTD(1)),
37-
`meta_client_version` LowCardinality(String),
38-
`meta_client_implementation` LowCardinality(String),
39-
`meta_client_os` LowCardinality(String),
40-
`meta_client_ip` Nullable(IPv6) CODEC(ZSTD(1)),
41-
`meta_client_geo_city` LowCardinality(String) CODEC(ZSTD(1)),
42-
`meta_client_geo_country` LowCardinality(String) CODEC(ZSTD(1)),
43-
`meta_client_geo_country_code` LowCardinality(String) CODEC(ZSTD(1)),
44-
`meta_client_geo_continent_code` LowCardinality(String) CODEC(ZSTD(1)),
45-
`meta_client_geo_longitude` Nullable(Float64) CODEC(ZSTD(1)),
46-
`meta_client_geo_latitude` Nullable(Float64) CODEC(ZSTD(1)),
47-
`meta_client_geo_autonomous_system_number` Nullable(UInt32) CODEC(ZSTD(1)),
48-
`meta_client_geo_autonomous_system_organization` Nullable(String) CODEC(ZSTD(1)),
49-
`meta_network_id` Int32 CODEC(DoubleDelta, ZSTD(1)),
50-
`meta_network_name` LowCardinality(String)
3+
`updated_date_time` DateTime COMMENT 'Timestamp when the record was last updated' CODEC(DoubleDelta, ZSTD(1)),
4+
`event_date_time` DateTime64(3) COMMENT 'Timestamp of the event' CODEC(DoubleDelta, ZSTD(1)),
5+
`remote_peer_id_unique_key` Int64 COMMENT 'Unique key associated with the identifier of the remote peer' CODEC(ZSTD(1)),
6+
`success` Bool COMMENT 'Whether the identify request was successful' CODEC(ZSTD(1)),
7+
`error` Nullable(String) COMMENT 'Error message if the identify request failed' CODEC(ZSTD(1)),
8+
`remote_protocol` LowCardinality(String) COMMENT 'Protocol of the remote peer',
9+
`remote_transport_protocol` LowCardinality(String) COMMENT 'Transport protocol of the remote peer',
10+
`remote_port` UInt16 COMMENT 'Port of the remote peer' CODEC(ZSTD(1)),
11+
`remote_ip` Nullable(IPv6) COMMENT 'IP address of the remote peer that generated the event' CODEC(ZSTD(1)),
12+
`remote_geo_city` LowCardinality(String) COMMENT 'City of the remote peer that generated the event' CODEC(ZSTD(1)),
13+
`remote_geo_country` LowCardinality(String) COMMENT 'Country of the remote peer that generated the event' CODEC(ZSTD(1)),
14+
`remote_geo_country_code` LowCardinality(String) COMMENT 'Country code of the remote peer that generated the event' CODEC(ZSTD(1)),
15+
`remote_geo_continent_code` LowCardinality(String) COMMENT 'Continent code of the remote peer that generated the event' CODEC(ZSTD(1)),
16+
`remote_geo_longitude` Nullable(Float64) COMMENT 'Longitude of the remote peer that generated the event' CODEC(ZSTD(1)),
17+
`remote_geo_latitude` Nullable(Float64) COMMENT 'Latitude of the remote peer that generated the event' CODEC(ZSTD(1)),
18+
`remote_geo_autonomous_system_number` Nullable(UInt32) COMMENT 'Autonomous system number of the remote peer that generated the event' CODEC(ZSTD(1)),
19+
`remote_geo_autonomous_system_organization` Nullable(String) COMMENT 'Autonomous system organization of the remote peer that generated the event' CODEC(ZSTD(1)),
20+
`remote_agent_implementation` LowCardinality(String) COMMENT 'Implementation of the remote peer',
21+
`remote_agent_version` LowCardinality(String) COMMENT 'Version of the remote peer',
22+
`remote_agent_version_major` LowCardinality(String) COMMENT 'Major version of the remote peer',
23+
`remote_agent_version_minor` LowCardinality(String) COMMENT 'Minor version of the remote peer',
24+
`remote_agent_version_patch` LowCardinality(String) COMMENT 'Patch version of the remote peer',
25+
`remote_agent_platform` LowCardinality(String) COMMENT 'Platform of the remote peer',
26+
`protocol_version` LowCardinality(String) COMMENT 'Protocol version reported by the remote peer',
27+
`protocols` Array(String) COMMENT 'List of protocols supported by the remote peer' CODEC(ZSTD(1)),
28+
`listen_addrs` Array(String) COMMENT 'List of multiaddresses the remote peer is listening on' CODEC(ZSTD(1)),
29+
`observed_addr` String COMMENT 'Multiaddress the remote peer observed for the local peer' CODEC(ZSTD(1)),
30+
`transport` LowCardinality(String) COMMENT 'Transport protocol used for the connection',
31+
`security` LowCardinality(String) COMMENT 'Security protocol used for the connection',
32+
`muxer` LowCardinality(String) COMMENT 'Stream multiplexer used for the connection',
33+
`direction` LowCardinality(String) COMMENT 'Connection direction',
34+
`remote_multiaddr` String COMMENT 'Full multiaddress of the remote peer' CODEC(ZSTD(1)),
35+
`meta_client_name` LowCardinality(String) COMMENT 'Name of the client that collected the data. The table contains data from multiple clients',
36+
`meta_client_id` String COMMENT 'Unique Session ID of the client that generated the event. This changes every time the client is restarted.' CODEC(ZSTD(1)),
37+
`meta_client_version` LowCardinality(String) COMMENT 'Version of the client that generated the event',
38+
`meta_client_implementation` LowCardinality(String) COMMENT 'Implementation of the client that generated the event',
39+
`meta_client_os` LowCardinality(String) COMMENT 'Operating system of the client that generated the event',
40+
`meta_client_ip` Nullable(IPv6) COMMENT 'IP address of the client that generated the event' CODEC(ZSTD(1)),
41+
`meta_client_geo_city` LowCardinality(String) COMMENT 'City of the client that generated the event' CODEC(ZSTD(1)),
42+
`meta_client_geo_country` LowCardinality(String) COMMENT 'Country of the client that generated the event' CODEC(ZSTD(1)),
43+
`meta_client_geo_country_code` LowCardinality(String) COMMENT 'Country code of the client that generated the event' CODEC(ZSTD(1)),
44+
`meta_client_geo_continent_code` LowCardinality(String) COMMENT 'Continent code of the client that generated the event' CODEC(ZSTD(1)),
45+
`meta_client_geo_longitude` Nullable(Float64) COMMENT 'Longitude of the client that generated the event' CODEC(ZSTD(1)),
46+
`meta_client_geo_latitude` Nullable(Float64) COMMENT 'Latitude of the client that generated the event' CODEC(ZSTD(1)),
47+
`meta_client_geo_autonomous_system_number` Nullable(UInt32) COMMENT 'Autonomous system number of the client that generated the event' CODEC(ZSTD(1)),
48+
`meta_client_geo_autonomous_system_organization` Nullable(String) COMMENT 'Autonomous system organization of the client that generated the event' CODEC(ZSTD(1)),
49+
`meta_network_id` Int32 COMMENT 'Ethereum network ID' CODEC(DoubleDelta, ZSTD(1)),
50+
`meta_network_name` LowCardinality(String) COMMENT 'Ethereum network name'
5151
)
5252
ENGINE = Distributed('{cluster}', 'default', 'libp2p_identify_local', cityHash64(event_date_time, meta_network_name, meta_client_name, remote_peer_id_unique_key, direction))
53+
COMMENT 'Contains libp2p identify events with peer identification data including agent version, protocols, and connection metadata. Collected from deep instrumentation within forked consensus layer clients. Each row includes remote peer agent info, supported protocols, listen addresses, and geolocation. Partition: monthly by `event_date_time`.'
Lines changed: 49 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,56 @@
11
CREATE TABLE default.libp2p_identify_local
22
(
3-
`updated_date_time` DateTime CODEC(DoubleDelta, ZSTD(1)),
4-
`event_date_time` DateTime64(3) CODEC(DoubleDelta, ZSTD(1)),
5-
`remote_peer_id_unique_key` Int64 CODEC(ZSTD(1)),
6-
`success` Bool CODEC(ZSTD(1)),
7-
`error` Nullable(String) CODEC(ZSTD(1)),
8-
`remote_protocol` LowCardinality(String),
9-
`remote_transport_protocol` LowCardinality(String),
10-
`remote_port` UInt16 CODEC(ZSTD(1)),
11-
`remote_ip` Nullable(IPv6) CODEC(ZSTD(1)),
12-
`remote_geo_city` LowCardinality(String) CODEC(ZSTD(1)),
13-
`remote_geo_country` LowCardinality(String) CODEC(ZSTD(1)),
14-
`remote_geo_country_code` LowCardinality(String) CODEC(ZSTD(1)),
15-
`remote_geo_continent_code` LowCardinality(String) CODEC(ZSTD(1)),
16-
`remote_geo_longitude` Nullable(Float64) CODEC(ZSTD(1)),
17-
`remote_geo_latitude` Nullable(Float64) CODEC(ZSTD(1)),
18-
`remote_geo_autonomous_system_number` Nullable(UInt32) CODEC(ZSTD(1)),
19-
`remote_geo_autonomous_system_organization` Nullable(String) CODEC(ZSTD(1)),
20-
`remote_agent_implementation` LowCardinality(String),
21-
`remote_agent_version` LowCardinality(String),
22-
`remote_agent_version_major` LowCardinality(String),
23-
`remote_agent_version_minor` LowCardinality(String),
24-
`remote_agent_version_patch` LowCardinality(String),
25-
`remote_agent_platform` LowCardinality(String),
26-
`protocol_version` LowCardinality(String),
27-
`protocols` Array(String) CODEC(ZSTD(1)),
28-
`listen_addrs` Array(String) CODEC(ZSTD(1)),
29-
`observed_addr` String CODEC(ZSTD(1)),
30-
`transport` LowCardinality(String),
31-
`security` LowCardinality(String),
32-
`muxer` LowCardinality(String),
33-
`direction` LowCardinality(String),
34-
`remote_multiaddr` String CODEC(ZSTD(1)),
35-
`meta_client_name` LowCardinality(String),
36-
`meta_client_id` String CODEC(ZSTD(1)),
37-
`meta_client_version` LowCardinality(String),
38-
`meta_client_implementation` LowCardinality(String),
39-
`meta_client_os` LowCardinality(String),
40-
`meta_client_ip` Nullable(IPv6) CODEC(ZSTD(1)),
41-
`meta_client_geo_city` LowCardinality(String) CODEC(ZSTD(1)),
42-
`meta_client_geo_country` LowCardinality(String) CODEC(ZSTD(1)),
43-
`meta_client_geo_country_code` LowCardinality(String) CODEC(ZSTD(1)),
44-
`meta_client_geo_continent_code` LowCardinality(String) CODEC(ZSTD(1)),
45-
`meta_client_geo_longitude` Nullable(Float64) CODEC(ZSTD(1)),
46-
`meta_client_geo_latitude` Nullable(Float64) CODEC(ZSTD(1)),
47-
`meta_client_geo_autonomous_system_number` Nullable(UInt32) CODEC(ZSTD(1)),
48-
`meta_client_geo_autonomous_system_organization` Nullable(String) CODEC(ZSTD(1)),
49-
`meta_network_id` Int32 CODEC(DoubleDelta, ZSTD(1)),
50-
`meta_network_name` LowCardinality(String)
3+
`updated_date_time` DateTime COMMENT 'Timestamp when the record was last updated' CODEC(DoubleDelta, ZSTD(1)),
4+
`event_date_time` DateTime64(3) COMMENT 'Timestamp of the event' CODEC(DoubleDelta, ZSTD(1)),
5+
`remote_peer_id_unique_key` Int64 COMMENT 'Unique key associated with the identifier of the remote peer' CODEC(ZSTD(1)),
6+
`success` Bool COMMENT 'Whether the identify request was successful' CODEC(ZSTD(1)),
7+
`error` Nullable(String) COMMENT 'Error message if the identify request failed' CODEC(ZSTD(1)),
8+
`remote_protocol` LowCardinality(String) COMMENT 'Protocol of the remote peer',
9+
`remote_transport_protocol` LowCardinality(String) COMMENT 'Transport protocol of the remote peer',
10+
`remote_port` UInt16 COMMENT 'Port of the remote peer' CODEC(ZSTD(1)),
11+
`remote_ip` Nullable(IPv6) COMMENT 'IP address of the remote peer that generated the event' CODEC(ZSTD(1)),
12+
`remote_geo_city` LowCardinality(String) COMMENT 'City of the remote peer that generated the event' CODEC(ZSTD(1)),
13+
`remote_geo_country` LowCardinality(String) COMMENT 'Country of the remote peer that generated the event' CODEC(ZSTD(1)),
14+
`remote_geo_country_code` LowCardinality(String) COMMENT 'Country code of the remote peer that generated the event' CODEC(ZSTD(1)),
15+
`remote_geo_continent_code` LowCardinality(String) COMMENT 'Continent code of the remote peer that generated the event' CODEC(ZSTD(1)),
16+
`remote_geo_longitude` Nullable(Float64) COMMENT 'Longitude of the remote peer that generated the event' CODEC(ZSTD(1)),
17+
`remote_geo_latitude` Nullable(Float64) COMMENT 'Latitude of the remote peer that generated the event' CODEC(ZSTD(1)),
18+
`remote_geo_autonomous_system_number` Nullable(UInt32) COMMENT 'Autonomous system number of the remote peer that generated the event' CODEC(ZSTD(1)),
19+
`remote_geo_autonomous_system_organization` Nullable(String) COMMENT 'Autonomous system organization of the remote peer that generated the event' CODEC(ZSTD(1)),
20+
`remote_agent_implementation` LowCardinality(String) COMMENT 'Implementation of the remote peer',
21+
`remote_agent_version` LowCardinality(String) COMMENT 'Version of the remote peer',
22+
`remote_agent_version_major` LowCardinality(String) COMMENT 'Major version of the remote peer',
23+
`remote_agent_version_minor` LowCardinality(String) COMMENT 'Minor version of the remote peer',
24+
`remote_agent_version_patch` LowCardinality(String) COMMENT 'Patch version of the remote peer',
25+
`remote_agent_platform` LowCardinality(String) COMMENT 'Platform of the remote peer',
26+
`protocol_version` LowCardinality(String) COMMENT 'Protocol version reported by the remote peer',
27+
`protocols` Array(String) COMMENT 'List of protocols supported by the remote peer' CODEC(ZSTD(1)),
28+
`listen_addrs` Array(String) COMMENT 'List of multiaddresses the remote peer is listening on' CODEC(ZSTD(1)),
29+
`observed_addr` String COMMENT 'Multiaddress the remote peer observed for the local peer' CODEC(ZSTD(1)),
30+
`transport` LowCardinality(String) COMMENT 'Transport protocol used for the connection',
31+
`security` LowCardinality(String) COMMENT 'Security protocol used for the connection',
32+
`muxer` LowCardinality(String) COMMENT 'Stream multiplexer used for the connection',
33+
`direction` LowCardinality(String) COMMENT 'Connection direction',
34+
`remote_multiaddr` String COMMENT 'Full multiaddress of the remote peer' CODEC(ZSTD(1)),
35+
`meta_client_name` LowCardinality(String) COMMENT 'Name of the client that collected the data. The table contains data from multiple clients',
36+
`meta_client_id` String COMMENT 'Unique Session ID of the client that generated the event. This changes every time the client is restarted.' CODEC(ZSTD(1)),
37+
`meta_client_version` LowCardinality(String) COMMENT 'Version of the client that generated the event',
38+
`meta_client_implementation` LowCardinality(String) COMMENT 'Implementation of the client that generated the event',
39+
`meta_client_os` LowCardinality(String) COMMENT 'Operating system of the client that generated the event',
40+
`meta_client_ip` Nullable(IPv6) COMMENT 'IP address of the client that generated the event' CODEC(ZSTD(1)),
41+
`meta_client_geo_city` LowCardinality(String) COMMENT 'City of the client that generated the event' CODEC(ZSTD(1)),
42+
`meta_client_geo_country` LowCardinality(String) COMMENT 'Country of the client that generated the event' CODEC(ZSTD(1)),
43+
`meta_client_geo_country_code` LowCardinality(String) COMMENT 'Country code of the client that generated the event' CODEC(ZSTD(1)),
44+
`meta_client_geo_continent_code` LowCardinality(String) COMMENT 'Continent code of the client that generated the event' CODEC(ZSTD(1)),
45+
`meta_client_geo_longitude` Nullable(Float64) COMMENT 'Longitude of the client that generated the event' CODEC(ZSTD(1)),
46+
`meta_client_geo_latitude` Nullable(Float64) COMMENT 'Latitude of the client that generated the event' CODEC(ZSTD(1)),
47+
`meta_client_geo_autonomous_system_number` Nullable(UInt32) COMMENT 'Autonomous system number of the client that generated the event' CODEC(ZSTD(1)),
48+
`meta_client_geo_autonomous_system_organization` Nullable(String) COMMENT 'Autonomous system organization of the client that generated the event' CODEC(ZSTD(1)),
49+
`meta_network_id` Int32 COMMENT 'Ethereum network ID' CODEC(DoubleDelta, ZSTD(1)),
50+
`meta_network_name` LowCardinality(String) COMMENT 'Ethereum network name'
5151
)
5252
ENGINE = ReplicatedReplacingMergeTree('/clickhouse/{installation}/{cluster}/default/tables/libp2p_identify_local/{shard}', '{replica}', updated_date_time)
5353
PARTITION BY toYYYYMM(event_date_time)
5454
ORDER BY (event_date_time, meta_network_name, meta_client_name, remote_peer_id_unique_key, direction)
5555
SETTINGS index_granularity = 8192
56+
COMMENT 'Contains libp2p identify events with peer identification data including agent version, protocols, and connection metadata. Collected from deep instrumentation within forked consensus layer clients. Each row includes remote peer agent info, supported protocols, listen addresses, and geolocation. Partition: monthly by `event_date_time`.'

0 commit comments

Comments
 (0)