Telemetry Stack

These endpoints manage the telemetry (observability) stack of an organization. A monitoring cluster is one of the owner’s imported clusters that has been designated to receive telemetry from other clusters. The APIs here list monitoring clusters, install the OpenTelemetry-based telemetry stack on a cluster, generate the appscode-otel-stack Helm values that target clusters use to ship data to a monitoring cluster, expose the monitoring cluster’s ingress host, and list the tenants it serves.

All paths below are relative to the API base /api/v1; the full prefix for this page is /api/v1/telemetry.

Auth for all endpoints on this page: bearer token plus org-admin context — the caller must be an admin of the {owner} organization. {owner} is the slug of an organization or user that owns the cluster.

A documented call looks like:

curl -H "Authorization: token $AKP_TOKEN" \
  "https://<akp-host>/api/v1/telemetry/appscode/monitoring-clusters?targetClusterName=arnob-dev"

Monitoring clusters

GET /telemetry/{owner}/monitoring-clusters

Returns the names of clusters imported by the owner that are configured as monitoring clusters, optionally filtered to the region of a target cluster.

• Auth: token + org admin (admin of {owner}).

Path parameters:

Query parameters:

* Marked optional in the schema, but the region-resolution step needs a resolvable target cluster. In practice call it with targetClusterName set; omitting it can fail to resolve cluster info (see verification note below).

Response 200: a JSON array of monitoring cluster names.

["arnob-monitoring"]

Verified: GET returned 200 against appscode/arnob-monitoring (with ?targetClusterName=arnob-dev) on 2026-07-14. Without targetClusterName the call returned 500 (cluster info not found) because the region filter could not resolve a target cluster.

POST /telemetry/{owner}/{cluster}/stack

Creates a TelemetryStack custom resource on the given cluster and marks that cluster as a monitoring cluster. This is the install step for the telemetry stack.

• Auth: token + org admin (admin of {owner}).

Path parameters:

Request body (CreateTelemetryStackRequest):

{
  "name": "appscode-otel-stack",
  "namespace": "monitoring",
  "spec": {
    "...": "TelemetryStackSpec (go.open-pulse.dev/tenant-operator)"
  }
}

Response 200: the created TelemetryStack object — an arbitrary Kubernetes object returned verbatim from the cluster.

{
  "apiVersion": "monitoring.open-pulse.dev/v1alpha1",
  "kind": "TelemetryStack",
  "metadata": { "name": "appscode-otel-stack", "namespace": "monitoring" },
  "spec": { "...": "..." }
}

Not verified live — this is a POST (mutating) request and is documented from the schema only.

GET /telemetry/{owner}/{cluster}/values/appscode-otel-stack

Returns the Helm values for the opentelemetry-kube-stack chart to install on a target cluster so that it ships telemetry to the given monitoring cluster.

• Auth: token + org admin (admin of {owner}).

Path parameters:

Query parameters:

Response 200: a dynamic Helm values object for the appscode-otel-stack chart (an arbitrary Kubernetes/values object). Shape depends on the chart; a truncated, sanitized example:

{
  "opentelemetry-kube-stack": {
    "clusterName": "arnob-dev",
    "collectors": {
      "cluster": {
        "config": {
          "exporters": {
            "clickhouse": {
              "endpoint": "https://prom-label-proxy.monitoring.svc.cluster.local:10001/?database=default&secure=true&http_path=/api/v1/logs"
            },
            "prometheusremotewrite": {
              "endpoint": "https://prom-label-proxy.monitoring.svc.cluster.local:10001/api/v1/receive"
            }
          }
        }
      }
    }
  }
}

Verified: GET returned 200 against appscode/arnob-monitoring (with ?targetClusterName=arnob-dev) on 2026-07-14.

GET /telemetry/{owner}/{cluster}/stack/host

Returns the ingress host (hostname or IP) of the given monitoring cluster, used by telemetry collectors as their upstream endpoint.

• Auth: token + org admin (admin of {owner}).

Path parameters:

Response 200: a JSON string with the host.

"10.2.0.136"

Verified: GET returned 200 against appscode/arnob-monitoring on 2026-07-14.

GET /telemetry/{owner}/{cluster}/tenants/ownerlist

Lists the Tenant custom resources present on the given monitoring cluster, returning a map of tenant owner identifier (ace.user.{id}) to the KubeDB Platform user/organization name.

• Auth: token + org admin (admin of {owner}).

Path parameters:

Response 200: a JSON object mapping tenant owner id to name.

{
  "ace.user.3": "appscode"
}

Verified: GET returned 200 against appscode/arnob-monitoring on 2026-07-14.