ydb-embedded-ui 3.1.0 → 3.2.1

package/dist/types/api/consumer.ts

@@ -0,0 +1,257 @@
+/* eslint-disable camelcase */
+
+/**
+ * endpoint: /json/describe_consumer
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/public/api/protos/ydb_topic.proto
+ *
+ * Original proto file doesn't specify optional fields, so every field is considered optional
+ */
+export interface DescribeConsumerResult {
+    self?: Entry;
+    consumer?: Consumer;
+    partitions?: PartitionInfo[];
+}
+
+/** Partition info types differs for consumer and topic, although they are very similar */
+export interface PartitionInfo {
+    /** int64  */
+    partition_id?: string;
+
+    /** Is partition open for write. */
+    active?: boolean;
+
+    /**
+     * int64
+     *
+     * Ids of partitions which was formed when this partition was split or merged.
+     */
+    child_partition_ids?: string[];
+
+    /**
+     * int64
+     *
+     * Ids of partitions from which this partition was formed by split or merge.
+     */
+    parent_partition_ids?: string[];
+
+    /** Stats for partition, filled only when include_stats in request is true. */
+    partition_stats?: PartitionStats;
+
+    /** Stats for consumer of this partition, filled only when include_stats in request is true. */
+    partition_consumer_stats?: PartitionConsumerStats;
+}
+
+interface PartitionConsumerStats {
+    /**
+     * int64
+     *
+     * Last read offset from this partition.
+     */
+    last_read_offset?: string;
+
+    /**
+     * int64
+     *
+     * Committed offset for this partition.
+     */
+    committed_offset?: string;
+
+    /** Reading this partition read session identifier. */
+    read_session_id?: string;
+
+    /**
+     * google.protobuf.Timestamp
+     *
+     * Timestamp of providing this partition to this session by server.
+     */
+    partition_read_session_create_time?: string;
+
+    /**
+     * google.protobuf.Timestamp
+     *
+     * Timestamp of last read from this partition. */
+    last_read_time?: string;
+
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between timestamp of read and write timestamp for all messages, read during last minute.
+     */
+    max_read_time_lag?: string;
+
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between write timestamp and create timestamp for all messages, read during last minute.
+     */
+    max_write_time_lag?: string;
+
+    /** How much bytes were read during several windows statistics from this partiton. */
+    bytes_read?: MultipleWindowsStat;
+
+    /** Read session name, provided by client. */
+    reader_name?: string;
+
+    /** Host where read session connected. */
+    connection_node_id?: number;
+}
+
+export interface PartitionStats {
+    /** Partition contains messages with offsets in range [start, end). */
+    partition_offsets?: OffsetsRange;
+
+    /**
+     * int64
+     *
+     * Approximate size of partition.
+     */
+    store_size_bytes?: string;
+
+    /**
+     * google.protobuf.Timestamp
+     *
+     * Timestamp of last write.
+     */
+    last_write_time?: string;
+
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between write timestamp and create timestamp for all messages, written during last minute.
+     */
+    max_write_time_lag?: string;
+
+    /** How much bytes were written during several windows in this partition. */
+    bytes_written?: MultipleWindowsStat;
+
+    /** Host where tablet for this partition works. Useful for debugging purposes. */
+    partition_node_id?: number;
+}
+
+interface OffsetsRange {
+    /** int64  */
+    start?: string;
+    /** int64  */
+    end?: string;
+}
+
+export interface Consumer {
+    /** Must have valid not empty name as a key. */
+    name?: string;
+
+    /** Consumer may be marked as 'important'. It means messages for this consumer will never expire due to retention. */
+    important?: boolean;
+
+    /**
+     * google.protobuf.Timestamp
+     *
+     * All messages with smaller server written_at timestamp will be skipped.
+     */
+    read_from?: string;
+
+    /**
+     * List of supported codecs by this consumer.
+     *
+     * supported_codecs on topic must be contained inside this list.
+     */
+    supported_codecs?: SupportedCodecs;
+
+    /** Attributes of consumer */
+    attributes?: Record<string, string>;
+
+    /** Filled only when requested statistics in Describe*Request. */
+    consumer_stats?: ConsumerStats;
+}
+
+interface ConsumerStats {
+    /**
+     * google.protobuf.Timestamp
+     *
+     * Minimal timestamp of last read from partitions.
+     */
+    min_partitions_last_read_time?: string;
+
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between timestamp of read and write timestamp for all messages, read during last minute.
+     */
+    max_read_time_lag?: string;
+
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between write timestamp and create timestamp for all messages, read during last minute.
+     */
+    max_write_time_lag?: string;
+
+    /** Bytes read stastics. */
+    bytes_read?: MultipleWindowsStat;
+}
+
+export interface MultipleWindowsStat {
+    /** int64  */
+    per_minute?: string;
+    /** int64  */
+    per_hour?: string;
+    /** int64  */
+    per_day?: string;
+}
+
+export interface SupportedCodecs {
+    /** List of supported codecs. */
+    codecs?: number[];
+}
+
+export interface Entry {
+    /** For consumer will be topic-name/consumer-name */
+    name?: string;
+
+    owner?: string;
+    type?: Type;
+    effective_permissions?: Permissions[];
+    permissions?: Permissions[];
+
+    /**
+     * uint64
+     *
+     * Size of entry in bytes. Currently filled for:
+     * - TABLE;
+     * - DATABASE.
+     *
+     * Empty (zero) in other cases.
+     */
+    size_bytes?: string;
+
+    /** Virtual timestamp when the object was created */
+    created_at?: VirtualTimestamp;
+}
+
+interface Permissions {
+    subject?: string;
+    permission_names?: string[];
+}
+
+interface VirtualTimestamp {
+    /** uint64 */
+    plan_step?: string;
+    /** uint64 */
+    tx_id?: string;
+}
+
+enum Type {
+    TYPE_UNSPECIFIED = 'TYPE_UNSPECIFIED',
+    DIRECTORY = 'DIRECTORY',
+    TABLE = 'TABLE',
+    PERS_QUEUE_GROUP = 'PERS_QUEUE_GROUP',
+    DATABASE = 'DATABASE',
+    RTMR_VOLUME = 'RTMR_VOLUME',
+    BLOCK_STORE_VOLUME = 'BLOCK_STORE_VOLUME',
+    COORDINATION_NODE = 'COORDINATION_NODE',
+    COLUMN_STORE = 'COLUMN_STORE ',
+    COLUMN_TABLE = 'COLUMN_TABLE ',
+    SEQUENCE = 'SEQUENCE ',
+    REPLICATION = 'REPLICATION ',
+    TOPIC = 'TOPIC ',
+}

