KRM API observability.gdc.goog/v1

observability.gdc.goog/v1

Contains API Schema definitions for the Observability group.

AdditionalLogSink

Configures the additional sinks to route logs.

Appears in: - ObservabilityAuditLogging - ObservabilityLogging - ObservabilitySecurityLogging

Field Description
clusterSelector ClusterSelector
fluentbitConfigMaps string array
volumes Volume array
volumeMounts VolumeMount array

ClusterSelector

Selects target clusters.

Appears in: - AdditionalLogSink

Field Description
exclude string array

Dashboard

Defines the Schema for the Dashboards API.

Appears in: - DashboardList

Field Description
apiVersion string observability.gdc.goog/v1
kind string Dashboard
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec DashboardSpec
status DashboardStatus

DashboardConfigMap

Provides information about the ConfigMap object that contains the JSON model of a monitoring dashboard.

Appears in: - DashboardSpec

Field Description
name string The name of the ConfigMap object containing the JSON model of the dashboard.
namespace string The namespace of the ConfigMap object containing the JSON model of the dashboard.
key string The key of the ConfigMap object containing the JSON model of the dashboard.

DashboardInfo

Contains a list of information about the connection of a dashboard created in the monitoring dashboard.

Appears in: - DashboardStatus

Field Description
uid string The unique ID of the dashboard.
url string The path to the dashboard.

DashboardList

Contains a list of monitoring dashboards.

Field Description
apiVersion string observability.gdc.goog/v1
kind string DashboardList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Dashboard array

DashboardSpec

Defines the specification or expected state of the Dashboard object.

Appears in: - Dashboard

Field Description
configMapRef DashboardConfigMap The ConfigMap object that contains the JSON model of the monitoring dashboard to include.
foldername string The name of the folder where the system must store the dashboards.

DashboardStatus

Defines the observed state of the Dashboard object.

Appears in: - Dashboard

Field Description
conditions Condition array A list of conditions observed in the dashboard.
dashboards object (keys:string, values:DashboardInfo) A mapping of all the dashboards created by the custom resource using the unique ID (uid) of the dashboard as the key.

Grafana

Defines the expected state of the monitoring dashboard instance provisioned.

Appears in: - ObservabilityMonitoring

Field Description
storageSize string The storage size for the dashboards within an organization. https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/

ObservabilityAlerting

Defines the rules to create alerts based on metrics data.

Appears in: - ObservabilityPipelineSpec

Field Description
localStorageSize string The storage size for alerting data within an organization.
alertmanagerConfig string The name of the ConfigMap object that contains the Alertmanager configuration file. https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names
volumes Volume array
volumeMounts VolumeMount array

ObservabilityAuditLogging

Defines the expected state of the audit logging stack of the Observability pipeline.

Appears in: - ObservabilityPipelineSpec

Field Description
retentionTime string The retention time for audit logs in hours. https://cortexmetrics.io/docs/configuration/configuration-file/#generic-placeholders
localStorageSize string The storage size for audit logging data within an organization. https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/
additionalSink AdditionalLogSink The configuration of an optional additional sink for all audit logs.
dynamicAdditionalSinks string array The additional sinks for audit logs apart from any predefined sink. The difference with the additionalSink field is that dynamicAdditionalSinks determines most of the sink variables, such as the sink's hostname, on the user's behalf. The supported outputs include ioSplunkExternalSink.

ObservabilityLogging

Defines the expected state of the logging stack of the Observability pipeline.

Appears in: - ObservabilityPipelineSpec

Field Description
retentionTime string The retention time for operational logs in hours. https://cortexmetrics.io/docs/configuration/configuration-file/#generic-placeholders
localStorageSize string The storage size for logging data within an organization. https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/
sink string The sink for all logs. For example, using the project namespace of an Application Operator as a value means that the logs become visible to the Application Operator of the project.
additionalSink AdditionalLogSink The configuration of an optional additional sink for all operational logs.
dynamicAdditionalSinks string array The additional sinks for operational logs apart from any predefined sink. The difference with the additionalSink field is that dynamicAdditionalSinks determines most of the sink variables, such as the sink's hostname, on the user's behalf. The supported outputs include ioSplunkExternalSink.

ObservabilityMonitoring

Defines the configuration for the monitoring dashboards.

Appears in: - ObservabilityPipelineSpec

Field Description
retentionTime string Retention time for metrics in hours. https://cortexmetrics.io/docs/configuration/configuration-file/#generic-placeholders
localStorageSize string The storage size for metrics data within an organization. https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/
grafana Grafana The configuration information for the monitoring dashboard instance to create.
sink string The sink for all metrics. For example, using the project namespace of an Application Operator as a value means that the metrics become visible to the Application Operator of the project. Route by time series using the timeseries label.

ObservabilityPipeline

Defines the Schema for the Observability Pipeline API.

Appears in: - ObservabilityPipelineList

Field Description
apiVersion string observability.gdc.goog/v1
kind string ObservabilityPipeline
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ObservabilityPipelineSpec
status ObservabilityPipelineStatus

ObservabilityPipelineList

Contains a list of ObservabilityPipeline objects.

Field Description
apiVersion string observability.gdc.goog/v1
kind string ObservabilityPipelineList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ObservabilityPipeline array

ObservabilityPipelineSpec

Defines the specification or expected state of the ObservabilityPipeline object.

Appears in: - ObservabilityPipeline

Field Description
enabled boolean Specifies if the Observability pipeline stack is enabled.
monitoring ObservabilityMonitoring The monitoring pipeline configuration.
alerting ObservabilityAlerting The Alertmanager pipeline configuration.
logging ObservabilityLogging The logging pipeline configuration.
auditLogging ObservabilityAuditLogging The audit logging pipeline configuration.
securityLogging ObservabilitySecurityLogging The security pipeline configuration.

ObservabilityPipelineStatus

Defines the observed state of the ObservabilityPipeline object.

Appears in: - ObservabilityPipeline

Field Description
version string The installed version of the Observability pipeline stack.
conditions Condition array A list of conditions observed in the Observability pipeline stack.

ObservabilitySecurityLogging

Defines the expected state of the security logging stack of the Observability pipeline.

Appears in: - ObservabilityPipelineSpec

Field Description
retentionTime string The retention time for security logs in hours. https://cortexmetrics.io/docs/configuration/configuration-file/#generic-placeholders
localStorageSize string The storage size for security logging data within an organization. https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/
additionalSink AdditionalLogSink The configuration of an optional additional sink for all security logs.
dynamicAdditionalSinks string array The additional sinks for security logs apart from any predefined sink. The difference with the additionalSink field is that dynamicAdditionalSinks determines most of the sink variables, such as the sink's hostname, on the user's behalf. The supported outputs include ioSplunkExternalSink.