Merge remote-tracking branch 'origin/main' into feature-flag-proposal

open-telemetry · May 21, 2024 · 61a62bb · 61a62bb
2 parents 4d2190d + d7d17a9
commit 61a62bb
Show file tree

Hide file tree

Showing 8 changed files with 110 additions and 85 deletions.
diff --git a/.cspell.yaml b/.cspell.yaml
@@ -6,9 +6,15 @@ patterns:
       pattern: "id: [A-Z0-9]{11}"
     - name: Google Docs ID
       pattern: "value: [a-zA-Z0-9-_]+"
+    - name: "GitHub Handle"
+      pattern: "@[a-zA-Z0-9-_]+\\b"
+    - name: "GitHub Handle in YML"
+      pattern: "github: [a-zA-Z0-9-_]+"
 ignoreRegExpList:
     - Slack Channel ID
     - Google Docs ID
+    - GitHub Handle
+    - GitHub Handle in YML
 words:
     - Collibra
     - DASD
@@ -19,10 +25,8 @@ words:
     - elastic
     - emea
     - faas
-    - galkleinman
     - gitter
     - grafana
-    - gyliu513
     - Hostmetrics
     - isovalent
     - labs
@@ -33,35 +37,22 @@ words:
     - Sysplex
     - acramsay
     - adot
-    - adrielp
-    - afrittoli
-    - alanwest
-    - alevenberg
-    - alexvanboxel
     - alolita
     - amye
     - andré
     - aniszczyk
     - apac
     - anoshin
-    - arbiv
     - armin
-    - arminru
-    - austinlparker
     - beedgen
     - beemer
     - bertysentry
     - blanco
     - bogdan
-    - bogdandrutu
     - boten
-    - braydonk
-    - breedx
     - calendar-agent-mgmt
     - calendar-ebpf
     - caramanolis
-    - carlosalberto
-    - cartermp
     - cdevents
     - chrs
     - cicd
@@ -84,37 +75,19 @@ words:
     - dpauls
     - drewby
     - drutu
-    - dsotirakis
     - dyla
-    - dyladan
     - dynatrace
-    - e-backmark-ericsson
     - easycla
     - eiffel
-    - elfo404
     - emea
     - endsigs
-    - ericchapman80
     - faas
     - fong
     - frzifus
     - gbbr
     - gitter
-    - gabibeyer
-    - henrikrexed
-    - hongalex
-    - hostmetricsreceiver
-    - horovits
-    - jackjia
     - jaglowski
-    - jcocchi
     - jemmic
-    - jigar
-    - jimporell
-    - jmacd
-    - joaopgrassi
-    - jpkrohling
-    - jsuereth
     - juraci
     - kaiyan-sheng
     - kamphaus
@@ -130,7 +103,6 @@ words:
     - lexis
     - liatrio
     - lightstep
-    - lmolkova
     - logz
     - lucavallin
     - lukas
@@ -160,8 +132,6 @@ words:
     - nikimanoledaki
     - novotny
     - observiq
-    - ocelotl
-    - oleg-nenashev
     - opentelemetry
     - opentelemetrybot
     - otel
@@ -171,40 +141,30 @@ words:
     - otep
     - otlp
     - paixão
-    - parsana
+    - pająk
     - passcodes
-    - patrickhousley
-    - pmpaulino
     - poncelow
     - proto
-    - pyohannes
     - pytest
     - raesene
     - reiley
-    - reyang
-    - rrschulze
     - ruech
     - runtimes
     - rynn
     - rossf7
     - salnikov
     - sallyom
     - scavarda
-    - scheler
     - semconv
     - sergey
     - severin
     - sguyon
     - sharma
-    - sharrmander
     - shkuro
     - sigelman
     - signup
     - skyscanner
-    - sourabh1007
     - splk
-    - spazzy757
-    - srikanthccv
     - stalnaker
     - subdir
     - subproject
@@ -213,14 +173,11 @@ words:
     - sudivate
     - suereth
     - supermajority
-    - svrnm
     - tarnovski
-    - tedsuo
     - tekton
     - thisthat
     - tiebreaking
     - tigran
-    - tigrannajaryan
     - timebox
     - timeboxing
     - timeslot
@@ -229,10 +186,4 @@ words:
     - trendable
     - triager
     - triagers
-    - trisch-me
-    - tsloughter
-    - tylerbenson
-    - xibz
-    - xoscar
     - yahn
