|
| 1 | +:_mod-docs-content-type: ASSEMBLY |
| 2 | +[id="cluster-logging-support"] |
| 3 | +include::_attributes/common-attributes.adoc[] |
| 4 | += Support |
| 5 | +:context: cluster-logging-support |
| 6 | + |
| 7 | +toc::[] |
| 8 | + |
| 9 | +include::snippets/logging-supported-config-snip.adoc[] |
| 10 | +include::snippets/logging-compatibility-snip.adoc[] |
| 11 | +include::snippets/log6x-loki-statement-snip.adoc[] |
| 12 | + |
| 13 | +{logging-uc} {for} is an opinionated collector and normalizer of application, infrastructure, and audit logs. You can use it to forward logs to various supported systems. |
| 14 | + |
| 15 | +{logging-uc} is not: |
| 16 | + |
| 17 | +* A high scale log collection system |
| 18 | +* Security Information and Event Monitoring (SIEM) compliant |
| 19 | +* A "bring your own" (BYO) log collector configuration |
| 20 | +* Historical or long term log retention or storage |
| 21 | +* A guaranteed log sink |
| 22 | +* Secure storage - audit logs are not stored by default |
| 23 | +
|
| 24 | +[id="cluster-logging-support-CRDs_{context}"] |
| 25 | +== Supported API custom resource definitions |
| 26 | + |
| 27 | +The following table describes the supported {logging-uc} APIs. |
| 28 | + |
| 29 | +.Loki API support states |
| 30 | +[cols="3",options="header"] |
| 31 | +|=== |
| 32 | +|CustomResourceDefinition (CRD) |
| 33 | +|ApiVersion |
| 34 | +|Support state |
| 35 | + |
| 36 | +|LokiStack |
| 37 | +|lokistack.loki.grafana.com/v1 |
| 38 | +|Supported from 5.5 |
| 39 | + |
| 40 | +|RulerConfig |
| 41 | +|rulerconfig.loki.grafana/v1 |
| 42 | +|Supported from 5.7 |
| 43 | + |
| 44 | +|AlertingRule |
| 45 | +|alertingrule.loki.grafana/v1 |
| 46 | +|Supported from 5.7 |
| 47 | + |
| 48 | +|RecordingRule |
| 49 | +|recordingrule.loki.grafana/v1 |
| 50 | +|Supported from 5.7 |
| 51 | + |
| 52 | +|LogFileMetricExporter |
| 53 | +|LogFileMetricExporter.logging.openshift.io/v1alpha1 |
| 54 | +|Supported from 5.8 |
| 55 | + |
| 56 | +|ClusterLogForwarder |
| 57 | +|clusterlogforwarder.logging.openshift.io/v1 |
| 58 | +|Supported from 4.5. |
| 59 | +|=== |
| 60 | + |
| 61 | +include::modules/cluster-logging-maintenance-support-list.adoc[leveloffset=+1] |
| 62 | +include::modules/unmanaged-operators.adoc[leveloffset=+1] |
| 63 | + |
| 64 | +[id="support-exception-for-coo-logging-ui-plugin_{context}"] |
| 65 | +== Support exception for the Logging UI Plugin |
| 66 | + |
| 67 | +Until the General Availability (GA) of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its Logging UI Plugin on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA. |
| 68 | + |
| 69 | +[id="cluster-logging-support-must-gather_{context}"] |
| 70 | +== Collecting logging data for Red Hat Support |
| 71 | + |
| 72 | +When opening a support case, it is helpful to provide debugging information about your cluster to Red{nbsp}Hat Support. |
| 73 | + |
| 74 | +You can use the xref:../../support/gathering-cluster-data.adoc#gathering-cluster-data[must-gather tool] to collect diagnostic information for project-level resources, cluster-level resources, and each of the {logging} components. |
| 75 | +For prompt support, supply diagnostic information for both {product-title} and {logging}. |
| 76 | + |
| 77 | +include::modules/cluster-logging-must-gather-about.adoc[leveloffset=+2] |
| 78 | +include::modules/cluster-logging-must-gather-collecting.adoc[leveloffset=+2] |
0 commit comments