@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
88 lines (87 loc) • 2.74 kB
TypeScript
/**
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
* This product includes software developed at Datadog (https://www.datadoghq.com/).
* Copyright 2020-Present Datadog, Inc.
*/
import { ApmMetricsDataSource } from "./ApmMetricsDataSource";
import { ApmMetricsSpanKind } from "./ApmMetricsSpanKind";
import { ApmMetricsStat } from "./ApmMetricsStat";
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
/**
* A query for APM trace metrics such as hits, errors, and latency percentiles, aggregated across services.
*/
export declare class ApmMetricsQuery {
/**
* Organization UUIDs to query when using [cross-organization visibility](/account_management/org_settings/cross_org_visibility/). Limited to one organization UUID.
*/
"crossOrgUuids"?: Array<string>;
/**
* A data source for APM metrics queries.
*/
"dataSource": ApmMetricsDataSource;
/**
* Optional fields to group the query results by.
*/
"groupBy"?: Array<string>;
/**
* The variable name for use in formulas.
*/
"name": string;
/**
* Optional operation mode to aggregate across operation names.
*/
"operationMode"?: string;
/**
* Name of operation on service. If not provided, the primary operation name is used.
*/
"operationName"?: string;
/**
* Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
*/
"peerTags"?: Array<string>;
/**
* Additional filters for the query using metrics query syntax (for example, env, primary_tag).
*/
"queryFilter"?: string;
/**
* The resource hash for exact matching.
*/
"resourceHash"?: string;
/**
* The full name of a specific resource to filter by.
*/
"resourceName"?: string;
/**
* The service name to filter by.
*/
"service"?: string;
/**
* Describes the relationship between the span, its parents, and its children in a trace.
*/
"spanKind"?: ApmMetricsSpanKind;
/**
* The APM metric statistic to query.
*/
"stat": ApmMetricsStat;
/**
* A container for additional, undeclared properties.
* This is a holder for any undeclared properties as specified with
* the 'additionalProperties' keyword in the OAS document.
*/
"additionalProperties"?: {
[key: string]: any;
};
/**
* @ignore
*/
"_unparsed"?: boolean;
/**
* @ignore
*/
static readonly attributeTypeMap: AttributeTypeMap;
/**
* @ignore
*/
static getAttributeTypeMap(): AttributeTypeMap;
constructor();
}