Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce version variables for erlang docs #2989

Merged
merged 5 commits into from
Jul 22, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions content/en/docs/instrumentation/erlang/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
title: Exporters
weight: 50
spelling: cSpell:ignore ostream jaegertracing millis chrono rebar relx
versions:
otelSdk: 1.3
otelApi: 1.2
otelExporter: 1.6
otelPhoenix: 1.1
otelCowboy: 0.2
---

In order to visualize and analyze your [traces](/docs/concepts/signals/traces/)
Expand Down Expand Up @@ -32,17 +38,17 @@ added to the project's dependencies:
{{< tabpane langEqualsHeader=true >}}

{{< tab Erlang >}}
{deps, [{opentelemetry_api, "~> 1.3"},
{opentelemetry, "~> 1.3"},
{opentelemetry_exporter, "~> 1.4"}]}.
{deps, [{opentelemetry_api, "~> {{% param versions.otelApi %}}"},
{opentelemetry, "~> {{% param versions.otelSdk %}}"},
{opentelemetry_exporter, "~> {{% param versions.otelExporter %}}"}]}.
{{< /tab >}}

{{< tab Elixir >}}
def deps do
[
{:opentelemetry_api, "~> 1.3"},
{:opentelemetry, "~> 1.3"},
{:opentelemetry_exporter, "~> 1.4"}
{:opentelemetry_api, "~> {{% param versions.otelApi %}}"},
{:opentelemetry, "~> {{% param versions.otelSdk %}}"},
{:opentelemetry_exporter, "~> {{% param versions.otelExporter %}}"}
]
end
{{< /tab >}}
Expand Down
24 changes: 15 additions & 9 deletions content/en/docs/instrumentation/erlang/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ title: Getting Started
weight: 10
spelling: cSpell:ignore rebar relx stdlib bogons defp rolldice
spelling: cSpell:ignore defmodule erts hipe Eshell postgres ecto elixirc KHTML
versions:
otelSdk: 1.3
otelApi: 1.2
otelExporter: 1.6
otelPhoenix: 1.1
otelCowboy: 0.2
---

Welcome to the OpenTelemetry for Erlang/Elixir getting started guide! This guide
Expand Down Expand Up @@ -52,11 +58,11 @@ We'll need a few other dependencies that Phoenix doesn't come with.
# mix.exs
def deps do
[
{:opentelemetry, "~> 1.3"},
{:opentelemetry_api, "~> 1.2"},
{:opentelemetry_exporter, "~> 1.4"},
{:opentelemetry_phoenix, "~> 1.1"},
{:opentelemetry_cowboy, "~> 0.2"}
{:opentelemetry, "~> {{% param versions.otelSdk %}}"},
{:opentelemetry_api, "~> {{% param versions.otelApi %}}"},
{:opentelemetry_exporter, "~> {{% param versions.otelExporter %}}"},
{:opentelemetry_phoenix, "~> {{% param versions.otelPhoenix %}}"},
{:opentelemetry_cowboy, "~> {{% param versions.otelCowboy %}}"},
]
end
```
Expand Down Expand Up @@ -321,15 +327,15 @@ run as a Release and export spans from.
{{< tabpane langEqualsHeader=true >}}

{{< tab Erlang >}}
{deps, [{opentelemetry_api, "~> 1.2"},
{opentelemetry, "~> 1.3"}]}.
{deps, [{opentelemetry_api, "~> {{% param versions.otelApi %}}"},
{opentelemetry, "~> {{% param versions.otelSdk %}}"}]}.
{{< /tab >}}

{{< tab Elixir >}}
def deps do
[
{:opentelemetry_api, "~> 1.2"},
{:opentelemetry, "~> 1.3"}
{:opentelemetry_api, "~> {{% param versions.otelApi %}}"},
{:opentelemetry, "~> {{% param versions.otelSdk %}}"}
]
end
{{< /tab >}}
Expand Down
11 changes: 7 additions & 4 deletions content/en/docs/instrumentation/erlang/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
title: Testing
weight: 100
spelling: cSpell:ignore defmodule stdlib defrecordp testcase
versions:
otelSdk: 1.3
otelApi: 1.2
---

When relying on OpenTelemetry for your Observability needs, it can be important
Expand All @@ -19,15 +22,15 @@ testing in Elixir/Erlang:
{{< tabpane langEqualsHeader=true >}}

{{< tab Erlang >}}
{deps, [{opentelemetry_api, "~> 1.0"},
{opentelemetry, "~> 1.0"}]}.
{deps, [{opentelemetry_api, "~> {{% param versions.otelApi %}}"},
{opentelemetry, "~> {{% param versions.otelSdk %}}"}]}.
{{< /tab >}}

{{< tab Elixir >}}
def deps do
[
{:opentelemetry_api, "~> 1.0"},
{:opentelemetry, "~> 1.0"}
{:opentelemetry_api, "~> {{% param versions.otelApi %}}"},
{:opentelemetry, "~> {{% param versions.otelSdk %}}"}
]
end
{{< /tab >}}
Expand Down