Skip to content

fix(sdk-metrics): Add missing catch and handle error in promise of PeriodicExportingMetricReader#5006

Merged
pichlermarc merged 3 commits intoopen-telemetry:mainfrom
jj22ee:metric-reader-fix-error-handling
Sep 24, 2024
Merged

fix(sdk-metrics): Add missing catch and handle error in promise of PeriodicExportingMetricReader#5006
pichlermarc merged 3 commits intoopen-telemetry:mainfrom
jj22ee:metric-reader-fix-error-handling

Conversation

@jj22ee
Copy link
Copy Markdown
Contributor

@jj22ee jj22ee commented Sep 21, 2024

Which problem is this PR solving?

PeriodicExportingMetricReader's doExport method will throw an Error if metrics export failed, and is expected to be caught within this try-catch.

This method is called in two locations within the same if-else, but is only caught/handled in the else while not being caught/handled in the if. Although the if-else is within a try-catch, one of the doExport invocations is called within a Promise.then(), which isn't being caught right now

This PR ensures that doExport in Location 1 is caught.

Short description of the changes

  • Add catch to the promise that runs doExport in the then statement

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Test in my application involving PeriodicExportingMetricReader with small metric export interval and many resource detectors (which causes resourceMetrics.resource.asyncAttributesPending to be true)

export OTEL_METRIC_EXPORT_INTERVAL=50     // 50ms export interval makes it easier to trigger this error, but is unrealistic
export OTEL_NODE_RESOURCE_DETECTORS='process,env,host'
  • Before fix, I trigger crash
Accessing resource attributes before async attributes settled
/Users/-------/Documents/sample_project/node_modules/@opentelemetry/sdk-metrics/build/src/export/PeriodicExportingMetricReader.js:76
                throw new Error(`PeriodicExportingMetricReader: metrics export failed (error ${result.error})`);
                      ^

Error: PeriodicExportingMetricReader: metrics export failed (error Error: 14 UNAVAILABLE: No connection established. Last error: connect ECONNREFUSED 127.0.0.1:4318 (2024-09-20T22:43:31.324Z))
    at doExport (/Users/-------/Documents/sample_project/node_modules/@opentelemetry/sdk-metrics/build/src/export/PeriodicExportingMetricReader.js:76:23)
    at processTicksAndRejections (node:internal/process/task_queues:95:5)
    at runNextTicks (node:internal/process/task_queues:64:3)
    at process.processImmediate (node:internal/timers:449:9)
    at process.callbackTrampoline (node:internal/async_hooks:130:17)
  • After fix, error is logged
Accessing resource attributes before async attributes settled
{"stack":"Error: PeriodicExportingMetricReader: metrics export failed (error Error: 14 UNAVAILABLE: No connection established. Last error: connect ECONNREFUSED 127.0.0.1:4318 (2024-09-21T00:02:04.200Z))\n    at doExport (/Users/-------/Documents/sample_project/node_modules/@opentelemetry/sdk-metrics/build/src/export/PeriodicExportingMetricReader.js:76:23)\n    at processTicksAndRejections (node:internal/process/task_queues:95:5)\n    at runNextTicks (node:internal/process/task_queues:64:3)\n    at process.processImmediate (node:internal/timers:449:9)\n    at process.callbackTrampoline (node:internal/async_hooks:130:17)\n    at async PeriodicExportingMetricReader._doRun (/Users/-------/Documents/sample_project/node_modules/@opentelemetry/sdk-metrics/build/src/export/PeriodicExportingMetricReader.js:84:13)\n    at async PeriodicExportingMetricReader._runOnce (/Users/-------/Documents/sample_project/node_modules/@opentelemetry/sdk-metrics/build/src/export/PeriodicExportingMetricReader.js:55:13)","message":"PeriodicExportingMetricReader: metrics export failed (error Error: 14 UNAVAILABLE: No connection established. Last error: connect ECONNREFUSED 127.0.0.1:43158(2024-09-21T00:02:04.200Z))","name":"Error"}

Checklist:

  • Followed the style guidelines of this project
  • Unit tests have been added
  • Documentation has been updated