package/dist/types/api/enums.ts

@@ -1,6 +1,6 @@
 // Shows system status
-// Currently is used in response types of viewer/json/nodes and viewer/json/storage
-// Probably will appear in /viewer/json/tenantinfo /viewer/json/cluster /viewer/json/tabletinfo /viewer/json/compute
+// Currently is used in response types viewer/json/ storage, nodes, compute
+// pdiskinfo, vdiskinfo, tabletinfo, tenantinfo
 export enum EFlag {
     Grey = 'Grey',
     Green = 'Green',

package/dist/types/api/nodes.ts

@@ -2,6 +2,9 @@ import {EFlag} from './enums';
 import {TPDiskStateInfo} from './pdisk';
 import {TTabletStateInfo} from './tablet';
 
+// endpoint: /viewer/json/nodes
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+
 export interface TNodesInfo {
     Overall: EFlag;
     Nodes?: TNodeInfo[];
@@ -64,12 +67,12 @@ export interface TPoolStats {
     Threads?: number;
 }
 
-interface TEndpoint {
+export interface TEndpoint {
     Name?: string;
     Address?: string;
 }
 
-interface TLegacyNodeLocation {
+export interface TLegacyNodeLocation {
     DataCenter?: number;
     Room?: number;
     Rack?: number;

package/dist/types/api/pdisk.ts

@@ -1,5 +1,8 @@
 import {EFlag} from './enums';
 
+// endpoint: /viewer/json/pdiskinfo
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
+
 export interface TPDiskStateInfo {
     PDiskId?: number;
     /** uint64 */

package/dist/types/api/schema.ts

@@ -1,3 +1,5 @@
+import {TMetrics} from './tenant';
+
 export interface TEvDescribeSchemeResult {
     Status?: EStatus;
     Reason?: string;
@@ -37,6 +39,7 @@ enum EStatus {
     StatusResourceExhausted = 'StatusResourceExhausted',
 }
 
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/flat_scheme_op.proto
 // incomplete interface, only currently used fields are covered
 export interface TPathDescription {
     /** info about the path itself */
@@ -49,8 +52,10 @@ export interface TPathDescription {
     // for table
     Table?: TTableDescription;
     TableStats?: TTableStats;
-    TabletMetrics?: unknown;
-    TablePartitions?: unknown[];
+    TabletMetrics?: TMetrics;
+    TablePartitions?: TTablePartition[];
+    TablePartitionStats?: TTableStats[];
+    TablePartitionMetrics?: TMetrics[];
 
     ColumnStoreDescription?: TColumnStoreDescription;
     ColumnTableDescription?: TColumnTableDescription;
@@ -253,7 +258,7 @@ export interface TFollowerGroup {
     AllowedDataCenters?: string[];
 }
 
-interface TTableStats {
+export interface TTableStats {
     /** uint64 */
     DataSize?: string;
     /** uint64 */
@@ -790,3 +795,12 @@ interface TColumnTableSchemaPreset {
     Name?: string;
     Schema?: TColumnTableSchema;
 }
+
+interface TTablePartition {
+    /** bytes */
+    EndOfRangeKeyPrefix?: unknown;
+    IsPoint?: boolean;
+    IsInclusive?: boolean;
+    /** uint64 */
+    DatashardId?: string;
+}

package/dist/types/api/storage.ts

@@ -1,6 +1,37 @@
 import {EFlag} from './enums';
 import {TVDiskStateInfo} from './vdisk';
 
+// endpoint: /viewer/json/storage
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+
+export interface TStorageInfo {
+    Overall?: EFlag;
+    StoragePools?: TStoragePoolInfo[];
+    /** uint64 */
+    TotalGroups?: string;
+    /** uint64 */
+    FoundGroups?: string;
+}
+
+interface TStoragePoolInfo {
+    Overall?: EFlag;
+    Name?: string;
+    Kind?: string;
+    Groups?: (TBSGroupStateInfo & THiveStorageGroupStats)[];
+    /** uint64 */
+    AcquiredUnits?: string;
+    AcquiredIOPS?: number;
+    /** uint64 */
+    AcquiredThroughput?: string;
+    /** uint64 */
+    AcquiredSize?: string;
+    MaximumIOPS?: number;
+    /** uint64 */
+    MaximumThroughput?: string;
+    /** uint64 */
+    MaximumSize?: string;
+}
+
 export interface TBSGroupStateInfo {
     GroupID?: number;
     ErasureSpecies?: string;
@@ -43,31 +74,3 @@ interface THiveStorageGroupStats {
     /** uint64 */
     AvailableSize?: string;
 }
-
-interface TStoragePoolInfo {
-    Overall?: EFlag;
-    Name?: string;
-    Kind?: string;
-    Groups?: (TBSGroupStateInfo & THiveStorageGroupStats)[];
-    /** uint64 */
-    AcquiredUnits?: string;
-    AcquiredIOPS?: number;
-    /** uint64 */
-    AcquiredThroughput?: string;
-    /** uint64 */
-    AcquiredSize?: string;
-    MaximumIOPS?: number;
-    /** uint64 */
-    MaximumThroughput?: string;
-    /** uint64 */
-    MaximumSize?: string;
-}
-
-export interface TStorageInfo {
-    Overall?: EFlag;
-    StoragePools?: TStoragePoolInfo[];
-    /** uint64 */
-    TotalGroups?: string;
-    /** uint64 */
-    FoundGroups?: string;
-}

package/dist/types/api/tablet.ts

@@ -1,5 +1,21 @@
 import {EFlag} from './enums';
 
+// endpoint: /viewer/json/tabletinfo
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/sys_view.proto
+
+export interface TEvTabletStateResponse {
+    TabletStateInfo?: TTabletStateInfo[];
+
+    /** uint64 */
+    ResponseTime?: string;
+    /** uint64 */
+    ResponseDuration?: string;
+    /** uint64 */
+    ProcessDuration?: string;
+
+    Packed5?: unknown;
+}
+
 export interface TTabletStateInfo {
     /** uint64 */
     TabletId?: string;
@@ -37,7 +53,7 @@ interface TDomainKey {
     PathId?: string;
 }
 
-enum EType {
+export enum EType {
     'Unknown' = 'Unknown',
     'OldSchemeShard' = 'OldSchemeShard',
     'OldDataShard' = 'OldDataShard',
@@ -79,7 +95,7 @@ enum EType {
     'TypeInvalid' = 'TypeInvalid',
 }
 
-enum ETabletState {
+export enum ETabletState {
     'Created' = 'Created',
     'ResolveStateStorage' = 'ResolveStateStorage',
     'Candidate' = 'Candidate',

package/dist/types/api/tenant.ts

@@ -2,6 +2,9 @@ import {EFlag} from './enums';
 import {TPoolStats, TSystemStateInfo} from './nodes';
 import {TTabletStateInfo} from './tablet';
 
+// endpoint: /viewer/json/tenantinfo
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+
 export interface TTenants {
     Tenants?: TTenant[];
 }
@@ -51,7 +54,7 @@ interface THiveDomainStatsStateCount {
     Count?: number;
 }
 
-interface TMetrics {
+export interface TMetrics {
     /** uint64 */
     CPU?: string;
     /** uint64 */

package/dist/types/api/topic.ts

@@ -0,0 +1,157 @@
+/* eslint-disable camelcase */
+
+import {Consumer, Entry, MultipleWindowsStat, PartitionStats, SupportedCodecs} from './consumer';
+
+/**
+ * endpoint: /json/describe_topic
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/public/api/protos/ydb_topic.proto
+ *
+ * Original proto file doesn't specify optional fields, so every field is considered optional
+ */
+export interface DescribeTopicResult {
+    /** Description of scheme object. */
+    self?: Entry;
+
+    /** Settings for partitioning */
+    partitioning_settings?: PartitioningSettings;
+
+    /** Partitions description. */
+    partitions?: PartitionInfo[];
+
+    // Retention settings.
+    // Currently, only one limit may be set, so other should not be set.
+
+    /**
+     * google.protobuf.Duration
+     *
+     * How long data in partition should be stored.
+     */
+    retention_period?: string;
+
+    /**
+     * int64
+     *
+     * How much data in partition should be stored.
+     * Zero value means infinite limit.
+     */
+    retention_storage_mb?: string;
+
+    /**
+     * List of allowed codecs for writers.
+     * Writes with codec not from this list are forbidden.
+     */
+    supported_codecs?: SupportedCodecs;
+
+    /**
+     * int64
+     *
+     * Partition write speed in bytes per second.
+     * Zero value means default limit: 1 MB per second.
+     */
+    partition_write_speed_bytes_per_second?: string;
+
+    /**
+     * int64
+     *
+     * Burst size for write in partition, in bytes.
+     * Zero value means default limit: 1 MB.
+     */
+    partition_write_burst_bytes?: string;
+
+    /** User and server attributes of topic. Server attributes starts from "_" and will be validated by server. */
+    attributes?: Record<string, string>;
+
+    /** List of consumers for this topic. */
+    consumers?: Consumer[];
+
+    /** Metering settings. */
+    metering_mode?: MeteringMode;
+
+    /** Statistics of topic. */
+    topic_stats?: TopicStats;
+}
+
+/** Partition info types differs for consumer and topic, although they are very similar */
+interface PartitionInfo {
+    /** int64  */
+    partition_id?: string;
+
+    /** Is partition open for write. */
+    active?: boolean;
+
+    /**
+     * int64
+     *
+     * Ids of partitions which was formed when this partition was split or merged.
+     */
+    child_partition_ids?: string;
+
+    /**
+     * int64
+     *
+     * Ids of partitions from which this partition was formed by split or merge.
+     */
+    parent_partition_ids?: string;
+
+    /** Stats for partition, filled only when include_stats in request is true. */
+    partition_stats?: PartitionStats;
+}
+
+interface TopicStats {
+    /**
+     * int64
+     *
+     * Approximate size of topic.
+     */
+    store_size_bytes?: string;
+
+    /**
+     * google.protobuf.Timestamp
+     *
+     * Minimum of timestamps of last write among all partitions.
+     */
+    min_last_write_time?: string;
+
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between write timestamp and create timestamp for all messages, written during last minute.
+     */
+    max_write_time_lag?: string;
+
+    /** How much bytes were written statistics. */
+    bytes_written?: MultipleWindowsStat;
+}
+
+/** Partitioning settings for topic. */
+interface PartitioningSettings {
+    /**
+     * int64
+     *
+     * Minimum partition count auto merge would stop working at.
+     *
+     * Zero value means default - 1.
+     */
+    min_active_partitions?: string;
+
+    /**
+     * int64
+     *
+     * Limit for total partition count, including active (open for write) and read-only partitions.
+     *
+     * Zero value means default - 100.
+     */
+    partition_count_limit?: string;
+}
+
+enum MeteringMode {
+    /** Use default */
+    METERING_MODE_UNSPECIFIED = 'METERING_MODE_UNSPECIFIED',
+
+    /** Metering based on resource reservation */
+    METERING_MODE_RESERVED_CAPACITY = 'METERING_MODE_RESERVED_CAPACITY',
+
+    /** Metering based on actual consumption. Default. */
+    METERING_MODE_REQUEST_UNITS = 'METERING_MODE_REQUEST_UNITS',
+}

package/dist/types/api/vdisk.ts

@@ -1,6 +1,9 @@
 import {EFlag} from './enums';
 import {TPDiskStateInfo} from './pdisk';
 
+// endpoint: /viewer/json/vdiskinfo
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
+
 export interface TVDiskStateInfo {
     VDiskId?: TVDiskID;
     /** uint64 */

package/dist/types/store/executeTopQueries.ts

@@ -0,0 +1,29 @@
+import {FETCH_TOP_QUERIES, setTopQueriesState, setTopQueriesFilters} from '../../store/reducers/executeTopQueries';
+import type {ApiRequestAction} from '../../store/utils';
+import type {IResponseError} from '../api/error';
+import type {IQueryResult} from './query';
+
+export interface ITopQueriesFilters {
+    /** ms from epoch */
+    from?: number;
+    /** ms from epoch */
+    to?: number;
+    text?: string;
+}
+
+export interface ITopQueriesState {
+    loading: boolean;
+    wasLoaded: boolean;
+    data?: IQueryResult;
+    error?: IResponseError;
+    filters: ITopQueriesFilters;
+}
+
+export type ITopQueriesAction =
+    | ApiRequestAction<typeof FETCH_TOP_QUERIES, IQueryResult, IResponseError>
+    | ReturnType<typeof setTopQueriesState>
+    | ReturnType<typeof setTopQueriesFilters>;
+
+export interface ITopQueriesRootStateSlice {
+    executeTopQueries: ITopQueriesState;
+}