HTTP instrumentation header extraction functions (open-telemetry#356)

* HTTP instrumentation header extraction functions * allow setting beam opts to publishing * export types * Add test for x-forwarded-for w/multi entries
codeboten · Aug 13, 2024 · 0db4db5 · 0db4db5
1 parent 1f95229
commit 0db4db5
Show file tree

Hide file tree

Showing 8 changed files with 702 additions and 91 deletions.
diff --git a/.github/workflows/publish-mix-hex-release.yml b/.github/workflows/publish-mix-hex-release.yml
@@ -27,6 +27,18 @@ on:
           - "tesla"
           - "xandra"
         required: true
+      otp-version:
+        description: "OTP version"
+        type: string
+        default: "25.3.2.5"
+      elixir-version:
+        description: "Elixir version"
+        type: string
+        default: "1.14.5"
+      rebar3-version:
+        description: "Rebar3 version"
+        type: string
+        default: "3.22.1"
       action:
         description: "Publish release"
         required: true
@@ -195,9 +207,9 @@ jobs:
       - uses: erlef/setup-beam@b9c58b0450cd832ccdb3c17cc156a47065d2114f # v1.18.1
         with:
           version-type: strict
-          otp-version: "25.3.2.5"
-          elixir-version: "1.14.5"
-          rebar3-version: "3.22.1"
+          otp-version: ${{ inputs.otp-version }}
+          elixir-version: ${{ inputs.elixir-version }}
+          rebar3-version: ${{ inputs.rebar3-version }}
 
       - name: "Mix Hex Publish Dry-run"
         if: ${{ needs.config.outputs.build_tool == 'mix' }}

diff --git a/utilities/opentelemetry_instrumentation_http/CHANGELOG.md b/utilities/opentelemetry_instrumentation_http/CHANGELOG.md
@@ -1,5 +1,19 @@
 # Changelog
 
+## v0.2.0
+
+## Features
+
+* Adds several header extraction and manipulation functions for common tasks
+  in instrumentation libraries:
+  * `extract_client_info/1`
+  * `extract_client_info/2`
+  * `extract_scheme/1`
+  * `extract_scheme/2`
+  * `extract_server_info/1`
+  * `extract_server_info/2`
+* Generate OTP27 docs
+
 ## v0.1.0
 
 ### Changed

diff --git a/utilities/opentelemetry_instrumentation_http/README.md b/utilities/opentelemetry_instrumentation_http/README.md
@@ -9,13 +9,13 @@
 
 ```erlang
 {deps, [
-  {opentelemetry_instrumentation_http, "~> 0.1"}
+  {opentelemetry_instrumentation_http, "~> 0.2"}
 ]}
 ```
 ```elixir
 def deps do
   [
-    {:opentelemetry_instrumentation_http, "~> 0.1"}
+    {:opentelemetry_instrumentation_http, "~> 0.2"}
   ]
 end
 ```

diff --git a/utilities/opentelemetry_instrumentation_http/docs.config b/utilities/opentelemetry_instrumentation_http/docs.config
diff --git a/utilities/opentelemetry_instrumentation_http/docs.sh b/utilities/opentelemetry_instrumentation_http/docs.sh
diff --git a/utilities/opentelemetry_instrumentation_http/rebar.config b/utilities/opentelemetry_instrumentation_http/rebar.config
@@ -7,16 +7,6 @@
     rebar3_hex
 ]}.
 {profiles, [
-    {docs, [
-        {deps, [edown]},
-        {edoc_opts, [
-            {preprocess, true},
-            {doclet, edoc_doclet_chunks},
-            {layout, edoc_layout_chunks},
-            {dir, "_build/default/lib/opentelemetry_instrumentation_http/doc"},
-            {subpackages, true}
-        ]}
-    ]},
     {test, [
         {erl_opts, [nowarn_export_all]},
         {deps, []},
@@ -35,3 +25,15 @@
 {cover_enabled, true}.
 {cover_export_enabled, true}.
 {covertool, [{coverdata_files, ["ct.coverdata"]}]}.
+
+{plugins, [rebar3_ex_doc]}.
+
+{hex, [
+    {doc, #{provider => ex_doc}}
+]}.
+
+{ex_doc, [
+    {source_url, <<"https://github.com/opentelemetry-erlang-contrib/utilities/opentelemetry_instrumentation_http">>},
+    {extras, [<<"README.md">>, <<"CHANGELOG.md">>, <<"LICENSE">>]},
+    {main, <<"readme">>}
+]}.