@yugabytedb/perf-advisor-client 0.0.0-stage → 0.0.1

package/dist/generated/model/getQueryStatsParams.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { TimeWindow } from './timeWindow';
+import type { WaitEventGrouping } from './waitEventGrouping';
+export type GetQueryStatsParams = {
+    /**
+     * The time window: `start_time` and `end_time`, each a query parameter of its own. `end_time` defaults to now; each operation documents the default `start_time`.
+     */
+    window?: TimeWindow;
+    /**
+     * Break each row's load down by wait event type (`TYPE`) or by wait event (`EVENT`), in
+     * `info.wait_events`. Without it there is no breakdown.
+     */
+    group_events_by?: WaitEventGrouping;
+};

package/dist/generated/model/graph.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { GraphLayout } from './graphLayout';
+import type { GraphSeries } from './graphSeries';
+/**
+ * Data of one queried graph.
+ */
+export interface Graph {
+    readonly name: string;
+    readonly successful: boolean;
+    readonly error_message?: string;
+    readonly step_seconds?: number;
+    layout?: GraphLayout;
+    readonly series?: readonly GraphSeries[];
+}

package/dist/generated/model/graphAxis.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { GraphAxisAlias } from './graphAxisAlias';
+export interface GraphAxis {
+    readonly type?: string;
+    /** Display names of series, by series name. */
+    readonly alias?: GraphAxisAlias;
+    readonly tick_suffix?: string;
+    readonly tick_format?: string;
+}

package/dist/generated/model/graphAxisAlias.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * Display names of series, by series name.
+ */
+export type GraphAxisAlias = {
+    [key: string]: string;
+};

package/dist/generated/model/graphCatalogEntry.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { GraphLayout } from './graphLayout';
+/**
+ * A graph Perf Advisor can draw.
+ */
+export interface GraphCatalogEntry {
+    readonly name: string;
+    readonly title?: string;
+    /** `METRIC` - a metric graph; `ANOMALY` - anomalies over time. New values may be added. */
+    readonly kind?: string;
+    /** Where the data comes from: `NODE` (node metrics) or `PA` (Perf Advisor's own). New values may be added. */
+    readonly data_source?: string;
+    /** Whether the graph needs `range_seconds` in its query. */
+    readonly range?: boolean;
+    layout?: GraphLayout;
+    /** Graph labels (snake_case) the graph can be filtered by. */
+    readonly supported_filters?: readonly string[];
+    /** Graph labels (snake_case) the graph can be split by. */
+    readonly supported_group_by?: readonly string[];
+}

package/dist/generated/model/graphFilters.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * Label values to keep (or exclude), by graph label in snake_case - for example `query_id`,
+ * `db_id`, `instance_name` or `table_name`. A graph's catalog entry lists the labels it supports.
+ */
+export interface GraphFilters {
+    [key: string]: string[];
+}

package/dist/generated/model/graphGroupByOption.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export interface GraphGroupByOption {
+    /** Graph label (snake_case). */
+    readonly label?: string;
+    /** Display name. */
+    readonly name?: string;
+}

package/dist/generated/model/graphLayout.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { GraphAxis } from './graphAxis';
+import type { GraphGroupByOption } from './graphGroupByOption';
+/**
+ * How to draw a graph.
+ */
+export interface GraphLayout {
+    readonly title?: string;
+    /** `COMMON` or `ASH` (active session history). New values may be added. */
+    readonly type?: string;
+    x_axis?: GraphAxis;
+    y_axis?: GraphAxis;
+    readonly supported_group_by?: readonly GraphGroupByOption[];
+    /** Graph labels (snake_case) the series are split by. */
+    readonly current_group_by?: readonly string[];
+}

package/dist/generated/model/graphQuerySpec.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { AggregatedLineSettings } from './aggregatedLineSettings';
+import type { GraphFilters } from './graphFilters';
+import type { GraphSettings } from './graphSettings';
+import type { GraphWindow } from './graphWindow';
+/**
+ * A graph to draw for a universe, over a time window.
+ */
+export interface GraphQuerySpec {
+    /** Graph name, from the graph catalog. */
+    name: string;
+    window: GraphWindow;
+    /** Range of range graphs. */
+    range_seconds?: number;
+    filters?: GraphFilters;
+    exclude_filters?: GraphFilters;
+    /** Graph labels (snake_case) to split the series by. */
+    group_by?: string[];
+    aggregated_line?: AggregatedLineSettings;
+    settings?: GraphSettings;
+    /** Whether to drop points without a value. */
+    replace_nan?: boolean;
+    /** Whether to add missing points so all series share timestamps. */
+    fill_missing_points?: boolean;
+}

