Update console recording to use OTEL conventions

[ccschmitz]

No description provided.

[linear]

HIG-4616 Update console recording to use OTEL conventions

[greptile-apps]

To update the console recording to use OTEL conventions, follow these steps tailored to the highlight/highlight codebase:

1. Adapt ConsoleListener in console-listener.tsx:

   • Modify the ConsoleMessage type to align with OTEL's log data model, including attributes like traceId, spanId, and severityText.
   • Update the callback function within ConsoleListener to map console log levels to OTEL's severityText and include traceId and spanId if available.

2. Update Node.js SDK in hooks.ts:

   • In hookConsole, ensure that the ConsolePayload includes OTEL-compliant fields such as severityText, traceId, and spanId.
   • Adjust the safeStringify function or its usage to ensure complex objects are serialized in a manner consistent with OTEL's structured logging approach.

3. Ensure Consistency Across Environments:

   • Verify that both client-side and server-side implementations serialize log attributes and context information following OTEL conventions.
   • Consider adding or updating tests to cover the new OTEL-compliant logging behavior.

4. Documentation and Examples:

   • Update the documentation in /docs-content/getting-started/7_native-opentelemetry/3_logging.md to reflect the changes in logging conventions.
   • Provide examples of the new logging output in both the documentation and in /blog-content/building-our-logging-integrations.md to illustrate the integration with OTEL.

These steps are specific to the highlight/highlight codebase and are designed to align the console recording feature with OTEL logging conventions, enhancing interoperability and consistency in telemetry data.

References

highlight/highlight/sdk/client/src/listeners/console-listener.tsx
highlight/highlight/sdk/highlight-node/src/hooks.ts
highlight/highlight/docs-content/getting-started/7_native-opentelemetry/3_logging.md
highlight/highlight/sdk/highlight-node/src/types.ts
highlight/highlight/highlight.io/components/QuickstartContent/backend/otlp.tsx
highlight/highlight/blog-content/building-our-logging-integrations.md

Ask Greptile