Skip to content

Commit

Permalink
only create module if deps loaded
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Ruoss committed Feb 21, 2022
1 parent 7930bd7 commit e1f81ab
Show file tree
Hide file tree
Showing 4 changed files with 170 additions and 161 deletions.
5 changes: 3 additions & 2 deletions guides/observability.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ them.

There are two connectors to `:telemetry` spans/events.

### OpenTelemetry
### OpenTelemetry

If you're [OpenTelemetry](https://opentelemetry.io/docs/instrumentation/erlang/), attach
`:telemetry` spans/events to the OpenTelemetry handler:
Expand All @@ -29,8 +29,9 @@ If you're [OpenTelemetry](https://opentelemetry.io/docs/instrumentation/erlang/)
K8s.Sys.OpenTelemetry.attach()
```

### Spandex
### Spandex

:warning: Requires Elixir ~> 1.10

If you're using a [Spandex](https://github.com/spandex-project/spandex) tracer, Attach
`:telemetry` spans/events to the Spandex handler. Pass the tracer you created according
Expand Down
160 changes: 81 additions & 79 deletions lib/k8s/sys/open_telemetry.ex
View file
Original file line number Diff line number Diff line change
@@ -1,93 +1,95 @@
defmodule K8s.Sys.OpenTelemetry do
@moduledoc """
This module is still in beta! It has not been tested well and feedback is welcome!
if Code.ensure_loaded?(OpenTelemetry) and Code.ensure_loaded?(OpentelemetryTelemetry) do
defmodule K8s.Sys.OpenTelemetry do
@moduledoc """
This module is still in beta! It has not been tested well and feedback is welcome!
Converts telemetry spans to opentelemetry tracing spans
Converts telemetry spans to opentelemetry tracing spans
### Usage
### Usage
K8s.Sys.OpenTelemetry.attach()
"""
K8s.Sys.OpenTelemetry.attach()
"""

@doc """
Attaches telemetry spans to the opentelemetry processor
"""
@spec attach() :: :ok
def attach do
for span <- K8s.Sys.Telemetry.spans() do
span_name = Enum.join(span, ".")
@doc """
Attaches telemetry spans to the opentelemetry processor
"""
@spec attach() :: :ok
def attach do
for span <- K8s.Sys.Telemetry.spans() do
span_name = Enum.join(span, ".")

:ok =
:telemetry.attach(
"k8s-otel-tracer-#{span_name}-start",
span ++ [:start],
&__MODULE__.handle_event/4,
%{tracer_id: :k8s, type: :start, span_name: "k8s." <> span_name}
)
:ok =
:telemetry.attach(
"k8s-otel-tracer-#{span_name}-start",
span ++ [:start],
&__MODULE__.handle_event/4,
%{tracer_id: :k8s, type: :start, span_name: "k8s." <> span_name}
)

:ok =
:telemetry.attach(
"k8s-otel-tracer-#{span_name}-stop",
span ++ [:stop],
&__MODULE__.handle_event/4,
%{tracer_id: :k8s, type: :stop}
)
:ok =
:telemetry.attach(
"k8s-otel-tracer-#{span_name}-stop",
span ++ [:stop],
&__MODULE__.handle_event/4,
%{tracer_id: :k8s, type: :stop}
)

:ok =
:telemetry.attach(
"k8s-otel-tracer-#{span_name}-exception",
span ++ [:exception],
&__MODULE__.handle_event/4,
%{tracer_id: :k8s, type: :exception}
)
:ok =
:telemetry.attach(
"k8s-otel-tracer-#{span_name}-exception",
span ++ [:exception],
&__MODULE__.handle_event/4,
%{tracer_id: :k8s, type: :exception}
)
end

:ok
end

:ok
end
@doc false
@spec handle_event(
:telemetry.event_name(),
:telemetry.event_measurements(),
:telemetry.event_metadata(),
:telemetry.handler_config()
) :: any()
def handle_event(
_event,
%{system_time: start_time},
metadata,
%{type: :start, tracer_id: tracer_id, span_name: name}
) do
start_opts = %{start_time: start_time}
OpentelemetryTelemetry.start_telemetry_span(tracer_id, name, metadata, start_opts)
:ok
end

@doc false
@spec handle_event(
:telemetry.event_name(),
:telemetry.event_measurements(),
:telemetry.event_metadata(),
:telemetry.handler_config()
) :: any()
def handle_event(
_event,
%{system_time: start_time},
metadata,
%{type: :start, tracer_id: tracer_id, span_name: name}
) do
start_opts = %{start_time: start_time}
OpentelemetryTelemetry.start_telemetry_span(tracer_id, name, metadata, start_opts)
:ok
end
def handle_event(
_event,
%{duration: duration},
metadata,
%{type: :stop, tracer_id: tracer_id}
) do
OpentelemetryTelemetry.set_current_telemetry_span(tracer_id, metadata)
OpenTelemetry.Tracer.set_attribute(:duration, duration)
OpentelemetryTelemetry.end_telemetry_span(tracer_id, metadata)
:ok
end

def handle_event(
_event,
%{duration: duration},
metadata,
%{type: :stop, tracer_id: tracer_id}
) do
OpentelemetryTelemetry.set_current_telemetry_span(tracer_id, metadata)
OpenTelemetry.Tracer.set_attribute(:duration, duration)
OpentelemetryTelemetry.end_telemetry_span(tracer_id, metadata)
:ok
end
def handle_event(
_event,
%{duration: duration},
%{kind: kind, reason: reason, stacktrace: stacktrace} = metadata,
%{type: :exception, tracer_id: tracer_id}
) do
ctx = OpentelemetryTelemetry.set_current_telemetry_span(tracer_id, metadata)
status = OpenTelemetry.status(:error, inspect(reason))
OpenTelemetry.Span.record_exception(ctx, kind, stacktrace, duration: duration)
OpenTelemetry.Tracer.set_status(status)
OpentelemetryTelemetry.end_telemetry_span(tracer_id, metadata)
:ok
end

def handle_event(
_event,
%{duration: duration},
%{kind: kind, reason: reason, stacktrace: stacktrace} = metadata,
%{type: :exception, tracer_id: tracer_id}
) do
ctx = OpentelemetryTelemetry.set_current_telemetry_span(tracer_id, metadata)
status = OpenTelemetry.status(:error, inspect(reason))
OpenTelemetry.Span.record_exception(ctx, kind, stacktrace, duration: duration)
OpenTelemetry.Tracer.set_status(status)
OpentelemetryTelemetry.end_telemetry_span(tracer_id, metadata)
:ok
def handle_event(_event, _measurements, _metadata, _config), do: :ok
end

def handle_event(_event, _measurements, _metadata, _config), do: :ok
end
158 changes: 80 additions & 78 deletions lib/k8s/sys/spandex.ex
View file
Original file line number Diff line number Diff line change
@@ -1,94 +1,96 @@
defmodule K8s.Sys.Spandex do
@moduledoc """
This module is still in beta! It has not been tested well and feedback is welcome!
if Code.ensure_loaded?(Spandex) do
defmodule K8s.Sys.Spandex do
@moduledoc """
This module is still in beta! It has not been tested well and feedback is welcome!
Converts telemetry spans to Spandex tracing spans.
Converts telemetry spans to Spandex tracing spans.
### Usage
### Usage
K8s.Sys.Spandex.attach(MyApp.Tracer)
"""
K8s.Sys.Spandex.attach(MyApp.Tracer)
"""

require Spandex
require Spandex

@doc """
Attaches telemetry spans to the spandex processor
"""
@spec attach(atom()) :: :ok
def attach(tracer) do
for span <- K8s.Sys.Telemetry.spans() do
span_name = Enum.join(span, ".")
@doc """
Attaches telemetry spans to the spandex processor
"""
@spec attach(atom()) :: :ok
def attach(tracer) do
for span <- K8s.Sys.Telemetry.spans() do
span_name = Enum.join(span, ".")

:ok =
:telemetry.attach(
"k8s-spandex-tracer-#{span_name}-start",
span ++ [:start],
&__MODULE__.handle_event/4,
%{tracer: tracer, type: :start, span_name: "k8s." <> span_name}
)
:ok =
:telemetry.attach(
"k8s-spandex-tracer-#{span_name}-start",
span ++ [:start],
&__MODULE__.handle_event/4,
%{tracer: tracer, type: :start, span_name: "k8s." <> span_name}
)

:ok =
:telemetry.attach(
"k8s-spandex-tracer-#{span_name}-stop",
span ++ [:stop],
&__MODULE__.handle_event/4,
%{tracer: tracer, type: :stop}
)
:ok =
:telemetry.attach(
"k8s-spandex-tracer-#{span_name}-stop",
span ++ [:stop],
&__MODULE__.handle_event/4,
%{tracer: tracer, type: :stop}
)

:ok =
:telemetry.attach(
"k8s-spandex-tracer-#{span_name}-exception",
span ++ [:exception],
&__MODULE__.handle_event/4,
%{tracer: tracer, type: :exception}
)
:ok =
:telemetry.attach(
"k8s-spandex-tracer-#{span_name}-exception",
span ++ [:exception],
&__MODULE__.handle_event/4,
%{tracer: tracer, type: :exception}
)
end

:ok
end

:ok
end
@doc false
@spec handle_event(
:telemetry.event_name(),
:telemetry.event_measurements(),
:telemetry.event_metadata(),
:telemetry.handler_config()
) :: any()
def handle_event(
_event,
%{system_time: _start_time},
metadata,
%{type: :start, tracer: tracer, span_name: name}
) do
tracer.start_span(name, service: :k8s, type: :custom, tags: Map.to_list(metadata))
:ok
end

@doc false
@spec handle_event(
:telemetry.event_name(),
:telemetry.event_measurements(),
:telemetry.event_metadata(),
:telemetry.handler_config()
) :: any()
def handle_event(
_event,
%{system_time: _start_time},
metadata,
%{type: :start, tracer: tracer, span_name: name}
) do
tracer.start_span(name, service: :k8s, type: :custom, tags: Map.to_list(metadata))
:ok
end
def handle_event(
_event,
%{duration: _duration},
metadata,
%{type: :stop, tracer: tracer}
) do
tracer.update_span(tags: Map.to_list(metadata))
tracer.finish_span()
:ok
end

def handle_event(
_event,
%{duration: _duration},
metadata,
%{type: :stop, tracer: tracer}
) do
tracer.update_span(tags: Map.to_list(metadata))
tracer.finish_span()
:ok
end
def handle_event(
_event,
%{duration: _duration},
%{kind: kind, reason: reason, stacktrace: stacktrace} = metadata,
%{type: :exception, tracer: tracer}
) do
metadata =
metadata
|> Map.put(:error, reason)
|> Map.delete(:reason)

def handle_event(
_event,
%{duration: _duration},
%{kind: kind, reason: reason, stacktrace: stacktrace} = metadata,
%{type: :exception, tracer: tracer}
) do
metadata =
metadata
|> Map.put(:error, reason)
|> Map.delete(:reason)
tracer.span_error(kind, stacktrace, error: reason, tags: metadata)
:ok
end

tracer.span_error(kind, stacktrace, error: reason, tags: metadata)
:ok
def handle_event(_event, _measurements, _metadata, _config), do: :ok
end

def handle_event(_event, _measurements, _metadata, _config), do: :ok
end
8 changes: 6 additions & 2 deletions mix.exs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,13 @@ defmodule K8s.MixProject do

# Run "mix help deps" to learn about dependencies.
defp deps do
[
deps = [
{:yaml_elixir, "~> 2.8"},
{:httpoison, "~> 1.7"},
{:jason, "~> 1.0"},
{:telemetry, "~> 1.0"},
{:opentelemetry_telemetry, "~> 1.0.0-beta.4", optional: true},
{:opentelemetry, "~> 1.0", optional: true},
{:spandex, "~> 3.0.3", optional: true},

# dev/test deps (e.g. code coverage)
{:inch_ex, github: "rrrene/inch_ex", only: [:dev, :test]},
Expand All @@ -48,6 +47,11 @@ defmodule K8s.MixProject do
{:excoveralls, "~> 0.14", only: [:test]},
{:mix_test_watch, "~> 1.1", only: :dev, runtime: false}
]

# spandex requires 1.10
if Version.match?(System.version(), "~> 1.10"),
do: [{:spandex, "~> 3.0.3", optional: true} | deps],
else: deps
end

defp package do
Expand Down

0 comments on commit e1f81ab

Please sign in to comment.