Merge branch 'main' into lzchen-patch-10

Author: lzchen

.github/scripts/update-version-patch.sh

@@ -0,0 +1,11 @@
+#!/bin/bash -e
+
+sed -i "/\[stable\]/{n;s/version=.*/version=$1/}" eachdist.ini
+sed -i "/\[prerelease\]/{n;s/version=.*/version=$2/}" eachdist.ini
+
+./scripts/eachdist.py update_patch_versions \
+    --stable_version=$1 \
+    --unstable_version=$2 \
+    --stable_version_prev=$3 \
+    --unstable_version_prev=$4
+

.github/workflows/prepare-patch-release.yml

@@ -43,14 +43,18 @@ jobs:
             exit 1
           fi
 
+          stable_version_prev="$stable_major_minor.$((stable_patch))"
+          unstable_version_prev="0.${unstable_minor}b$((unstable_patch))"
           stable_version="$stable_major_minor.$((stable_patch + 1))"
           unstable_version="0.${unstable_minor}b$((unstable_patch + 1))"
 
           echo "STABLE_VERSION=$stable_version" >> $GITHUB_ENV
           echo "UNSTABLE_VERSION=$unstable_version" >> $GITHUB_ENV
+          echo "STABLE_VERSION_PREV=$stable_version_prev" >> $GITHUB_ENV
+          echo "UNSTABLE_VERSION_PREV=$unstable_version_prev" >> $GITHUB_ENV
 
       - name: Update version
-        run: .github/scripts/update-version.sh $STABLE_VERSION $UNSTABLE_VERSION
+        run: .github/scripts/update-version-patch.sh $STABLE_VERSION $UNSTABLE_VERSION $STABLE_VERSION_PREV $UNSTABLE_VERSION_PREV
 
       - name: Update the change log with the approximate release date
         run: |

.github/workflows/release.yml

@@ -129,80 +129,3 @@ jobs:
                             --notes-file /tmp/release-notes.txt \
                             --discussion-category announcements \
                             v$STABLE_VERSION
-
-      - uses: actions/checkout@v4
-        with:
-          # the step below is creating a pull request against main
-          ref: main
-
-      - name: Copy change log updates to main
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          if [[ -z $PRIOR_VERSION_WHEN_PATCH ]]; then
-            # this was not a patch release, so the version exists already in the CHANGELOG.md
-
-            # update the release date
-            date=$(gh release view v$STABLE_VERSION --json publishedAt --jq .publishedAt | sed 's/T.*//')
-            sed -Ei "s/## Version ${STABLE_VERSION}\/${UNSTABLE_VERSION} .*/## Version ${STABLE_VERSION}\/${UNSTABLE_VERSION} ($date)/" CHANGELOG.md
-
-            # the entries are copied over from the release branch to support workflows
-            # where change log entries may be updated after preparing the release branch
-
-            # copy the portion above the release, up to and including the heading
-            sed -n "0,/^## Version ${STABLE_VERSION}\/${UNSTABLE_VERSION} ($date)/p" CHANGELOG.md > /tmp/CHANGELOG.md
-
-            # copy the release notes
-            cat /tmp/CHANGELOG_SECTION.md >> /tmp/CHANGELOG.md
-
-            # copy the portion below the release
-            sed -n "0,/^## Version ${STABLE_VERSION}\/${UNSTABLE_VERSION} /d;0,/^## Version /{/^## Version/!d};p" CHANGELOG.md \
-              >> /tmp/CHANGELOG.md
-
-            # update the real CHANGELOG.md
-            cp /tmp/CHANGELOG.md CHANGELOG.md
-          else
-            # this was a patch release, so the version does not exist already in the CHANGELOG.md
-
-            # copy the portion above the top-most release, not including the heading
-            sed -n "0,/^## Version /{ /^## Version /!p }" CHANGELOG.md > /tmp/CHANGELOG.md
-
-            # add the heading
-            date=$(gh release view v$STABLE_VERSION --json publishedAt --jq .publishedAt | sed 's/T.*//')
-            echo "## Version ${STABLE_VERSION}/${UNSTABLE_VERSION} ($date)" >> /tmp/CHANGELOG.md
-
-            # copy the release notes
-            cat /tmp/CHANGELOG_SECTION.md >> /tmp/CHANGELOG.md
-
-            # copy the portion starting from the top-most release
-            sed -n "/^## Version /,\$p" CHANGELOG.md >> /tmp/CHANGELOG.md
-
-            # update the real CHANGELOG.md
-            cp /tmp/CHANGELOG.md CHANGELOG.md
-          fi
-
-      - name: Use CLA approved github bot
-        run: .github/scripts/use-cla-approved-github-bot.sh
-
-      - name: Create pull request against main
-        env:
-          # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows
-          GITHUB_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}
-        run: |
-          message="Copy change log updates from $GITHUB_REF_NAME"
-          body="Copy log updates from \`$GITHUB_REF_NAME\`."
-          branch="opentelemetrybot/copy-change-log-updates-from-${GITHUB_REF_NAME//\//-}"
-
-          if [[ -z $PRIOR_VERSION_WHEN_PATCH ]]; then
-            if git diff --quiet; then
-              echo there are no updates needed to the change log on main, not creating pull request
-              exit 0 # success
-            fi
-          fi
-
-          git commit -a -m "$message"
-          git push origin HEAD:$branch
-          gh pr create --title "$message" \
-                       --body "$body" \
-                       --head $branch \
-                       --base main

