Update errors to use OTEL conventions

[ccschmitz]

No description provided.

[linear]

HIG-4617 Update errors to use OTEL conventions

[greptile-apps]

To update errors to use OTEL conventions, you'll need to modify how errors are structured, logged, and reported across both the backend services and the Highlight Node SDK. Specifically, focus on the following areas:

1. Backend Services (/backend/alerts/integrations/microsoft-teams, /backend/private-graph/graph, /backend/public-graph/graph):

   • Review and update the error handling and logging in these services to align with OTEL's semantic conventions for errors. This includes structuring error messages and attributes according to OTEL standards.

2. Highlight Node SDK (/sdk/highlight-node/src):

   • In handlers.ts, ensure that error logging follows OTEL conventions. This might involve modifying how errors are captured and what information is logged.
   • Update client.ts and any other relevant files to ensure that error reporting is consistent with OTEL's error attributes.

For both backend services and the SDK, ensure that errors include at least the following information according to OTEL conventions:

• exception.type: The type of the exception (e.g., Error, TypeError).
• exception.message: A concise, human-readable, one-line message explaining the event.
• exception.stacktrace: The stack trace of the exception.

This update will help standardize error reporting across your application and improve observability by adhering to widely recognized conventions.

References

highlight/highlight/backend/alerts/integrations/microsoft-teams
highlight/highlight/backend/private-graph/graph
highlight/highlight/backend/public-graph/graph
highlight/highlight/backend/model
highlight/highlight/sdk/highlight-node/src

Ask Greptile