package/dist/generated/model/graphSeries.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { GraphSeriesLabels } from './graphSeriesLabels';
+import type { TableRef } from './tableRef';
+import type { WaitEvent } from './waitEvent';
+/**
+ * One line of a graph.
+ */
+export interface GraphSeries {
+    readonly name?: string;
+    /** Label values identifying the series. */
+    readonly labels?: GraphSeriesLabels;
+    readonly instance_name?: string;
+    table?: TableRef;
+    readonly type?: string;
+    wait_event?: WaitEvent;
+    /** Whether the series is universe-wide rather than for one node. */
+    readonly global?: boolean;
+    /** Point times, in milliseconds since the epoch. */
+    readonly timestamps: readonly number[];
+    /** Point values, matching `timestamps`. Null where there is no value. */
+    readonly values: readonly (number | null)[];
+}

package/dist/generated/model/graphSeriesLabels.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * Label values identifying the series.
+ */
+export type GraphSeriesLabels = {
+    [key: string]: string;
+};

package/dist/generated/model/graphSettings.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { GraphSettingsAggregatedValueFunction } from './graphSettingsAggregatedValueFunction';
+import type { GraphSettingsSplitMode } from './graphSettingsSplitMode';
+import type { GraphSettingsSplitType } from './graphSettingsSplitType';
+/**
+ * How to split a graph into the top or bottom series.
+ */
+export interface GraphSettings {
+    split_mode?: GraphSettingsSplitMode;
+    split_type?: GraphSettingsSplitType;
+    split_count?: number;
+    /** Whether to add a series aggregating the rest. */
+    return_aggregated_value?: boolean;
+    aggregated_value_function?: GraphSettingsAggregatedValueFunction;
+}

package/dist/generated/model/graphSettingsAggregatedValueFunction.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export type GraphSettingsAggregatedValueFunction = typeof GraphSettingsAggregatedValueFunction[keyof typeof GraphSettingsAggregatedValueFunction];
+export declare const GraphSettingsAggregatedValueFunction: {
+    readonly MIN: "MIN";
+    readonly MAX: "MAX";
+    readonly AVG: "AVG";
+    readonly SUM: "SUM";
+};

package/dist/generated/model/graphSettingsSplitMode.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export type GraphSettingsSplitMode = typeof GraphSettingsSplitMode[keyof typeof GraphSettingsSplitMode];
+export declare const GraphSettingsSplitMode: {
+    readonly NONE: "NONE";
+    readonly TOP: "TOP";
+    readonly BOTTOM: "BOTTOM";
+};

package/dist/generated/model/graphSettingsSplitType.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export type GraphSettingsSplitType = typeof GraphSettingsSplitType[keyof typeof GraphSettingsSplitType];
+export declare const GraphSettingsSplitType: {
+    readonly NONE: "NONE";
+    readonly NODE: "NODE";
+    readonly TABLE: "TABLE";
+    readonly NAMESPACE: "NAMESPACE";
+};

package/dist/generated/model/graphWindow.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { TimeWindow } from './timeWindow';
+/**
+ * The period a graph covers, and its resolution.
+ */
+export type GraphWindow = TimeWindow & {
+    /** Seconds between the graph's points. */
+    step_seconds?: number;
+};

package/dist/generated/model/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { IndexInfo } from './indexInfo';
+/**
+ * A YSQL index.
+ */
+export interface Index {
+    info: IndexInfo;
+}

package/dist/generated/model/indexColumn.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * A column or expression of an index.
+ */
+export interface IndexColumn {
+    readonly name?: string;
+    /** The column, or the expression, as the index defines it. */
+    readonly definition?: string;
+    /** Ordering and other options, such as `HASH` or `ASC NULLS LAST`. */
+    readonly options?: string;
+}

package/dist/generated/model/indexDefinition.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * An index, by name, with its definition.
+ */
+export interface IndexDefinition {
+    readonly name?: string;
+    /** The `CREATE INDEX` statement. */
+    readonly definition?: string;
+}

package/dist/generated/model/indexFilter.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * Which indexes to list.
+ */
+export interface IndexFilter {
+    /** Only indexes of this database, by exact name. */
+    namespace_name?: string;
+    /** Only indexes of this schema, by exact name. */
+    schema_name?: string;
+    /** Only indexes of this table, by exact name. */
+    table_name?: string;
+    /** Only the index with this exact name. */
+    index_name?: string;
+    /** Only indexes whose name contains this text, ignoring case. */
+    index_name_contains?: string;
+    /** Only indexes whose definition contains this text. */
+    definition?: string;
+}

