Function getDirectAccessAgentLoadPerformanceMetrics

  • Retrieves performance metrics for loads processed by the gateway, either for all loads or a filtered subset. Use these metrics to evaluate reload throughput, connector latency, and concurrent reload activity. The requestor must have the TenantAdmin role and be either the gateway's space owner or a member of the gateway's space with the Can Consume Data role. Load performance recording is disabled by default and is controlled by the BENCHMARK_LOAD_PERFORMANCE_METRICS_RECORDING_ENABLED configuration property. Available in Direct Access Gateway V1.7.17+.

    Parameters

    • agentId: string

      The agent ID

    • query: {
          filter?: string;
          limit?: number;
          page?: number;
          sort?:
              | "-benchmarkStartTime"
              | "+benchmarkStartTime"
              | "benchmarkStartTime"
              | "-benchmarkEndTime"
              | "+benchmarkEndTime"
              | "benchmarkEndTime"
              | "-dataTransmissionStartTime"
              | "+dataTransmissionStartTime"
              | "dataTransmissionStartTime"
              | "-dataTransmissionEndTime"
              | "+dataTransmissionEndTime"
              | "dataTransmissionEndTime";
      }

      an object with query parameters

      • Optionalfilter?: string

        SCIM style filter string as defined in RFC 7644 section 3.4.2.2

      • Optionallimit?: number

        The page size

      • Optionalpage?: number

        The page number

      • Optionalsort?:
            | "-benchmarkStartTime"
            | "+benchmarkStartTime"
            | "benchmarkStartTime"
            | "-benchmarkEndTime"
            | "+benchmarkEndTime"
            | "benchmarkEndTime"
            | "-dataTransmissionStartTime"
            | "+dataTransmissionStartTime"
            | "dataTransmissionStartTime"
            | "-dataTransmissionEndTime"
            | "+dataTransmissionEndTime"
            | "dataTransmissionEndTime"

        The field to sort by with +/- prefix indicating sort order

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetDirectAccessAgentLoadPerformanceMetricsHttpResponse>

    GetDirectAccessAgentLoadPerformanceMetricsHttpError

Settings
Member Visibility