-    - youngaaronm
diff --git a/.github/workflows/table-check.yml b/.github/workflows/table-check.yml
@@ -0,0 +1,12 @@
+name: SIG Table checking
+
+on:
+  pull_request:
+
+jobs:
+  table-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: verify SIG tables in README.md
+        run: make table-check
diff --git a/Makefile b/Makefile
@@ -1,20 +1,11 @@
 .PHONY: table-generation
 
 table-generation:
-	@if command -v python3 >/dev/null 2>&1; then \
-		echo "Python3 is installed. Running the script locally:"; \
-		python3 ./scripts/update-sig-tables.py; \
-	else \
-		echo "Python3 is not installed. Running Docker container:"; \
-		docker run --rm -v ${PWD}:/repo -w /repo python:3-alpine python ./scripts/update-sig-tables.py --install; \
-	fi
+	docker run --rm -v ${PWD}:/repo -w /repo python:3-alpine python ./scripts/update-sig-tables.py --install;
 
 
 validate-sigs:
-	@if command -v python3 >/dev/null 2>&1; then \
-		echo "Python3 is installed. Running the script locally:"; \
-		python3 ./scripts/validate-sigs.py; \
-	else \
-		echo "Python3 is not installed. Running Docker container:"; \
-		docker run --rm -v ${PWD}:/repo -w /repo python:3-alpine python ./scripts/validate-sigs.py --install; \
-	fi
+	docker run --rm -v ${PWD}:/repo -w /repo python:3-alpine python ./scripts/validate-sigs.py --install;
+
+table-check:
+	docker run --rm -v ${PWD}:/repo -w /repo python:3-alpine python ./scripts/update-sig-tables.py --install --check;
diff --git a/README.md b/README.md
@@ -134,10 +134,13 @@ SIG-specific GitHub discussions.
 | Specification: Configuration | Every other Monday at 8:00 PT | [Google Doc](https://docs.google.com/document/d/1uNgWQLQZcSVfBLRXfW9XCVJmKa5NH9R15fSOXhmpGWw) | [#otel-config-file](https://cloud-native.slack.com/archives/C0476L7UJT1) | [calendar-spec-config](https://groups.google.com/a/opentelemetry.io/g/calendar-spec-config) | [Carlos Alberto](https://github.com/carlosalberto),<br/>[Jack Berg](https://github.com/jack-berg) | [Trask Stalnaker](https://github.com/trask) | 
 | Specification: Events | Every Friday at 10:00 AM PT | [Google Doc](https://docs.google.com/document/d/1BKjQWP32FXL9g1cGbyj7DMXV1Uq_RL8_78rWaMBhN0A) | [#otel-event](https://cloud-native.slack.com/archives/C062HUREGUV) | [calendar-spec-events](https://groups.google.com/a/opentelemetry.io/g/calendar-spec-events) | [Ted Young](https://github.com/tedsuo),<br/>[Trask Stalnaker](https://github.com/trask) | [Ted Young](https://github.com/tedsuo) | 
 | Semantic Conventions: General | Every Monday at 08:00 PT | [Google Doc](https://docs.google.com/document/d/10xG7DNKWRhxNmFGt3yYd3980a9uwS8lMl2LvQL3VNK8) | [#otel-semantic-conventions-wg](https://cloud-native.slack.com/archives/C041APFBYQP) | [calendar-semconv](https://groups.google.com/a/opentelemetry.io/g/calendar-semconv) | [Armin Ruech](https://github.com/arminru),<br/>[Josh Suereth](https://github.com/jsuereth),<br/>[Reiley Yang](https://github.com/reyang) | [Trask Stalnaker](https://github.com/trask) | 
+| Semantic Conventions: Tooling | Every Wednesday at 07:00 PT | [Google Doc](https://docs.google.com/document/d/1ygwXgOFRF01UfUOgMr_ElyL7fSDPchTKSrqfj-_HeyA) | [#otel-semantic-conventions-wg](https://cloud-native.slack.com/archives/C041APFBYQP) | [calendar-semconv](https://groups.google.com/a/opentelemetry.io/g/calendar-semconv) | [Josh Suereth](https://github.com/jsuereth) |  | 
 | Semantic Conventions: Messaging | Every Thursday at 8:00 PT | [Google Doc](https://docs.google.com/document/d/1dWHhyXnfVife-cQ2DW5-d5Ldp1Lq8Rre2UsHpyo8cEE) | [#otel-messaging](https://cloud-native.slack.com/archives/C02Q4AAHDSA) | [calendar-semconv](https://groups.google.com/a/opentelemetry.io/g/calendar-semconv) | [Johannes Tax](https://github.com/pyohannes),<br/>[Liudmila Molkova](https://github.com/lmolkova) | [Trask Stalnaker](https://github.com/trask) | 
 | Semantic Conventions: Database | Every Wednesday at 9:30 PT and Friday at 8:30 PT | [Google Doc](https://docs.google.com/document/d/1zTi_Z4WBisytPnXTpwtnGOK-4Gv5oSTuMHvIQ8--5hg) | [#otel-db-client-semconv-stability-wg](https://cloud-native.slack.com/archives/C06HH05KNMC) | [calendar-semconv](https://groups.google.com/a/opentelemetry.io/g/calendar-semconv) | [Jack Berg](https://github.com/jack-berg),<br/>[Liudmila Molkova](https://github.com/lmolkova) | [Trask Stalnaker](https://github.com/trask) | 
 | Semantic Conventions: System Metrics | Every Thursday at 07:30 PT | [Google Doc](https://docs.google.com/document/d/1p5TH57t43XpxA48onLzX4PIr3g6ydYKCtR_AUlsCnQk) | [#otel-system-metrics-wg](https://cloud-native.slack.com/archives/C05CTFE9U4A) | [calendar-semconv](https://groups.google.com/a/opentelemetry.io/g/calendar-semconv) | [Josh Suereth](https://github.com/jsuereth) | [Severin Neumann](https://github.com/svrnm) | 
 | Semantic Conventions: LLM | Every Wednesday alternating between 08:00 and 16:00 PT | [Google Doc](https://docs.google.com/document/d/1EKIeDgBGXQPGehUigIRLwAUpRGa7-1kXB736EaYuJ2M) | [#otel-llm-semconv-wg](https://cloud-native.slack.com/archives/C06KR7ARS3X) | [calendar-semconv](https://groups.google.com/a/opentelemetry.io/g/calendar-semconv) | [Alolita Sharma](https://github.com/alolita),<br/>[Liudmila Molkova](https://github.com/lmolkova) | [Alolita Sharma](https://github.com/alolita) | 
+| Semantic Conventions: CI/CD | Meets during Semantic Conventions: General | [Google Doc](https://docs.google.com/document/d/10xG7DNKWRhxNmFGt3yYd3980a9uwS8lMl2LvQL3VNK8) | [#otel-semconv-security](https://cloud-native.slack.com/archives/C0715DWUW7L) | [calendar-semconv](https://groups.google.com/a/opentelemetry.io/g/calendar-semconv) | [Josh Suereth](https://github.com/jsuereth),<br/>[Carlos Alberto](https://github.com/carlosalberto) | [Trask Stalnaker](https://github.com/trask) | 
+| Semantic Conventions: Security | Meets during Semantic Conventions: General | [Google Doc](https://docs.google.com/document/d/10xG7DNKWRhxNmFGt3yYd3980a9uwS8lMl2LvQL3VNK8) | [#otel-semconv-security](https://cloud-native.slack.com/archives/C0715DWUW7L) | [calendar-semconv](https://groups.google.com/a/opentelemetry.io/g/calendar-semconv) | [Josh Suereth](https://github.com/jsuereth) | [Trask Stalnaker](https://github.com/trask) | 
 | Specification: Entities | Every other week on Thursday at 08:00 AM PT | [Google Doc](https://docs.google.com/document/d/15Yt9ss2_EhuFPqItPbk4vjfpeRDAQ5WCUVuY_kCeOAo) | [#otel-entities](https://cloud-native.slack.com/archives/C06QEG97W7L) | [calendar-entities](https://groups.google.com/a/opentelemetry.io/g/calendar-entities) | [Josh Suereth](https://github.com/jsuereth),<br/>[Tigran Najaryan](https://github.com/tigrannajaryan) | [Daniel Dyla](https://github.com/dyladan) | 
 | Agent Management | Every other week on Tuesday at 11:00 PT | [Google Doc](https://docs.google.com/document/d/19WA5-ex8rNFIBIyVb5VqMXfWNmUQwppGhN8zBeNG0f4) | [#otel-agentmanwg](https://cloud-native.slack.com/archives/C02J58HR58R) | [calendar-agent-mgmt](https://groups.google.com/a/opentelemetry.io/g/calendar-agent-mgmt) | [Tigran Najaryan](https://github.com/tigrannajaryan) | [Ted Young](https://github.com/tedsuo) | 
 | Prometheus Interoperability | Every other week on Wednesday at 08:00 PT | [Google Doc](https://docs.google.com/document/d/19bnXziPn2MZ9wO6684UoI4D-LCjGL5bTJkGhux29bx8) | [#otel-prometheus-wg](https://cloud-native.slack.com/archives/C01LSCJBXDZ) | [calendar-prometheus](https://groups.google.com/a/opentelemetry.io/g/calendar-prometheus) |  | [Alolita Sharma](https://github.com/alolita) | 
@@ -157,7 +160,7 @@ SIG-specific GitHub discussions.
 | .NET: Automatic Instrumentation | Every Wednesday at 9:00 PT | [Google Doc](https://docs.google.com/document/d/1dYdwRQVE3zu0vlp_lqGctNm0dCQUkDo2LfScUJzpuT8) | [#otel-dotnet-auto-instr](https://cloud-native.slack.com/archives/C01NR1YLSE7) | [calendar-dotnet](https://groups.google.com/a/opentelemetry.io/g/calendar-dotnet) | [Morgan McLean](https://github.com/mtwo) |
 | .NET: SDK | Every Tuesday alternating between 9:00 and 16:00 PT | [Google Doc](https://docs.google.com/document/d/1yjjD6aBcLxlRazYrawukDgrhZMObwHARJbB9glWdHj8) | [#otel-dotnet](https://cloud-native.slack.com/archives/C01N3BC2W7Q) | [calendar-dotnet](https://groups.google.com/a/opentelemetry.io/g/calendar-dotnet) | [Morgan McLean](https://github.com/mtwo) |
 | Erlang/Elixir: SDK | Every other Thursday at 9:00 PT | [Google Doc](https://docs.google.com/document/d/1EbBiRjBc_cBf0T_B5OtNRPhbD4jdBrVYJAy8euCDrUI) | [#otel-erlang-elixir](https://cloud-native.slack.com/archives/C01N75YMZCN) | [calendar-erlang](https://groups.google.com/a/opentelemetry.io/g/calendar-erlang) | [Austin Parker](https://github.com/austinlparker) |
-| GoLang: SDK | Every Thursday alternating between 10:00 and 15:00 PDT | [Google Doc](https://docs.google.com/document/d/1E5e7Ld0NuU1iVvf-42tOBpu2VBBLYnh73GJuITGJTTU) | [#otel-go](https://cloud-native.slack.com/archives/C01NPAXACKT) | [calendar-go](https://groups.google.com/a/opentelemetry.io/g/calendar-go) | [Ted Young](https://github.com/tedsuo) |
+| GoLang: SDK | Every Thursday alternating between 9:00 and 10:00 PDT | [Google Doc](https://docs.google.com/document/d/1E5e7Ld0NuU1iVvf-42tOBpu2VBBLYnh73GJuITGJTTU) | [#otel-go](https://cloud-native.slack.com/archives/C01NPAXACKT) | [calendar-go](https://groups.google.com/a/opentelemetry.io/g/calendar-go) | [Ted Young](https://github.com/tedsuo) |
 | GoLang: Automatic Instrumentation | Every other week on Tuesday at 9:30 PT | [Google Doc](https://docs.google.com/document/d/1P6am_r_cxCX1HcpDQlznrTrTOvwN2whshL0f58lXSWI) | [#otel-go-instrumentation](https://cloud-native.slack.com/archives/C03S01YSAS0) | [calendar-go](https://groups.google.com/a/opentelemetry.io/g/calendar-go) | [Juraci Paixão Kröhling](https://github.com/jpkrohling) |
 | Java: SDK + Automatic Instrumentation | Every Thursday at 09:00 PT | [Google Doc](https://docs.google.com/document/d/1WK9h4p55p8ZjPkxO75-ApI9m0wfea6ENZmMoFRvXSCw) | [#otel-java](https://cloud-native.slack.com/archives/C014L2KCTE3) | [calendar-java](https://groups.google.com/a/opentelemetry.io/g/calendar-java) | [Trask Stalnaker](https://github.com/trask) |
 | JavaScript: SDK | Every Wednesday at 09:00 PT | [Google Doc](https://docs.google.com/document/d/1tCyoQK49WVcE-x8oryZOTTToFm7sIeUhxFPm9g-qL1k) | [#otel-js](https://cloud-native.slack.com/archives/C01NL1GRPQR) and [GitHub Discussions](https://github.com/open-telemetry/opentelemetry-js/discussions) | [calendar-js](https://groups.google.com/a/opentelemetry.io/g/calendar-js) | [Daniel Dyla](https://github.com/dyladan) |

diff --git a/community-members.md b/community-members.md
@@ -61,6 +61,10 @@ Logs Approvers:
 
 - [Christian Beedgen](https://github.com/kumoroku), Sumo Logic
 - [Daniel Jaglowski](https://github.com/djaglowski), observIQ
+- [Robert Pająk](https://github.com/pellared), Splunk
+
+Logs Approvers Emeritus:
+
 - [David Poncelow](https://github.com/zenmoto), Splunk
 
 ## Semantic Conventions

diff --git a/projects/env-semconv.md → projects/sustainability-semconv.md b/projects/env-semconv.md → projects/sustainability-semconv.md
@@ -1,4 +1,6 @@
-### Description
+# Semantic Conventions for Sustainability Metrics
+
+## Description
 
 This working group looks to identify and standardize observability for
 sustainability purposes with regards to infrastructure and applications. This
@@ -12,13 +14,13 @@ Current efforts of implementations:
 
 We want to have a unified conventions in order to better facilitate measuring sustainability metrics across different ecosystems.
 
-### Deliverables
+## Deliverables
 
 - Semantic conventions for sustainability metrics
 - Reference Prototypes metrics
 - Recommended practices for reporting on sustainability metrics within the scope of OpenTelemetry 
 
-### Staffing / Help Wanted
+## Staffing / Help Wanted
 
 **Project Leads**
 - @spazzy757
@@ -34,13 +36,14 @@ We want to have a unified conventions in order to better facilitate measuring su
 - @mkorbi
 - @rossf7
 - @marceloamaral
+- @greenhsu123
 
-### Meeting Times
+## Meeting Times
 
 - Meeting Times: Mondays 2:00PM - 3:00PM UCT
 - CNCF Slack [#otel-sustainability-semconv-sig](https://cloud-native.slack.com/archives/C06RTM63YD6) for collaboration
 
-### Timeline
+## Timeline
 
 Q3 2024
 
@@ -57,13 +60,13 @@ Q4 2024
 * Declare sustainability semantic conventions as stable
 * Create Recommendations
 
-### Labels
+## Labels
 
 - `sustainability`
 
-### Linked Issues and PRs
+## Linked Issues and PRs
 - https://github.com/open-telemetry/semantic-conventions/issues/835
 
-### Project Board
+## Project Board
 
 - TBD
diff --git a/scripts/update-sig-tables.py b/scripts/update-sig-tables.py
@@ -5,9 +5,13 @@
 # in the Makefile we use a unmodified python container to run this script, so we need to install pyyaml if it's not already installed
 if (len(sys.argv) > 1) and (sys.argv[1] == "--install"):
     pip.main(['install', 'pyyaml'])
+    sys.argv = sys.argv[1:]
 
 import yaml
 
+# Do not safe the file but verify that it is different from the original one.
+run_in_check_mode = (len(sys.argv) > 1) and (sys.argv[1] == "--check")
+
 # Define the YAML input file and the markdown file to be updated
 yaml_input = "sigs.yml"
 markdown_file = "README.md"
@@ -96,11 +100,21 @@ def format_chat(chat):
 
 markdown_content += end_marker
 
-# Write the updated markdown content to file
-with open(markdown_file, 'w') as file:
-    file.write(top_part)
-    file.write(markdown_content)
-    file.write(bottom_part)
+result = top_part + markdown_content + bottom_part
+
+if run_in_check_mode:
+    with open(markdown_file, 'r') as file:
+        original = file.read()
+    if original == result:
+        sys.exit(0)
+    else:
+        sys.exit(1)
+else:
+    # Write the updated markdown content to file
+    with open(markdown_file, 'w') as file:
+        file.write(top_part)
+        file.write(markdown_content)
+        file.write(bottom_part)
 
 # Inform the user that the markdown file has been updated
 print("The markdown file has been updated with the new SIG tables.")