--- title: "List the telemetry metrics that are available for the requested telemetry source." method: GET path: "/v2/organizations/{organization}/telemetry/sources/{source}/metrics" tags: ["Metrics"] --- # List the telemetry metrics that are available for the requested telemetry source. `GET /v2/organizations/{organization}/telemetry/sources/{source}/metrics` ## Request - Base URL: `https://docs.tetrate.io` (the document declares no server; this is the origin it was published from) - URL: `https://docs.tetrate.io/v2/organizations/{organization}/telemetry/sources/{source}/metrics` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `organization` string, required - `source` string, required ## Response `200` A successful response. - V2ListMetricsResponse: List of telemetry metrics from the resource. - `metrics` V2Metric[] - `fqn` string - `displayName` string - `etag` string - `description` string - `observedResource` string: Which concrete TSB resource in the configuration hierarchy this metric observes and belongs to. For instance, a metric can observe a service, a concrete service workload (pod or Vm), or a gateway, or a workspace, or any other resource in the configuration hierarchy. - `measure` V2Measure: A measure represents the name and unit of a measurement. For example, request latency in ms and the number of errors are examples of measures to collect from a server. In this case latency would be the type and ms (millisecond) is the unit. - `name` string: The name of the measure. For instance latency in ms. More reference values can be found at MeshControlledMeasureNames. - `unit` string: The unit of measure, which follow the [unified code for units of measure](https://ucum.org/ucum.html). For COUNTABLE measures, as number of requests or network packets, SHOULD use the default unit, the unity, and [annotations](https://ucum.org/ucum.html#para-curly) with curly braces to give additional meaning. For example {requests}, {packets}, {errors}, {faults}, etc. - `type` V2MetricType: Metric types are the aggregation function applied to the measurements that took place over a period of time. Some metric types like LABELED_COUNTER and PERCENTILE also additionally aggregated over the set of defined labels. - `name` 'INVALID_METRIC_TYPE' | 'GAUGE' | 'COUNTER' | 'AVERAGE' | 'PERCENT' | 'APDEX' | 'HEATMAPS' | 'LABELED_COUNTER' | 'PERCENTILE' | 'CPM' | 'MAX': - GAUGE: Is the last seen measurement over a period of time. - COUNTER: Is the sum of number of measurement over a period of time. Used in number of request style of metrics. - AVERAGE: Average function applied to the measurements. Used in Duration/latency style of metrics. - PERCENT: Percentage function applied to a given observed value over the total observer values. Used in SLA style of metrics, for example the percentage of errored responses over the total server responses. - APDEX: Application Performance Index monitors end-user satisfaction. [Apdex score](https://www.tetrate.io/blog/the-apdex-score-for-measuring-service-mesh-health) - HEATMAPS: Heat maps are a three dimensional visualization, using x and y coordinates for two dimensions, and color intensity for the third. They can reveal detail that summary statistics, such as line charts of averages, can miss. Latency measurements can be aggregated using Heatmaps/histograms. One dimension is often time, the other is the latency, and the third one (the intensity) is the frequency of that latency in the given time range. - LABELED_COUNTER: Is the sum of number of measurement over time grouped by concrete label values. Used for counting responses by their http response code for instance. - PERCENTILE: This is a specific subtype of LABELED_COUNTER. Used in duration/latency style metrics. - CPM: Calls per minute used. Used in requests per minute, or in 5xx http errors per minute, 4xx http errors per minute, among other metrics. - MAX: Selects the highest measurement over a period of time. Envoy max allocated style metrics. - `labels` V2MetricTypeLabel[]: The labels associated with the metric type. Some aggregation function are not just applied over time. LABELED_COUNTER and PERCENTILE metric types also aggregate over their labels. For instance, a PERCENTILE metric type over the latency, will aggregate the measured latency over the different defined percentiles, p50, p75, p90, p95, and p99. - `key` string: The label key. - `value` string: The label value, for instance p50, or p75. - `origin` 'INVALID_METRIC_ORIGIN' | 'MESH_CONTROLLED' | 'AGENT_OBSERVED' | 'MESH_IMPORTED' | 'EXTERNAL_IMPORTED': From where the metric measurements come from. - MESH_CONTROLLED: The metrics origin is from a TSB configured mesh, capturing the metrics from the sidecar's available observability. - AGENT_OBSERVED: An agent which can be standalone or service with automatically instrumentation via byte code injection. Currently not available. Part of hybrid observability. - MESH_IMPORTED: Other known mesh generated metrics that are not configured and handled by TSB. Currently not available. Part of hybrid observability. - EXTERNAL_IMPORTED: External captured metrics that are either imported into TSB observability stack or queried at runtime. Currently not available. Part of hybrid observability. - `detectionPoint` 'INVALID_METRIC_DETECTION_POINT' | 'IN_SERVICE' | 'CLIENT_SIDE' | 'SERVER_SIDE': From which detection point the metric is observed. - IN_SERVICE: Self observability metrics uses in service detect point. - CLIENT_SIDE: Client side is how the client is observing the metric. When service A calls service B, service A acts as a client side. - SERVER_SIDE: Server side is how the server is observing the metric. When service A calls service B, service B acts as the server side. ## Other responses - `default`: An unexpected error response. --- [API](https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api.md) - [All operations](https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api/revisions/2f19c3a1ae57?raw)