Skip to content

Support Elixir among our SDKs #5082

@jay-khatri

Description

@jay-khatri

A ticket to track support for a set of Elixir SDKs. These should support:

  • Error Monitoring
  • Logging

This is a good starting point on how to make an SDK for Highlight.io: https://www.highlight.io/docs/general/company/open-source/contributing/adding-an-sdk

And like all of our other SDKs, we should wrap the OTEL equivalent:
https://opentelemetry.io/docs/instrumentation/erlang/

For anyone interested in contributing, please post here. We're happy to help. cc @Vadman97 @et

The SDK should implement the following:

  • a way to H.recordException following the otel exception reporting spec.
  • a way to instrument Elixir logging libraries. if the Elixir sdk supports logs natively, it would be great to route them to as LogRecords on v1/logs, but if not, fine to support them as trace events.
  • Integrate cleanly with Phoenix, allowing to hook into built in error monitoring and logging.

as part of the exception implementation, if Elixir backend frameworks follow a common format for tracing HTTP request handlers, it would be great to wrap those as native otel traces.

Requirements:

  • a init method that sets up the Elixir instrumentation to collect console logs automatically.
  • a recordException method that allows capturing errors manually (see java sdk as an example).
  • support Phoenix Live View instrumentation

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions