Merge branch 'main' into ms/add-spec-links

Author: tsloughter

.github/workflows/fossa.yml

@@ -21,7 +21,7 @@ jobs:
           elixir-version: "1.18.1"
           version-type: "strict"
 
-      - uses: fossas/fossa-action@93a52ecf7c3ac7eb40f5de77fd69b1a19524de94 # v1.5.0
+      - uses: fossas/fossa-action@c0a7d013f84c8ee5e910593186598625513cc1e4 # v1.6.0
         with:
           api-key: ${{secrets.FOSSA_API_KEY}}
           team: OpenTelemetry

.github/workflows/ossf-scorecard.yml

@@ -0,0 +1,47 @@
+name: OSSF Scorecard
+
+on:
+  push:
+    branches:
+      - main
+  schedule:
+    - cron: "33 11 * * 1" # once a week
+  workflow_dispatch:
+
+permissions: read-all
+
+jobs:
+  analysis:
+    runs-on: ubuntu-latest
+    permissions:
+      # Needed for Code scanning upload
+      security-events: write
+      # Needed for GitHub OIDC token if publish_results is true
+      id-token: write
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+
+      - uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          publish_results: true
+
+      # Upload the results as artifacts (optional). Commenting out will disable
+      # uploads of run results in SARIF format to the repository Actions tab.
+      # https://docs.github.com/en/actions/advanced-guides/storing-workflow-data-as-artifacts
+      - name: "Upload artifact"
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard (optional).
+      # Commenting out will disable upload of results to your repo's Code Scanning dashboard
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@45775bd8235c68ba998cffa5171334d58593da47 # v3.28.15
+        with:
+          sarif_file: results.sarif

CONTRIBUTING.md

@@ -0,0 +1,114 @@
+# Development Setup Guide for Erlang Repository
+
+## Introduction
+Welcome to the Erlang Repository! 🎉
+
+This guide aims to assist contributors in setting up their local development environment. Feel free to suggest improvements or raise questions in your contributions.
+
+## Pre-requisites
+
+To work with this repository, you'll need the following tools and dependencies:
+
+- **Erlang/OTP Version** :
+  
+- We support the latest major release plus the prior two releases, aligning with Ericsson’s version support policy for Erlang itself.  
+- For a definitive list of supported versions, refer to the [erlang.yml](.github/workflows/erlang.yml) file in this repository.  
+
+If using the Elixir API:  
+
+* Elixir 1.14+
+
+* For a definitive list of supported versions, refer to the [elixir.yml](.github/workflows/elixir.yml) file in this repository.
+
+* Refer to the official [Erlang Installation Guide](https://www.erlang.org/downloads) for setting up Erlang.
+
+## Local Run/Build
+
+### Setting Up and Running the Project Locally
+
+To run the project locally, follow these steps:
+
+Start required services:
+
+```
+docker compose up -d
+```
+
+Set up Erlang/OTP and Rebar3 and Verify setup (Ensure you have the correct versions as specified in the prerequisites):
+
+Run the compilation step to check for errors:
+```
+rebar3 compile
+```
+
+## Testing
+
+To execute tests, use the following commands:
+
+### Unit Tests (EUnit):
+
+```
+rebar3 eunit
+```
+
+### Integration and Functional Tests (Common Test):
+
+```
+rebar3 ct
+```
+
+### Test results and logs can be viewed in a browser by opening:
+
+```
+build/test/logs/index.html
+
+```
+### Elixir Tests
+
+Elixir tests are run in two places:
+
+1. Inside apps/opentelemetry_api/:
+
+```
+mix test
+```
+
+2. At the top level:
+
+```
+mix test --no-start test/otel_tests.exs test/otel_metric_tests.exs
+```
+
+## Contribution Rules
+Please review the [OpenTelemetry Specification](https://opentelemetry.io/docs/specs/otel/) for details on coding standards, commit message formatting, and the contribution process.
+
+## Troubleshooting Guide
+
+### Debugging Common Failures
+
+* Test Failures: Check the test logs in _build/test/logs/.
+
+* Compilation Issues: Ensure correct OTP and Rebar3 versions are installed.
+
+* Dialyzer Warnings: Ensure rebar3 compile completes successfully.
+
+## Developer Setup and Language Servers
+
+For improved development experience, consider using the following Language Server Protocols (LSPs):
+
+* Erlang LSP: [Erlang Language Platform](https://whatsapp.github.io/erlang-language-platform/)
+
+* Installing it removes the need for an additional type-checking step:
+
+```
+elp eqwalize-all
+```
+
+* Install from: [Erlang Language Platform Releases](https://github.com/WhatsApp/erlang-language-platform/releases/)
+
+* Elixir LSP: [Elixir LS](https://github.com/elixir-lsp/elixir-ls)
+
+## Further Help
+
+* If you encounter any issues or have questions, feel free to open an issue or reach out to the maintainers.
+* Join our [slack](https://cloud-native.slack.com/archives/C01N75YMZCN) channel also for further help and discussions

apps/opentelemetry/src/otel_span_ets.erl

@@ -37,8 +37,6 @@
          update_name/2]).
 
 %% since `span_ctx' and `span' are in the API the `span_sdk' has to be term()
--eqwalizer({nowarn_function, end_span/1}).
--eqwalizer({nowarn_function, end_span/2}).
 -eqwalizer({nowarn_function, get_ctx/1}).
 
 -include_lib("opentelemetry_api/include/opentelemetry.hrl").

apps/opentelemetry_api/docs.config

@@ -42,9 +42,9 @@
 
 %% Holds information about the instrumentation scope specified when
 %% getting a Tracer from the TracerProvider.
--record(instrumentation_scope, {name       :: unicode:unicode_binary() | undefined | '_',
-                                version    :: unicode:unicode_binary() | undefined | '_',
-                                schema_url :: uri_string:uri_string() | undefined | '_'}).
+-record(instrumentation_scope, {name       :: unicode:unicode_binary() | undefined,
+                                version    :: unicode:unicode_binary() | undefined,
+                                schema_url :: uri_string:uri_string() | undefined}).
 
 -record(span_ctx, {
           %% 128 bit int trace id

apps/opentelemetry_api/include/opentelemetry.hrl

@@ -18,17 +18,48 @@ defmodule OpenTelemetry.MixProject do
          only: [:dev],
          runtime: false},
         {:dialyxir, "~> 1.0", only: [:dev], runtime: false},
-        {:covertool, ">= 0.0.0", only: :test}
+        {:covertool, ">= 0.0.0", only: :test},
+        {:ex_doc, "~> 0.37", only: :dev, runtime: false}
       ],
       name: "OpenTelemetry API",
       test_coverage: [tool: :covertool],
       package: package(),
-      aliases: [docs: & &1],
       dialyzer: [
         ignore_warnings: "dialyzer.ignore-warnings",
         remove_defaults: [:unknown],
         plt_add_apps: [:eqwalizer_support],
         list_unused_filters: true
+      ],
+      source_url: "https://github.com/open-telemetry/opentelemetry-erlang",
+      homepage_url: "https://github.com/open-telemetry/opentelemetry-erlang",
+      docs: [
+        main: "readme",
+        source_url_pattern:
+          "https://github.com/open-telemetry/opentelemetry-erlang/blob/main/apps/opentelemetry_api/%{path}#L%{line}",
+        extras: ["README.md", "LICENSE"],
+        groups_for_modules: [
+          Context: [:otel_ctx, OpenTelemetry.Ctx],
+          Baggage: [:otel_baggage, OpenTelemetry.Baggage],
+          Tracer: [
+            :otel_tracer,
+            :otel_tracer_noop,
+            :otel_tracer_provider,
+            :otel_tracestate,
+            OpenTelemetry.Tracer,
+            OpenTelemetry.Span
+          ],
+          Propagators: [
+            :otel_propagator,
+            :otel_propagator_baggage,
+            :otel_propagator_b3,
+            :otel_propagator_b3multi,
+            :otel_propagator_b3single,
+            :otel_propagator_text_map,
+            :otel_propagator_text_map_composite,
+            :otel_propagator_text_map_noop,
+            :otel_propagator_trace_context
+          ]
+        ]
       ]
     ]
   end

apps/opentelemetry_api/mix.exs

@@ -1,6 +1,12 @@
 %{
   "covertool": {:hex, :covertool, "2.0.6", "4a291b4e3449025b0595d8f44c8d7635d4f48f033be2ce88d22a329f36f94a91", [:rebar3], [], "hexpm", "5db3fcd82180d8ea4ad857d4d1ab21a8d31b5aee0d60d2f6c0f9e25a411d1e21"},
   "dialyxir": {:hex, :dialyxir, "1.4.2", "764a6e8e7a354f0ba95d58418178d486065ead1f69ad89782817c296d0d746a5", [:mix], [{:erlex, ">= 0.2.6", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "516603d8067b2fd585319e4b13d3674ad4f314a5902ba8130cd97dc902ce6bbd"},
+  "earmark_parser": {:hex, :earmark_parser, "1.4.43", "34b2f401fe473080e39ff2b90feb8ddfeef7639f8ee0bbf71bb41911831d77c5", [:mix], [], "hexpm", "970a3cd19503f5e8e527a190662be2cee5d98eed1ff72ed9b3d1a3d466692de8"},
   "eqwalizer_support": {:git, "https://github.com/whatsapp/eqwalizer.git", "1a787cb604f6083ebe8763e358ea362e4677e500", [branch: "main", sparse: "eqwalizer_support"]},
   "erlex": {:hex, :erlex, "0.2.7", "810e8725f96ab74d17aac676e748627a07bc87eb950d2b83acd29dc047a30595", [:mix], [], "hexpm", "3ed95f79d1a844c3f6bf0cea61e0d5612a42ce56da9c03f01df538685365efb0"},
+  "ex_doc": {:hex, :ex_doc, "0.37.1", "65ca30d242082b95aa852b3b73c9d9914279fff56db5dc7b3859be5504417980", [:mix], [{:earmark_parser, "~> 1.4.42", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "6774f75477733ea88ce861476db031f9399c110640752ca2b400dbbb50491224"},
+  "makeup": {:hex, :makeup, "1.2.1", "e90ac1c65589ef354378def3ba19d401e739ee7ee06fb47f94c687016e3713d1", [:mix], [{:nimble_parsec, "~> 1.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "d36484867b0bae0fea568d10131197a4c2e47056a6fbe84922bf6ba71c8d17ce"},
+  "makeup_elixir": {:hex, :makeup_elixir, "1.0.1", "e928a4f984e795e41e3abd27bfc09f51db16ab8ba1aebdba2b3a575437efafc2", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "7284900d412a3e5cfd97fdaed4f5ed389b8f2b4cb49efc0eb3bd10e2febf9507"},
+  "makeup_erlang": {:hex, :makeup_erlang, "1.0.2", "03e1804074b3aa64d5fad7aa64601ed0fb395337b982d9bcf04029d68d51b6a7", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "af33ff7ef368d5893e4a267933e7744e46ce3cf1f61e2dccf53a111ed3aa3727"},
+  "nimble_parsec": {:hex, :nimble_parsec, "1.4.2", "8efba0122db06df95bfaa78f791344a89352ba04baedd3849593bfce4d0dc1c6", [:mix], [], "hexpm", "4b21398942dda052b403bbe1da991ccd03a053668d147d53fb8c4e0efe09c973"},
 }

apps/opentelemetry_api/mix.lock

@@ -7,5 +7,5 @@
             {doclet, edoc_doclet_chunks},
             {layout, edoc_layout_chunks},
             {preprocess, true},
-            {dir, "apps/opentelemetry_api/_build/dev/lib/opentelemetry_api/doc"},
+            {dir, "_build/dev/lib/opentelemetry_api/doc"},
             {subpackages, true}]}]}]}.

apps/opentelemetry_api/rebar.config

@@ -394,7 +394,7 @@ link(_, _) ->
       TraceId :: trace_id(),
       SpanId :: span_id(),
       Attributes :: attributes_map(),
-      TraceState :: otel_tracestate:t() | otel_tracestate:members().
+      TraceState :: otel_tracestate:t().
 link(TraceId, SpanId, Attributes, TraceState) when is_integer(TraceId),
                                                    is_integer(SpanId),
                                                    (is_list(Attributes) orelse is_map(Attributes)) ->