@jj22ee jj22ee requested a review from a team as a code owner September 21, 2024 00:16
pichlermarc
pichlermarc approved these changes Sep 23, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@pichlermarc pichlermarc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see:

if the attributes are pending AND the promise form waitForAsyncAttributes() resolves, then doExport() is called, and IF that rejects (that happens when when the exporter returns failure) then the the promise is unhandled.

Good catch 👍

I feel like the whole code-block should've really been:

    // Avoid scheduling a promise to make the behavior more predictable and easier to test
    if (resourceMetrics.resource.asyncAttributesPending) {
      try {
        await resourceMetrics.resource.waitForAsyncAttributes?.();
      } catch (err) {
        diag.debug('Error while resolving async portion of resource: ', err);
        return;
      }
    }

    await doExport();

to ensure that the error reprorted to globalErrorHandler actually has the correct stacktrace on it.

Please also add a changelog (./CHANGELOG.md) entry. Thanks for fixing this. 🙂

@jj22ee jj22ee force-pushed the metric-reader-fix-error-handling branch from ee2ed87 to bd39689 Compare September 23, 2024 17:21
@jj22ee
Copy link
Copy Markdown
Contributor Author

jj22ee commented Sep 23, 2024

ty! Added changelog.

@codecov
Copy link
Copy Markdown

codecov Bot commented Sep 24, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.92%. Comparing base (f8ab559) to head (bd39689).
Report is 13 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #5006      +/-   ##
==========================================
+ Coverage   93.39%   93.92%   +0.53%     
==========================================
  Files          46      310     +264     
  Lines         712     8138    +7426     
  Branches      120     1633    +1513     
==========================================
+ Hits          665     7644    +6979     
- Misses         47      494     +447
Files with missing lines Coverage Δ
...etrics/src/export/PeriodicExportingMetricReader.ts 92.98% <ø> (ø)

... and 265 files with indirect coverage changes

