Skip to main content

Get

Returns the specified regression dashboard.

To get the list of all available regression dashboards, make a List request.

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const GetRegressionDashboardRequest =
  cloudApi.loadtesting.api_regression_dashboard_service
    .GetRegressionDashboardRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(
    serviceClients.RegressionDashboardServiceClient
  );

  const result = await client.get(
    GetRegressionDashboardRequest.fromPartial({
      dashboardId: "dashboardId",
    })
  );
  console.log(result);
})();

GetRegressionDashboardRequest​

dashboardId : string​

ID of the dashboard to return.

Dashboard​

Regression dashboard.

Content​

Content of regression dashboard.

widgets : Widget​

Widgets.

id : string​

ID of the dashboard.

name : string​

Name of the dashboard.

description : string​

Description of the dashboard.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

updatedAt : google.protobuf.Timestamp​

Last update timestamp.

createdBy : string​

UA or SA that created the dashboard.

updatedBy : string​

UA or SA that updated the dashboard last time.

etag : string​

Etag of the dashboard.

content : Content​

Dashboard content.

Widget​

Regression dashboard widget.

LayoutPosition​

Widget position.

x : int64​

X.

y : int64​

Y.

width : int64​

Width.

height : int64​

Height.

position : LayoutPosition​

Widget position.

One of widget​

  • chart : ChartWidget​

    Chart widget.

  • text : TextWidget​

    Text widget.

  • title : TitleWidget​

    Title widget.

Content​

Content of regression dashboard.

widgets : Widget​

Widgets.

LayoutPosition​

Widget position.

x : int64​

X.

y : int64​

Y.

width : int64​

Width.

height : int64​

Height.

ChartWidget​

Regression chart.

id : string​

ID of the chart.

name : string​

Name of the chart.

description : string​

Description of the chart.

filterStr : string​

Test filter selector to show KPI values for.

testCase : string​

Test case to show KPI values for.

kpis : report.Kpi​

KPIs to show.

TextWidget​

Text widget.

text : string​

Text string.

TitleWidget​

Title widget.

TitleSize​

Title size.

  • TITLE_SIZE_UNSPECIFIED

    Unspecified.

  • TITLE_SIZE_XS

    Extra small.

  • TITLE_SIZE_S

    Small.

  • TITLE_SIZE_M

    Medium.

  • TITLE_SIZE_L

    Large.

text : string​

Title string.

size : TitleSize​

Title size.

Kpi​

KPI (Key Performance Indicator) represents some integral indicator measured during test.

selector : KpiSelector​

Kind of KPI.

threshold : KpiThreshold​

A condition that should be specified.

KpiSelector​

KPI selector.

ResponseTime​

Response time.

quantile : common.QuantileType​

Cummulative quantile (percentile).

Instances​

Aggregated number of instances.

agg : Aggregation​

Aggregation function.

ImbalanceRps​

Imbalance RPS.

ProtocolCodesAbsolute​
codesPatterns : string​

Protocol (HTTP, GRPC) code patterns to match.

All successful HTTP responses: '2xx', '3xx'. All failed HTTP responses: ['0', '4xx', '5xx'][3].

ProtocolCodesRelative​
codesPatterns : string​

Protocol (HTTP, GRPC) code patterns to match.

All successful HTTP responses: '2xx', '3xx'. All failed HTTP responses: ['0', '4xx', '5xx'][5].

NetworkCodesAbsolute​
codesPatterns : string​

Network code patterns to match.

All successful network responses: '0'. All failed network responses: 'xx', 'xxx'.

NetworkCodesRelative​
codesPatterns : string​

Network code patterns to match.

All successful network responses: '0'. All failed network responses: 'xx', 'xxx'.

One of kind​

  • responseTime : ResponseTime​

    Response time cummulative quantile (percentile).

  • instances : Instances​

    A number of instances throughout the test.

  • imbalanceRps : ImbalanceRps​

    An RPS at the moment the test has been auto-stopped.

  • protocolCodesAbsolute : ProtocolCodesAbsolute​

    A total number of requests completed with certain protocol (HTTP, GRPC, etc.) codes.

  • protocolCodesRelative : ProtocolCodesRelative​

    A percentage of requests completed with certain protocol (HTTP, GRPC, etc.) codes.

  • networkCodesAbsolute : NetworkCodesAbsolute​

    A total number of requests completed with certain network codes.

  • networkCodesRelative : NetworkCodesRelative​

    A percentage of requests completed with certain network codes.

KpiThreshold​

KPI threshold represents a condition that an actual value of test's KPI should satisfy.

value : double​

Value for comparison with an actual KPI value.

comparison : Comparison​

Comparison operator for comparing actual with the threshold value.

Rule: actual (</<=/>/>=) reference

ResponseTime​

Response time.

quantile : common.QuantileType​

Cummulative quantile (percentile).

Instances​

Aggregated number of instances.

agg : Aggregation​

Aggregation function.

ImbalanceRps​

Imbalance RPS.

ProtocolCodesAbsolute​

codesPatterns : string​

Protocol (HTTP, GRPC) code patterns to match.

All successful HTTP responses: '2xx', '3xx'. All failed HTTP responses: ['0', '4xx', '5xx'][11].

ProtocolCodesRelative​

codesPatterns : string​

Protocol (HTTP, GRPC) code patterns to match.

All successful HTTP responses: '2xx', '3xx'. All failed HTTP responses: ['0', '4xx', '5xx'][13].

NetworkCodesAbsolute​

codesPatterns : string​

Network code patterns to match.

All successful network responses: '0'. All failed network responses: 'xx', 'xxx'.

NetworkCodesRelative​

codesPatterns : string​

Network code patterns to match.

All successful network responses: '0'. All failed network responses: 'xx', 'xxx'.

[3]: #protocolcodesrelative'0', '4xx', '5xx'

[5]: #protocolcodesrelative'0', '4xx', '5xx'

[11]: #protocolcodesrelative'0', '4xx', '5xx'

[13]: #protocolcodesrelative'0', '4xx', '5xx'