observability_live.go (package eai)
Source: sdks/go/observability_live.go. Back to the Go SDK reference index.
This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.
Class PlatformManagerService
Platform Manager. Platform Manager space of the console: the Control Plane bridge to the Navin Manager, which installs, connects and operates the platform services on the customer's machines, plus the IT vault of the platform administrators.
PlatformManagerService.RequestSupportBundle
RequestSupportBundle(ctx context.Context, clusterID string, opts ...CallOption) (json.RawMessage, error)
Request a support bundle. Asks the Manager for a sanitized support bundle (cluster:manage there) and answers 202 with the operation to follow and the bundle id; the bundle is downloaded from the Manager console. Audited (platform_manager.support_bundle), allowed or refused. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/support-bundles (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
ctx | context.Context | yes | Context of the call: cancellation and deadline. | |
clusterID | string | yes | Identifier of the cluster in the Navin Manager. | |
opts | ...CallOption | no | Per call options (query, idempotency key, traceparent, headers). |
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Request a support bundle". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.ServiceConfigDiff
ServiceConfigDiff(ctx context.Context, clusterID string, service string, from int, to int, opts ...CallOption) (json.RawMessage, error)
Compare two configuration versions. Changed parameters between two configuration versions of a service, one entry per parameter; a secret parameter only says whether it is set in each version, never its value. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/services/{service}/config/diff (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
ctx | context.Context | yes | Context of the call: cancellation and deadline. | |
clusterID | string | yes | Identifier of the cluster in the Navin Manager. | |
service | string | yes | Name of the service. | |
from | int | yes | Older configuration version, integer of at least 1 (required). | |
to | int | yes | Newer configuration version, integer of at least 1 (required). | |
opts | ...CallOption | no | Per call options (query, idempotency key, traceparent, headers). |
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Compare two configuration versions". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.ServiceDashboard
ServiceDashboard(ctx context.Context, clusterID string, service string, query map[string]string, opts ...CallOption) (json.RawMessage, error)
Read the dashboard of a service. Monitoring dashboard of a service relayed from the Manager (cluster:read there): instances, health and latest checks, availability, the machines it detected with their components and metrics, alerts, operations, configuration and, for a connected service, its connection. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/services/{service}/dashboard (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
ctx | context.Context | yes | Context of the call: cancellation and deadline. | |
clusterID | string | yes | Identifier of the cluster in the Navin Manager. | |
service | string | yes | Name of the service. | |
query | map[string]string | yes | Query string parameters of the route. | |
opts | ...CallOption | no | Per call options (query, idempotency key, traceparent, headers). |
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "Read the dashboard of a service". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).
PlatformManagerService.SupportBundles
SupportBundles(ctx context.Context, clusterID string, opts ...CallOption) (json.RawMessage, error)
List the support bundles. Sanitized support bundles of a cluster; a bundle is downloaded from the Manager console, never through the Control Plane. Requires platform_admin.
Route: /v1/platform-manager/clusters/{cluster_id}/support-bundles (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
ctx | context.Context | yes | Context of the call: cancellation and deadline. | |
clusterID | string | yes | Identifier of the cluster in the Navin Manager. | |
opts | ...CallOption | no | Per call options (query, idempotency key, traceparent, headers). |
Returns: (json.RawMessage, error). Decoded JSON answer of the operation "List the support bundles". The error is a typed error of the SDK, nil on success.
Raises: error, the typed errors of the transport (Errors).