CHANGELOG.md

@@ -7,12 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+- Fix crash exporting a log record with None body
+  ([#4276](https://github.com/open-telemetry/opentelemetry-python/pull/4276))
 - Fix metrics export with exemplar and no context and filtering observable instruments
   ([#4251](https://github.com/open-telemetry/opentelemetry-python/pull/4251))
 - Fix recursion error with sdk disabled and handler added to root logger
   ([#4259](https://github.com/open-telemetry/opentelemetry-python/pull/4259))
 - sdk: setup EventLogger when OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED is set
   ([#4270](https://github.com/open-telemetry/opentelemetry-python/pull/4270))
+- api: fix logging of duplicate EventLogger setup warning
+  ([#4299](https://github.com/open-telemetry/opentelemetry-python/pull/4299))
 
 ## Version 1.28.0/0.49b0 (2024-11-05)
 

exporter/opentelemetry-exporter-otlp-proto-common/src/opentelemetry/exporter/otlp/proto/common/_internal/_log_encoder/__init__.py

@@ -48,13 +48,14 @@ def _encode_log(log_data: LogData) -> PB2LogRecord:
         if log_data.log_record.trace_id == 0
         else _encode_trace_id(log_data.log_record.trace_id)
     )
+    body = log_data.log_record.body
     return PB2LogRecord(
         time_unix_nano=log_data.log_record.timestamp,
         observed_time_unix_nano=log_data.log_record.observed_timestamp,
         span_id=span_id,
         trace_id=trace_id,
         flags=int(log_data.log_record.trace_flags),
-        body=_encode_value(log_data.log_record.body),
+        body=_encode_value(body) if body is not None else None,
         severity_text=log_data.log_record.severity_text,
         attributes=_encode_attributes(log_data.log_record.attributes),
         dropped_attributes_count=log_data.log_record.dropped_attributes,

exporter/opentelemetry-exporter-otlp-proto-common/tests/test_log_encoder.py

@@ -51,6 +51,18 @@ def test_encode(self):
         sdk_logs, expected_encoding = self.get_test_logs()
         self.assertEqual(encode_logs(sdk_logs), expected_encoding)
 
+    def test_encode_no_body(self):
+        sdk_logs, expected_encoding = self.get_test_logs()
+        for log in sdk_logs:
+            log.log_record.body = None
+
+        for resource_log in expected_encoding.resource_logs:
+            for scope_log in resource_log.scope_logs:
+                for log_record in scope_log.log_records:
+                    log_record.ClearField("body")
+
+        self.assertEqual(encode_logs(sdk_logs), expected_encoding)
+
     def test_dropped_attributes_count(self):
         sdk_logs = self._get_test_logs_dropped_attributes()
         encoded_logs = encode_logs(sdk_logs)

opentelemetry-api/src/opentelemetry/_events/__init__.py

@@ -192,7 +192,7 @@ def set_elp() -> None:
 
     did_set = _EVENT_LOGGER_PROVIDER_SET_ONCE.do_once(set_elp)
 
-    if log and did_set:
+    if log and not did_set:
         _logger.warning(
             "Overriding of current EventLoggerProvider is not allowed"
         )

opentelemetry-api/tests/events/test_event_logger_provider.py

@@ -11,13 +11,28 @@
 
 
 class TestGlobals(EventsGlobalsTest, unittest.TestCase):
-    def test_set_event_logger_provider(self):
+    @patch("opentelemetry._events._logger")
+    def test_set_event_logger_provider(self, logger_mock):
         elp_mock = Mock()
         # pylint: disable=protected-access
         self.assertIsNone(events._EVENT_LOGGER_PROVIDER)
         set_event_logger_provider(elp_mock)
         self.assertIs(events._EVENT_LOGGER_PROVIDER, elp_mock)
         self.assertIs(get_event_logger_provider(), elp_mock)
+        logger_mock.warning.assert_not_called()
+
+    # pylint: disable=no-self-use
+    @patch("opentelemetry._events._logger")
+    def test_set_event_logger_provider_will_warn_second_call(
+        self, logger_mock
+    ):
+        elp_mock = Mock()
+        set_event_logger_provider(elp_mock)
+        set_event_logger_provider(elp_mock)
+
+        logger_mock.warning.assert_called_once_with(
+            "Overriding of current EventLoggerProvider is not allowed"
+        )
 
     def test_get_event_logger_provider(self):
         # pylint: disable=protected-access

scripts/eachdist.py

@@ -236,6 +236,16 @@ def setup_instparser(instparser):
         "releaseargs", nargs=argparse.REMAINDER, help=extraargs_help("pytest")
     )
 
+    patchreleaseparser = subparsers.add_parser(
+        "update_patch_versions",
+        help="Updates version numbers during patch release, used by maintainers and CI",
+    )
+    patchreleaseparser.set_defaults(func=patch_release_args)
+    patchreleaseparser.add_argument("--stable_version", required=True)
+    patchreleaseparser.add_argument("--unstable_version", required=True)
+    patchreleaseparser.add_argument("--stable_version_prev", required=True)
+    patchreleaseparser.add_argument("--unstable_version_prev", required=True)
+
     fmtparser = subparsers.add_parser(
         "format",
         help="Formats all source code with black and isort.",
@@ -599,6 +609,24 @@ def update_dependencies(targets, version, packages):
         )
 
 
+def update_patch_dependencies(targets, version, prev_version, packages):
+    print("updating patch dependencies")
+    # PEP 508 allowed specifier operators
+    operators = ["==", "!=", "<=", ">=", "<", ">", "===", "~=", "="]
+    operators_pattern = "|".join(re.escape(op) for op in operators)
+
+    for pkg in packages:
+        search = rf"({basename(pkg)}[^,]*?)(\s?({operators_pattern})\s?)(.*{prev_version})"
+        replace = r"\g<1>\g<2>" + version
+        print(f"{search=}\t{replace=}\t{pkg=}")
+        update_files(
+            targets,
+            "pyproject.toml",
+            search,
+            replace,
+        )
+
+
 def update_files(targets, filename, search, replace):
     errors = False
     for target in targets:
@@ -640,6 +668,32 @@ def release_args(args):
         update_version_files(targets, version, packages)
 
 
+def patch_release_args(args):
+    print("preparing patch release")
+
+    rootpath = find_projectroot()
+    targets = list(find_targets_unordered(rootpath))
+    cfg = ConfigParser()
+    cfg.read(str(find_projectroot() / "eachdist.ini"))
+    # stable
+    mcfg = cfg["stable"]
+    packages = mcfg["packages"].split()
+    print(f"update stable packages to {args.stable_version}")
+    update_patch_dependencies(
+        targets, args.stable_version, args.stable_version_prev, packages
+    )
+    update_version_files(targets, args.stable_version, packages)
+
+    # prerelease
+    mcfg = cfg["prerelease"]
+    packages = mcfg["packages"].split()
+    print(f"update prerelease packages to {args.unstable_version}")
+    update_patch_dependencies(
+        targets, args.unstable_version, args.unstable_version_prev, packages
+    )
+    update_version_files(targets, args.unstable_version, packages)
+
+
 def test_args(args):
     clean_remainder_args(args.pytestargs)
     execute_args(