package/dist/generated/model/indexFlags.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * What kind of index it is.
+ */
+export interface IndexFlags {
+    /** Whether it is the table's primary key. */
+    readonly primary?: boolean;
+    readonly unique?: boolean;
+    /** Whether it backs a constraint, such as a primary key or unique constraint. */
+    readonly constraint_index?: boolean;
+    /** Whether a unique index treats nulls as equal (`NULLS NOT DISTINCT`). */
+    readonly null_not_distinct?: boolean;
+}

package/dist/generated/model/indexInfo.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { IndexColumn } from './indexColumn';
+import type { IndexFlags } from './indexFlags';
+import type { ObjectLifecycle } from './objectLifecycle';
+import type { ObjectNamespace } from './objectNamespace';
+export interface IndexInfo {
+    namespace: ObjectNamespace;
+    readonly index_name: string;
+    readonly table_name?: string;
+    /** Index OID. */
+    readonly index_id?: number;
+    /** Access method, for example `lsm`. */
+    readonly index_type?: string;
+    readonly tablespace_name?: string;
+    /** CREATE INDEX statement. */
+    readonly definition?: string;
+    /** Predicate of a partial index. */
+    readonly where_clause?: string;
+    lifecycle?: ObjectLifecycle;
+    flags?: IndexFlags;
+    /** The indexed columns and expressions, in order. */
+    readonly columns?: readonly IndexColumn[];
+}

package/dist/generated/model/indexPagedResp.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { Index } from './index';
+import type { Pagination } from './pagination';
+export type IndexPagedResp = Pagination & {
+    entities: Index[];
+};

package/dist/generated/model/indexSortBy.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+export type IndexSortBy = typeof IndexSortBy[keyof typeof IndexSortBy];
+export declare const IndexSortBy: {
+    readonly NAMESPACE_NAME: "NAMESPACE_NAME";
+    readonly SCHEMA_NAME: "SCHEMA_NAME";
+    readonly TABLE_NAME: "TABLE_NAME";
+    readonly INDEX_NAME: "INDEX_NAME";
+    readonly FIRST_SEEN_TIME: "FIRST_SEEN_TIME";
+};

package/dist/generated/model/internalErrorResponse.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { Error } from './error';
+/**
+ * Unexpected server error.
+ */
+export type InternalErrorResponse = Error;

package/dist/generated/model/kubernetesPod.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * The Kubernetes pod a node runs in.
+ */
+export interface KubernetesPod {
+    readonly name?: string;
+    readonly namespace?: string;
+}

package/dist/generated/model/latencyStats.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+/**
+ * Latency over the requested period. Not set without samples.
+ */
+export interface LatencyStats {
+    /** Average latency, in milliseconds. */
+    readonly avg_ms?: number;
+    /** 90th percentile latency, in milliseconds. */
+    readonly p90_ms?: number;
+    /** 99th percentile latency, in milliseconds. */
+    readonly p99_ms?: number;
+}

package/dist/generated/model/listAnomaliesParams.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Perf Advisor API
+ * Perf Advisor v2 REST API.
+ *
+ * Resources are returned as `{ spec, info }`: `spec` holds the properties a client sets,
+ * `info` holds read-only properties Perf Advisor computes.
+ *
+ * OpenAPI spec version: v2
+ */
+import type { AnomalyFilter } from './anomalyFilter';
+import type { AnomalySortBy } from './anomalySortBy';
+import type { NodeFilter } from './nodeFilter';
+import type { PageRequest } from './pageRequest';
+import type { TimeWindow } from './timeWindow';
+export type ListAnomaliesParams = {
+    /**
+     * The page to return: `offset`, `limit`, `direction` and `need_total_count`, each a query parameter of its own.
+     */
+    paging?: PageRequest;
+    /**
+     * The time window: `start_time` and `end_time`, each a query parameter of its own. `end_time` defaults to now; each operation documents the default `start_time`.
+     */
+    window?: TimeWindow;
+    /**
+     * Which anomalies to list: `anomaly_type`, `category`, `type`, `summary`, `query`, `database_name`, `schema_name` and `table_name`, each a query parameter of its own.
+     */
+    filter?: AnomalyFilter;
+    /**
+     * Which nodes' data to include: `cluster_uuids`, `region_codes`, `zone_codes`, `node_names` and `server_types`, each a query parameter of its own.
+     */
+    nodes?: NodeFilter;
+    /**
+     * What to sort by, `START_TIME` by default. Ties are broken by the anomaly UUID.
+     */
+    sort_by?: AnomalySortBy;
+};