Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-10-27 11:02:16 +01:00
Code Issues Projects Releases Wiki Activity

feat: add histogram to impact metrics (#10728)

Browse Source
This commit is contained in:
Mateusz Kwasniewski 2025-10-03 10:13:12 +02:00 committed by GitHub
parent adada932b9
commit 3ef2a7f93b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 137 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

179
src/lib/openapi/spec/impact-metrics-schema.ts
View File

@ -3,55 +3,150 @@ import type { FromSchema } from 'json-schema-to-ts';
export const impactMetricsSchema = {
$id: '#/components/schemas/impactMetricsSchema',
type: 'object',
required: ['name', 'help', 'type', 'samples'],
description: 'Used for reporting impact metrics from SDKs',
properties: {
name: {
type: 'string',
description: 'Name of the impact metric',
example: 'my-counter',
},
help: {
description:
'Human-readable description of what the metric measures',
type: 'string',
example: 'Counts the number of operations',
},
type: {
description: 'Type of the metric',
type: 'string',
enum: ['counter', 'gauge'],
example: 'counter',
},
samples: {
description: 'Samples of the metric',
type: 'array',
items: {
type: 'object',
required: ['value'],
description:
'A sample of a metric with a value and optional labels',
properties: {
value: {
type: 'number',
description: 'The value of the metric sample',
example: 10,
},
labels: {
description: 'Optional labels for the metric sample',
oneOf: [
{
required: ['name', 'help', 'type', 'samples'],
properties: {
name: {
type: 'string',
description: 'Name of the impact metric',
example: 'my-counter',
},
help: {
description:
'Human-readable description of what the metric measures',
type: 'string',
example: 'Counts the number of operations',
},
type: {
description: 'Type of the metric',
type: 'string',
enum: ['counter', 'gauge'],
example: 'counter',
},
samples: {
description: 'Samples of the numeric metric',
type: 'array',
items: {
type: 'object',
additionalProperties: {
type: 'string',
},
example: {
application: 'my-app',
environment: 'production',
required: ['value'],
description:
'A sample of a numeric metric with a value and optional labels',
properties: {
value: {
type: 'number',
description: 'The value of the metric sample',
example: 10,
},
labels: {
description:
'Optional labels for the metric sample',
type: 'object',
additionalProperties: {
oneOf: [
{ type: 'string' },
{ type: 'number' },
],
},
example: {
application: 'my-app',
environment: 'production',
},
},
},
},
},
},
},
},
{
required: ['name', 'help', 'type', 'samples'],
properties: {
name: {
type: 'string',
description: 'Name of the impact metric',
example: 'my-histogram',
},
help: {
description:
'Human-readable description of what the metric measures',
type: 'string',
example: 'Measures request duration',
},
type: {
description: 'Type of the metric',
type: 'string',
enum: ['histogram'],
example: 'histogram',
},
samples: {
description: 'Samples of the histogram metric',
type: 'array',
items: {
type: 'object',
required: ['count', 'sum', 'buckets'],
description:
'A sample of a histogram metric with count, sum, buckets and optional labels',
properties: {
count: {
type: 'number',
description: 'Total count of observations',
example: 100,
},
sum: {
type: 'number',
description: 'Sum of all observed values',
example: 1500,
},
buckets: {
type: 'array',
description: 'Histogram buckets',
items: {
type: 'object',
required: ['le', 'count'],
properties: {
le: {
oneOf: [
{ type: 'number' },
{
type: 'string',
enum: ['+Inf'],
},
],
description:
'Upper bound of the bucket',
example: 0.5,
},
count: {
type: 'number',
description:
'Count of observations in this bucket',
example: 30,
},
},
},
},
labels: {
description:
'Optional labels for the metric sample',
type: 'object',
additionalProperties: {
oneOf: [
{ type: 'string' },
{ type: 'number' },
],
},
example: {
application: 'my-app',
environment: 'production',
},
},
},
},
},
},
},
],
components: {
schemas: {},
},