@pichlermarc pichlermarc added this pull request to the merge queue Sep 24, 2024
Merged via the queue into open-telemetry:main with commit 5627d84 Sep 24, 2024
@opentelemetrybot opentelemetrybot mentioned this pull request Oct 14, 2024
Merged
@jj22ee jj22ee mentioned this pull request Nov 28, 2024
Closed
6 tasks
newkdr added a commit to newkdr/vscode-gitlens that referenced this pull request Dec 24, 2024
@newkdr
[Snyk] Upgrade @opentelemetry/resources from 1.27.0 to 1.28.0 (#13)
0fe2349 
![snyk-top-banner](https://redirect.github.com/andygongea/OWASP-Benchmark/assets/818805/c518c423-16fe-447e-b67f-ad5a49b5d123)


<h3>Snyk has created this PR to upgrade @opentelemetry/resources from
1.27.0 to 1.28.0.</h3>

:information_source: Keep your dependencies up-to-date. This makes it
easier to fix existing vulnerabilities and to more quickly identify and
fix newly disclosed vulnerabilities when they affect your project.

<hr/>


- The recommended version is **1 version** ahead of your current
version.

- The recommended version was released **a month ago**.



<details>
<summary><b>Release notes</b></summary>
<br/>
  <details>
    <summary>Package name: <b>@opentelemetry/resources</b></summary>
    <ul>
      <li>
<b>1.28.0</b> - <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/releases/tag/semconv%2Fv1.28.0">2024-11-18</a></br><h2>1.28.0</h2>
<h3>🚀 (Enhancement)</h3>
<ul>
<li>feat: update semantic conventions to 1.28.0 <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5181"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5181/hovercard">gitkraken#5181</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/trentm/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/trentm">@ trentm</a></li>
</ul>
<h3>📚 (Refine Doc)</h3>
<ul>
<li>chore: Improve documentation on entry-points (top-level and
"incubating") and on deprecations. <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/issues/5025"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/opentelemetry-js/issues/5025/hovercard">gitkraken#5025</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/trentm/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/trentm">@ trentm</a></li>
</ul>
<h3>🏠 (Internal)</h3>
<ul>
<li>chore: Update the comments of some deprecated constants to point to
the currently relevant replacement constant, if any. <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5160"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5160/hovercard">gitkraken#5160</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/trentm/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/trentm">@ trentm</a></li>
<li>chore: Minor improvements to formatting of comments. <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5100"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5100/hovercard">gitkraken#5100</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/trentm/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/trentm">@ trentm</a></li>
</ul>
      </li>
      <li>
<b>1.27.0</b> - <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/releases/tag/v1.27.0">2024-10-23</a></br><h2>1.27.0</h2>
<h3>🚀 (Enhancement)</h3>
<ul>
<li>feat: add processors for adding session.id attribute to spans and
logs <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/4972"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/4972/hovercard">gitkraken#4972</a></li>
</ul>
<h3>🐛 (Bug Fix)</h3>
<ul>
<li>fix(sdk-trace-base): avoid keeping non-string
<code>status.message</code> on <code>Span#setStatus()</code> <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/4999"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/4999/hovercard">gitkraken#4999</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/pichlermarc/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/pichlermarc">@ pichlermarc</a></li>
<li>fix(sdk-metrics): Add missing catch and handle error in promise of
<code>PeriodicExportingMetricReader</code> <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5006"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5006/hovercard">gitkraken#5006</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/jj22ee/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/jj22ee">@ jj22ee</a></li>
<li>fix(opentelemetry-core): confusing log extract of composite
propagator <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5017"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5017/hovercard">#5017</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/rv2673/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/rv2673">@ rv2673</a></li>
<li>fix(propagator-aws-xray-*): move propagators back to contrib
repository <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/4966"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/4966/hovercard">gitkraken#4966</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/pichlermarc/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/pichlermarc">@ pichlermarc</a>
<ul>
<li>The <a
href="https://redirect.github.com/open-telemetry/opentelemetry-specification/blob/6672dbc97ddeb34f36c020a0f0a30323c8bc4d95/specification/context/api-propagators.md?plain=1#L354-L356">specification</a>
prohibits hosting these packages in the core repository</li>
<li><code>@ opentelemetry/propagator-aws-xray</code> is now located in
<a
href="https://redirect.github.com/open-telemetry/opentelemetry-js-contrib">open-telemetry/opentelemetry-js-contrib</a></li>
<li><code>@ opentelemetry/propagator-aws-xray-lambda</code> is now
located in <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js-contrib">open-telemetry/opentelemetry-js-contrib</a></li>
</ul>
</li>
</ul>
<h3>🏠 (Internal)</h3>
<ul>
<li>deps: set <code>@ opentelemetry/api</code> dependency min version to
1.3.0 in <code>examples</code>, <code>experimental/packages</code>,
<code>integration-tests</code> and <code>selenium-tests</code><br>
<a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/4992"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/4992/hovercard">gitkraken#4992</a></li>
<li>refactor(sdk-metrics): replace <code>MetricsAttributes</code> with
<code>Attributes</code> <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5021"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5021/hovercard">gitkraken#5021</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/david-luna/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/david-luna">@ david-luna</a></li>
<li>refactor(instrumentation-http): replace <code>SpanAttributes</code>
and <code>MetricsAttributes</code> with <code>Attributes</code> <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5023"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5023/hovercard">gitkraken#5023</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/david-luna/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/david-luna">@ david-luna</a></li>
<li>chore(exporter-zipkin): remove usages of Span constructor <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5030"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5030/hovercard">gitkraken#5030</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/david-luna/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/david-luna">@ david-luna</a></li>
<li>test(instrumentation-http): remove usages of <code>new Span</code>
in tests <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5035"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5035/hovercard">gitkraken#5035</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/david-luna/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/david-luna">@ david-luna</a></li>
</ul>
      </li>
    </ul>
from <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/releases">@opentelemetry/resources
GitHub release notes</a>
  </details>
</details>

---

> [!IMPORTANT]
>
> - Check the changes in this PR to ensure they won't cause issues with
your project.
> - This PR was automatically created by Snyk using the credentials of a
real user.

---

**Note:** _You are seeing this because you or someone else with access
to this repository has authorized Snyk to open upgrade PRs._

**For more information:** <img
src="https://api.segment.io/v1/pixel/track?data=eyJ3cml0ZUtleSI6InJyWmxZcEdHY2RyTHZsb0lYd0dUcVg4WkFRTnNCOUEwIiwiYW5vbnltb3VzSWQiOiI3NmZlY2E0OC0xYzFkLTRiOTItOGMzNC1lYmNkNzM3ODg3MTciLCJldmVudCI6IlBSIHZpZXdlZCIsInByb3BlcnRpZXMiOnsicHJJZCI6Ijc2ZmVjYTQ4LTFjMWQtNGI5Mi04YzM0LWViY2Q3Mzc4ODcxNyJ9fQ=="
width="0" height="0"/>

> - 🧐 [View latest project
report](https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17?utm_source&#x3D;github&amp;utm_medium&#x3D;referral&amp;page&#x3D;upgrade-pr)
> - 📜 [Customise PR
templates](https://docs.snyk.io/scan-using-snyk/pull-requests/snyk-fix-pull-or-merge-requests/customize-pr-templates?utm_source=&utm_content=fix-pr-template)
> - 🛠 [Adjust upgrade PR
settings](https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17/settings/integration?utm_source&#x3D;github&amp;utm_medium&#x3D;referral&amp;page&#x3D;upgrade-pr)
> - 🔕 [Ignore this dependency or unsubscribe from future upgrade
PRs](https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17/settings/integration?pkg&#x3D;@opentelemetry/resources&amp;utm_source&#x3D;github&amp;utm_medium&#x3D;referral&amp;page&#x3D;upgrade-pr#auto-dep-upgrades)

[//]: #
'snyk:metadata:{"customTemplate":{"variablesUsed":[],"fieldsUsed":[]},"dependencies":[{"name":"@opentelemetry/resources","from":"1.27.0","to":"1.28.0"}],"env":"prod","hasFixes":false,"isBreakingChange":false,"isMajorUpgrade":false,"issuesToFix":[],"prId":"76feca48-1c1d-4b92-8c34-ebcd73788717","prPublicId":"76feca48-1c1d-4b92-8c34-ebcd73788717","packageManager":"npm","priorityScoreList":[],"projectPublicId":"12a8a5f5-3e19-438c-8280-eb8f4ee06d17","projectUrl":"https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17?utm_source=github&utm_medium=referral&page=upgrade-pr","prType":"upgrade","templateFieldSources":{"branchName":"default","commitMessage":"default","description":"default","title":"default"},"templateVariants":[],"type":"auto","upgrade":[],"upgradeInfo":{"versionsDiff":1,"publishedDate":"2024-11-18T10:41:43.016Z"},"vulns":[]}'
newkdr added a commit to newkdr/vscode-gitlens that referenced this pull request Dec 24, 2024
@newkdr
[Snyk] Upgrade @opentelemetry/semantic-conventions from 1.27.0 to 1.2…
2121ec8 
…8.0 (#12)

![snyk-top-banner](https://redirect.github.com/andygongea/OWASP-Benchmark/assets/818805/c518c423-16fe-447e-b67f-ad5a49b5d123)


<h3>Snyk has created this PR to upgrade
@opentelemetry/semantic-conventions from 1.27.0 to 1.28.0.</h3>

:information_source: Keep your dependencies up-to-date. This makes it
easier to fix existing vulnerabilities and to more quickly identify and
fix newly disclosed vulnerabilities when they affect your project.

<hr/>


- The recommended version is **1 version** ahead of your current
version.

- The recommended version was released **a month ago**.



<details>
<summary><b>Release notes</b></summary>
<br/>
  <details>
<summary>Package name:
<b>@opentelemetry/semantic-conventions</b></summary>
    <ul>
      <li>
<b>1.28.0</b> - <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/releases/tag/semconv%2Fv1.28.0">2024-11-20</a></br><h2>1.28.0</h2>
<h3>🚀 (Enhancement)</h3>
<ul>
<li>feat: update semantic conventions to 1.28.0 <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5181"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5181/hovercard">gitkraken#5181</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/trentm/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/trentm">@ trentm</a></li>
</ul>
<h3>📚 (Refine Doc)</h3>
<ul>
<li>chore: Improve documentation on entry-points (top-level and
"incubating") and on deprecations. <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/issues/5025"
data-hovercard-type="issue"
data-hovercard-url="/open-telemetry/opentelemetry-js/issues/5025/hovercard">gitkraken#5025</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/trentm/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/trentm">@ trentm</a></li>
</ul>
<h3>🏠 (Internal)</h3>
<ul>
<li>chore: Update the comments of some deprecated constants to point to
the currently relevant replacement constant, if any. <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5160"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5160/hovercard">gitkraken#5160</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/trentm/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/trentm">@ trentm</a></li>
<li>chore: Minor improvements to formatting of comments. <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5100"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5100/hovercard">gitkraken#5100</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/trentm/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/trentm">@ trentm</a></li>
</ul>
      </li>
      <li>
<b>1.27.0</b> - <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/releases/tag/v1.27.0">2024-08-28</a></br><h2>1.27.0</h2>
<h3>🚀 (Enhancement)</h3>
<ul>
<li>feat: add processors for adding session.id attribute to spans and
logs <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/4972"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/4972/hovercard">gitkraken#4972</a></li>
</ul>
<h3>🐛 (Bug Fix)</h3>
<ul>
<li>fix(sdk-trace-base): avoid keeping non-string
<code>status.message</code> on <code>Span#setStatus()</code> <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/4999"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/4999/hovercard">gitkraken#4999</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/pichlermarc/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/pichlermarc">@ pichlermarc</a></li>
<li>fix(sdk-metrics): Add missing catch and handle error in promise of
<code>PeriodicExportingMetricReader</code> <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5006"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5006/hovercard">gitkraken#5006</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/jj22ee/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/jj22ee">@ jj22ee</a></li>
<li>fix(opentelemetry-core): confusing log extract of composite
propagator <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5017"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5017/hovercard">#5017</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/rv2673/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/rv2673">@ rv2673</a></li>
<li>fix(propagator-aws-xray-*): move propagators back to contrib
repository <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/4966"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/4966/hovercard">gitkraken#4966</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/pichlermarc/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/pichlermarc">@ pichlermarc</a>
<ul>
<li>The <a
href="https://redirect.github.com/open-telemetry/opentelemetry-specification/blob/6672dbc97ddeb34f36c020a0f0a30323c8bc4d95/specification/context/api-propagators.md?plain=1#L354-L356">specification</a>
prohibits hosting these packages in the core repository</li>
<li><code>@ opentelemetry/propagator-aws-xray</code> is now located in
<a
href="https://redirect.github.com/open-telemetry/opentelemetry-js-contrib">open-telemetry/opentelemetry-js-contrib</a></li>
<li><code>@ opentelemetry/propagator-aws-xray-lambda</code> is now
located in <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js-contrib">open-telemetry/opentelemetry-js-contrib</a></li>
</ul>
</li>
</ul>
<h3>🏠 (Internal)</h3>
<ul>
<li>deps: set <code>@ opentelemetry/api</code> dependency min version to
1.3.0 in <code>examples</code>, <code>experimental/packages</code>,
<code>integration-tests</code> and <code>selenium-tests</code><br>
<a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/4992"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/4992/hovercard">gitkraken#4992</a></li>
<li>refactor(sdk-metrics): replace <code>MetricsAttributes</code> with
<code>Attributes</code> <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5021"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5021/hovercard">gitkraken#5021</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/david-luna/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/david-luna">@ david-luna</a></li>
<li>refactor(instrumentation-http): replace <code>SpanAttributes</code>
and <code>MetricsAttributes</code> with <code>Attributes</code> <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5023"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5023/hovercard">gitkraken#5023</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/david-luna/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/david-luna">@ david-luna</a></li>
<li>chore(exporter-zipkin): remove usages of Span constructor <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5030"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5030/hovercard">gitkraken#5030</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/david-luna/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/david-luna">@ david-luna</a></li>
<li>test(instrumentation-http): remove usages of <code>new Span</code>
in tests <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/pull/5035"
data-hovercard-type="pull_request"
data-hovercard-url="/open-telemetry/opentelemetry-js/pull/5035/hovercard">gitkraken#5035</a>
<a class="user-mention notranslate" data-hovercard-type="user"
data-hovercard-url="/users/david-luna/hovercard"
data-octo-click="hovercard-link-click"
data-octo-dimensions="link_type:self"
href="https://redirect.github.com/david-luna">@ david-luna</a></li>
</ul>
      </li>
    </ul>
from <a
href="https://redirect.github.com/open-telemetry/opentelemetry-js/releases">@opentelemetry/semantic-conventions
GitHub release notes</a>
  </details>
</details>

---

> [!IMPORTANT]
>
> - Check the changes in this PR to ensure they won't cause issues with
your project.
> - This PR was automatically created by Snyk using the credentials of a
real user.

---

**Note:** _You are seeing this because you or someone else with access
to this repository has authorized Snyk to open upgrade PRs._

**For more information:** <img
src="https://api.segment.io/v1/pixel/track?data=eyJ3cml0ZUtleSI6InJyWmxZcEdHY2RyTHZsb0lYd0dUcVg4WkFRTnNCOUEwIiwiYW5vbnltb3VzSWQiOiIzMTNmOWJhMy0yZmY0LTQ3Y2YtYjQ0Yi05YTg5NjY4NTFkMTgiLCJldmVudCI6IlBSIHZpZXdlZCIsInByb3BlcnRpZXMiOnsicHJJZCI6IjMxM2Y5YmEzLTJmZjQtNDdjZi1iNDRiLTlhODk2Njg1MWQxOCJ9fQ=="
width="0" height="0"/>

> - 🧐 [View latest project
report](https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17?utm_source&#x3D;github&amp;utm_medium&#x3D;referral&amp;page&#x3D;upgrade-pr)
> - 📜 [Customise PR
templates](https://docs.snyk.io/scan-using-snyk/pull-requests/snyk-fix-pull-or-merge-requests/customize-pr-templates?utm_source=&utm_content=fix-pr-template)
> - 🛠 [Adjust upgrade PR
settings](https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17/settings/integration?utm_source&#x3D;github&amp;utm_medium&#x3D;referral&amp;page&#x3D;upgrade-pr)
> - 🔕 [Ignore this dependency or unsubscribe from future upgrade
PRs](https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17/settings/integration?pkg&#x3D;@opentelemetry/semantic-conventions&amp;utm_source&#x3D;github&amp;utm_medium&#x3D;referral&amp;page&#x3D;upgrade-pr#auto-dep-upgrades)

[//]: #
'snyk:metadata:{"customTemplate":{"variablesUsed":[],"fieldsUsed":[]},"dependencies":[{"name":"@opentelemetry/semantic-conventions","from":"1.27.0","to":"1.28.0"}],"env":"prod","hasFixes":false,"isBreakingChange":false,"isMajorUpgrade":false,"issuesToFix":[],"prId":"313f9ba3-2ff4-47cf-b44b-9a8966851d18","prPublicId":"313f9ba3-2ff4-47cf-b44b-9a8966851d18","packageManager":"npm","priorityScoreList":[],"projectPublicId":"12a8a5f5-3e19-438c-8280-eb8f4ee06d17","projectUrl":"https://app.snyk.io/org/newkdr/project/12a8a5f5-3e19-438c-8280-eb8f4ee06d17?utm_source=github&utm_medium=referral&page=upgrade-pr","prType":"upgrade","templateFieldSources":{"branchName":"default","commitMessage":"default","description":"default","title":"default"},"templateVariants":[],"type":"auto","upgrade":[],"upgradeInfo":{"versionsDiff":1,"publishedDate":"2024-11-20T20:31:21.818Z"},"vulns":[]}'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pichlermarc pichlermarc pichlermarc approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jj22ee @pichlermarc