-
Story
-
Resolution: Unresolved
-
Normal
-
None
-
OSSM 3.0.0, OSSM 3.1.0, OSSM 3.2.0
-
None
-
False
-
-
False
-
Documentation (Ref Guide, User Guide, etc.)
-
-
In addition to metrics and tracing, OSSM also provides valuable access logs that can be useful for debugging traffic failures and flows as well as analyzing log streams. They also have a security use case, as some customers like to record all requests/responses in logging. We should add a new section to our observability documentation for this.
We actually had some documentation in OSSM 2.x for this, though it was in the Envoy Troubleshooting section (this is only applicable for 2.x): https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/service_mesh/service-mesh-2-x#enabling-envoy-access-logs
We should include documentation that covers multiple approaches:
- meshConfig: Documented here for OSSM 3: https://access.redhat.com/solutions/5127991
- Telemetry API: https://istio.io/latest/docs/tasks/observability/logs/access-log/
- Related OTEL integration doc with envoyAL provider (possibly WIP): https://docs.google.com/document/d/1VFcewb2hepGjp9-DFtX8HKZShEhHuqLW_-7onavtsb8/edit?usp=sharing
- Note: We don't need to replicate the upstream documentation downstream, but should link to the upstream documentation as a resource.
As we do with metrics/traces, we should demonstrate an end to end configuration with OpenShift Logging and Kiali (which includes a log correlation feature).
This will need an engineering draft and validation, but should not require any product changes.