## observability.gdc.goog/v1

Contains API Schema definitions for the Observability
group.

### AdditionalLogSink

Configures the additional sinks to route logs. For more information,
see <https://cloud.google.com/anthos/private-mode/docs/1.9/how-to/export-logs>.

*Appears in:*
- [ObservabilityAuditLogging](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#observabilityauditlogging)
- [ObservabilityLogging](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#observabilitylogging)
- [ObservabilitySecurityLogging](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#observabilitysecuritylogging)

| Field | Description |
|---|---|
| `clusterSelector` *[ClusterSelector](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#clusterselector)* |   |
| `fluentbitConfigMaps` *string array* |   |
| `volumes` *[Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#volume-v1-core) array* |   |
| `volumeMounts` *[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#volumemount-v1-core) array* |   |

### ClusterSelector

Selects target clusters.

*Appears in:*
- [AdditionalLogSink](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#additionallogsink)

| Field | Description |
|---|---|
| `exclude` *string array* |   |

### Dashboard

Defines the Schema for the Dashboards API.

*Appears in:*
- [DashboardList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#dashboardlist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `observability.gdc.goog/v1` |
| `kind` *string* | `Dashboard` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[DashboardSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#dashboardspec)* |   |
| `status` *[DashboardStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#dashboardstatus)* |   |

### DashboardConfigMap

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

*Appears in:*
- [DashboardSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#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 Grafana.

*Appears in:*
- [DashboardStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#dashboardstatus)

| Field | Description |
|---|---|
| `uid` *string* | The unique ID of the dashboard. |
| `url` *string* | The path to the dashboard. |

### DashboardList

Contains a list of dashboards in Grafana.

| Field | Description |
|---|---|
| `apiVersion` *string* | `observability.gdc.goog/v1` |
| `kind` *string* | `DashboardList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[Dashboard](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#dashboard) array* |   |

### DashboardSpec

Defines the specification or expected state of the `Dashboard` object.

*Appears in:*
- [Dashboard](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#dashboard)

| Field | Description |
|---|---|
| `configMapRef` *[DashboardConfigMap](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#dashboardconfigmap)* | The `ConfigMap` object that contains the JSON model of the Grafana 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](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#dashboard)

| Field | Description |
|---|---|
| `conditions` *[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array* | A list of conditions observed in the dashboard. |
| `dashboards` *object (keys:string, values:[DashboardInfo](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#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 Grafana instance provisioned.

*Appears in:*
- [ObservabilityMonitoring](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#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](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#volume-v1-core) array* |   |
| `volumeMounts` *[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#volumemount-v1-core) array* |   |

### ObservabilityAuditLogging

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

*Appears in:*
- [ObservabilityPipelineSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#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](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#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](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#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](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#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](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#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](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#grafana)* | The configuration information for the Grafana 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](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#observabilitypipelinelist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `observability.gdc.goog/v1` |
| `kind` *string* | `ObservabilityPipeline` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[ObservabilityPipelineSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#observabilitypipelinespec)* |   |
| `status` *[ObservabilityPipelineStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#observabilitypipelinestatus)* |   |

### ObservabilityPipelineList

Contains a list of `ObservabilityPipeline` objects.

| Field | Description |
|---|---|
| `apiVersion` *string* | `observability.gdc.goog/v1` |
| `kind` *string* | `ObservabilityPipelineList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[ObservabilityPipeline](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#observabilitypipeline) array* |   |

### ObservabilityPipelineSpec

Defines the specification or expected state of the `ObservabilityPipeline` object.

*Appears in:*
- [ObservabilityPipeline](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#observabilitypipeline)

| Field | Description |
|---|---|
| `enabled` *boolean* | Specifies if the Observability pipeline stack is enabled. |
| `monitoring` *[ObservabilityMonitoring](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#observabilitymonitoring)* | The monitoring pipeline configuration. |
| `alerting` *[ObservabilityAlerting](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#observabilityalerting)* | The Alertmanager pipeline configuration. |
| `logging` *[ObservabilityLogging](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#observabilitylogging)* | The logging pipeline configuration. |
| `auditLogging` *[ObservabilityAuditLogging](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#observabilityauditlogging)* | The audit logging pipeline configuration. |
| `securityLogging` *[ObservabilitySecurityLogging](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#observabilitysecuritylogging)* | The security pipeline configuration. |

### ObservabilityPipelineStatus

Defines the observed state of the `ObservabilityPipeline` object.

*Appears in:*
- [ObservabilityPipeline](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#observabilitypipeline)

| Field | Description |
|---|---|
| `version` *string* | The installed version of the Observability pipeline stack. |
| `conditions` *[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) 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](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#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](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/observability/v1/observability-v1.md.txt#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`. |