Observability API overview

The Observability API uses Kubernetes custom resources and relies on the Kubernetes Resource Model (KRM) for provisioning and administration of logging and monitoring resources. It is used to manage the lifecycle of Observability services in a given organization (installing, upgrading, uninstalling).

A number of Observability services are available automatically for a project that is provisioned. As a user of the Observability API, you do not and cannot create or delete these default objects. See the specific objects and services below for additional information.

To use the Observability API, we recommend that you use the GDC provided CLI gdcloud. If your application needs to use your own libraries to call this API, use the following examples and the full API definition to build your requests.

Service endpoint and discovery document

The API endpoint for the Observability API is: https://[ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT]/apis/observability.gdc.goog/v1alpha1 where [ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT] is the API endpoint of your admin Kubernetes cluster. Also Monitoring and Logging follow a similar convention with: https://[ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT]/apis/monitoring.gdc.goog/v1alpha1 and https://[ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT]/apis/logging.gdc.goog/v1alpha1

Using the kubectl proxy command, you can access that URL in your browser or with a tool such as curl to get the discovery document for the Marketplace API. The kubectl proxy command opens up a proxy to the Kubernetes API server on your local machine. Once that command is running, you can access the document at the following URL: http://127.0.0.1:8001/apis/marketplace.gdc.goog/v1alpha1.

Many Observability services are available automatically for a provisioned project, for example, logging, monitoring, and alerting. For more information about using the Observability API in logging and monitoring services and deploying a particular CR for your project, read the corresponding documentation in the following sections: