unleash-server
Version:
Unleash is an enterprise ready feature flag service. It provides different strategies for handling feature flags.
44 lines • 2.01 kB
TypeScript
import type { FromSchema } from 'json-schema-to-ts';
export declare const metricQuerySchema: {
readonly $id: "#/components/schemas/metricQuerySchema";
readonly type: "object";
readonly required: readonly ["metricName", "timeRange", "aggregationMode", "labelSelectors"];
readonly description: "Common metric query configuration for selecting and filtering metric data.";
readonly additionalProperties: false;
readonly properties: {
readonly metricName: {
readonly type: "string";
readonly description: "The Prometheus metric series to query. It includes both unleash prefix and metric type and display name";
readonly example: "unleash_counter_feature_toggle_usage_total";
};
readonly timeRange: {
readonly type: "string";
readonly enum: readonly ["hour", "day", "week", "month"];
readonly description: "The time range for the metric data.";
readonly example: "day";
};
readonly aggregationMode: {
readonly type: "string";
readonly description: "The aggregation mode for the metric data.";
readonly enum: readonly ["rps", "count", "avg", "sum", "p95", "p99", "p50"];
readonly example: "rps";
};
readonly labelSelectors: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly description: "The selected labels and their values for filtering the metric data.";
readonly example: {
readonly environment: readonly ["development"];
readonly project: readonly ["default"];
};
};
};
readonly components: {};
};
export type MetricQuerySchema = FromSchema<typeof metricQuerySchema>;
//# sourceMappingURL=metric-query-schema.d.ts.map