-
Spike
-
Resolution: Done
-
Undefined
-
None
-
None
-
None
-
None
-
False
-
None
-
False
-
NEW
-
OBSDA-498 - Enable OpenTelemetry in Cluster Logging Operator
-
NEW
-
If Release Note Needed, Set a Value
-
-
Task
- Review Viaq and OTEL models
- Produce a list of equivalent fields (JSON paths) between Viaq and OTEL with english documentation strings to describe them.
List should be in a form that is easily parsed for automation later e.g. JSON/YAML.
There's no specific format required.
References
OTEL
- Logs data model: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md
- Logs Resource mappings: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model-appendix.md#appendix-a-example-mappings
- General Semantic Conventions (Resources): https://github.com/open-telemetry/semantic-conventions/README.md
- Kubernetes logs | Vector documentation: https://vector.dev/docs/reference/configuration/sources/kubernetes_logs/
Viaq
- Viaq reference doc (generated)
- Definitions in code:
The logging opreator has 3 different styles for wrapping logs:
- `{ message: "original log message", ... other viaq fields }` # For non-JSON logs, and some JSON logs if parsing is not enabled.
- `{ structured: { original: { json: object } }, ... other viaq fields }` # For logs that are originally JSON, with parsing enabled.
- `{ original and viaq fields mixed together }` # For k8s Audit and k8s Event logs, special cases.
Completion criteria
- Documented equivalent paths: ViaQ/OTEL/English description
- Notes on any difficulties or special treatment that might be needed translating between the two.