diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 5dda6d135a..31331fc3cf 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,7 +4,7 @@ about: Create a report to help us improve labels: bug --- - @@ -15,7 +15,7 @@ Please answer these questions before submitting a bug report. ### What did you do? - @@ -27,8 +27,8 @@ If possible, provide a recipe for reproducing the error. ### Additional context - -**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/). +**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. [Learn more here](https://opentelemetry.io/community/end-user/issue-participation/). diff --git a/.github/ISSUE_TEMPLATE/discussion.md b/.github/ISSUE_TEMPLATE/discussion.md index 2f80f07483..fa8e65330f 100644 --- a/.github/ISSUE_TEMPLATE/discussion.md +++ b/.github/ISSUE_TEMPLATE/discussion.md @@ -11,5 +11,5 @@ labels: discussion - [ ] This only affects the JavaScript OpenTelemetry library - [ ] This may affect other libraries, but I would like to get opinions here first -**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/). +**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. [Learn more here](https://opentelemetry.io/community/end-user/issue-participation/). diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index b1f5d112dc..dee990ddbb 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -15,21 +15,21 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate ### Describe the solution you'd like to see - ### Describe alternatives you've considered - ### Additional context - -**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/). +**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. [Learn more here](https://opentelemetry.io/community/end-user/issue-participation/). diff --git a/.github/ISSUE_TEMPLATE/instrumentation_request.md b/.github/ISSUE_TEMPLATE/instrumentation_request.md index f0108a5f69..f85a903c31 100644 --- a/.github/ISSUE_TEMPLATE/instrumentation_request.md +++ b/.github/ISSUE_TEMPLATE/instrumentation_request.md @@ -35,4 +35,4 @@ Any code-owners listed MUST fulfill all criteria laid out in the checklist below Add any other context or screenshots about the instrumentation request here. Is there a reference you could point for the well-defined lifecycle methods? --> -**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/). +**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. [Learn more here](https://opentelemetry.io/community/end-user/issue-participation/). diff --git a/.github/ISSUE_TEMPLATE/ownership_request.md b/.github/ISSUE_TEMPLATE/ownership_request.md index 602913fbdd..fbb6c4575c 100644 --- a/.github/ISSUE_TEMPLATE/ownership_request.md +++ b/.github/ISSUE_TEMPLATE/ownership_request.md @@ -39,4 +39,4 @@ Examples: Add any other context that does not fit any of the above sections --> -**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/). +**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. [Learn more here](https://opentelemetry.io/community/end-user/issue-participation/). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4281855a74..5e2192a109 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,7 +61,7 @@ for general practices for OpenTelemetry project. #### Conventional commit -The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages. You can see examples [here](https://www.conventionalcommits.org/en/v1.0.0/#examples). +The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages. You can see examples [in the conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/#examples). We use [the "pr-title" CI workflow](./.github/workflows/pr-title.yml) to ensure PR titles, and hence the commit message from those PRs, follow the Conventional Commits spec. @@ -352,7 +352,7 @@ Review the guidelines for [Becoming a Component Owner](#becoming-a-component-own Regardless of where instrumentation is hosted, it needs to be discoverable. The [OpenTelemetry registry](https://opentelemetry.io/registry/) exists to ensure that instrumentation is discoverable. -You can find out how to add instrumentation to the registry [here](https://github.com/open-telemetry/opentelemetry.io#adding-a-project-to-the-opentelemetry-registry). +You can find out how to add instrumentation to the registry [over at opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io#adding-a-project-to-the-opentelemetry-registry). ## Contributing Vendor Components diff --git a/package-lock.json b/package-lock.json index b16a15febf..be0d19c51e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -40,7 +40,7 @@ "karma-spec-reporter": "0.0.36", "karma-webpack": "5.0.1", "lerna": "9.0.0", - "markdownlint-cli2": "0.17.2", + "markdownlint-cli2": "0.19.1", "minimatch": "9.0.5", "mocha": "11.7.5", "nock": "14.0.10", @@ -11491,9 +11491,9 @@ "license": "MIT" }, "node_modules/@sindresorhus/merge-streams": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/@sindresorhus/merge-streams/-/merge-streams-2.3.0.tgz", - "integrity": "sha512-LtoMMhxAlorcGhmFYI+LhPgbPZCkgP6ra1YL604EeF6U98pLlQ3iWIGMdWSC+vWmPBWBNgmDBAhnAobLROJmwg==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/merge-streams/-/merge-streams-4.0.0.tgz", + "integrity": "sha512-tlqY9xq5ukxTUZBmoOp+m61cqwQD5pHJtFY3Mn8CA8ps6yghLH/Hw8UPdqg4OLmFW3IFlcXnQNmo/dh8HzXYIQ==", "dev": true, "license": "MIT", "engines": { @@ -20232,63 +20232,6 @@ "node": ">=8" } }, - "node_modules/gaxios": { - "version": "5.1.3", - "resolved": "https://registry.npmjs.org/gaxios/-/gaxios-5.1.3.tgz", - "integrity": "sha512-95hVgBRgEIRQQQHIbnxBXeHbW4TqFk4ZDJW7wmVtvYar72FdhRIo1UGOLS2eRAKCPEdPBWu+M7+A33D9CdX9rA==", - "extraneous": true, - "license": "Apache-2.0", - "dependencies": { - "extend": "^3.0.2", - "https-proxy-agent": "^5.0.0", - "is-stream": "^2.0.0", - "node-fetch": "^2.6.9" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/gaxios/node_modules/agent-base": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-6.0.2.tgz", - "integrity": "sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ==", - "extraneous": true, - "license": "MIT", - "dependencies": { - "debug": "4" - }, - "engines": { - "node": ">= 6.0.0" - } - }, - "node_modules/gaxios/node_modules/https-proxy-agent": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-5.0.1.tgz", - "integrity": "sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA==", - "extraneous": true, - "license": "MIT", - "dependencies": { - "agent-base": "6", - "debug": "4" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/gcp-metadata": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/gcp-metadata/-/gcp-metadata-5.3.0.tgz", - "integrity": "sha512-FNTkdNEnBdlqF2oatizolQqNANMrcqJt6AAYt99B3y1aLLC8Hc5IOBb+ZnnzllodEEf6xMBp6wRcBbc16fa65w==", - "extraneous": true, - "license": "Apache-2.0", - "dependencies": { - "gaxios": "^5.0.0", - "json-bigint": "^1.0.0" - }, - "engines": { - "node": ">=12" - } - }, "node_modules/generate-function": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/generate-function/-/generate-function-2.3.1.tgz", @@ -25923,57 +25866,57 @@ } }, "node_modules/markdownlint": { - "version": "0.37.4", - "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.37.4.tgz", - "integrity": "sha512-u00joA/syf3VhWh6/ybVFkib5Zpj2e5KB/cfCei8fkSRuums6nyisTWGqjTWIOFoFwuXoTBQQiqlB4qFKp8ncQ==", + "version": "0.39.0", + "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.39.0.tgz", + "integrity": "sha512-Xt/oY7bAiHwukL1iru2np5LIkhwD19Y7frlsiDILK62v3jucXCD6JXlZlwMG12HZOR+roHIVuJZrfCkOhp6k3g==", "dev": true, "license": "MIT", "dependencies": { - "markdown-it": "14.1.0", - "micromark": "4.0.1", - "micromark-core-commonmark": "2.0.2", - "micromark-extension-directive": "3.0.2", + "micromark": "4.0.2", + "micromark-core-commonmark": "2.0.3", + "micromark-extension-directive": "4.0.0", "micromark-extension-gfm-autolink-literal": "2.1.0", "micromark-extension-gfm-footnote": "2.1.0", - "micromark-extension-gfm-table": "2.1.0", + "micromark-extension-gfm-table": "2.1.1", "micromark-extension-math": "3.1.0", - "micromark-util-types": "2.0.1" + "micromark-util-types": "2.0.2" }, "engines": { - "node": ">=18" + "node": ">=20" }, "funding": { "url": "https://github.com/sponsors/DavidAnson" } }, "node_modules/markdownlint-cli2": { - "version": "0.17.2", - "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.17.2.tgz", - "integrity": "sha512-XH06ZOi8wCrtOSSj3p8y3yJzwgzYOSa7lglNyS3fP05JPRzRGyjauBb5UvlLUSCGysMmULS1moxdRHHudV+g/Q==", + "version": "0.19.1", + "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.19.1.tgz", + "integrity": "sha512-p3JTemJJbkiMjXEMiFwgm0v6ym5g8K+b2oDny+6xdl300tUKySxvilJQLSea48C6OaYNmO30kH9KxpiAg5bWJw==", "dev": true, "license": "MIT", "dependencies": { - "globby": "14.0.2", - "js-yaml": "4.1.0", + "globby": "15.0.0", + "js-yaml": "4.1.1", "jsonc-parser": "3.3.1", - "markdownlint": "0.37.4", - "markdownlint-cli2-formatter-default": "0.0.5", + "markdown-it": "14.1.0", + "markdownlint": "0.39.0", + "markdownlint-cli2-formatter-default": "0.0.6", "micromatch": "4.0.8" }, "bin": { "markdownlint-cli2": "markdownlint-cli2-bin.mjs" }, "engines": { - "node": ">=18" + "node": ">=20" }, "funding": { "url": "https://github.com/sponsors/DavidAnson" } }, "node_modules/markdownlint-cli2-formatter-default": { - "version": "0.0.5", - "resolved": "https://registry.npmjs.org/markdownlint-cli2-formatter-default/-/markdownlint-cli2-formatter-default-0.0.5.tgz", - "integrity": "sha512-4XKTwQ5m1+Txo2kuQ3Jgpo/KmnG+X90dWt4acufg6HVGadTUG5hzHF/wssp9b5MBYOMCnZ9RMPaU//uHsszF8Q==", + "version": "0.0.6", + "resolved": "https://registry.npmjs.org/markdownlint-cli2-formatter-default/-/markdownlint-cli2-formatter-default-0.0.6.tgz", + "integrity": "sha512-VVDGKsq9sgzu378swJ0fcHfSicUnMxnL8gnLm/Q4J/xsNJ4e5bA6lvAz7PCzIl0/No0lHyaWdqVD2jotxOSFMQ==", "dev": true, "license": "MIT", "funding": { @@ -25984,30 +25927,40 @@ } }, "node_modules/markdownlint-cli2/node_modules/globby": { - "version": "14.0.2", - "resolved": "https://registry.npmjs.org/globby/-/globby-14.0.2.tgz", - "integrity": "sha512-s3Fq41ZVh7vbbe2PN3nrW7yC7U7MFVc5c98/iTl9c2GawNMKx/J648KQRW6WKkuU8GIbbh2IXfIRQjOZnXcTnw==", + "version": "15.0.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-15.0.0.tgz", + "integrity": "sha512-oB4vkQGqlMl682wL1IlWd02tXCbquGWM4voPEI85QmNKCaw8zGTm1f1rubFgkg3Eli2PtKlFgrnmUqasbQWlkw==", "dev": true, "license": "MIT", "dependencies": { - "@sindresorhus/merge-streams": "^2.1.0", - "fast-glob": "^3.3.2", - "ignore": "^5.2.4", - "path-type": "^5.0.0", + "@sindresorhus/merge-streams": "^4.0.0", + "fast-glob": "^3.3.3", + "ignore": "^7.0.5", + "path-type": "^6.0.0", "slash": "^5.1.0", - "unicorn-magic": "^0.1.0" + "unicorn-magic": "^0.3.0" }, "engines": { - "node": ">=18" + "node": ">=20" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/markdownlint-cli2/node_modules/ignore": { + "version": "7.0.5", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-7.0.5.tgz", + "integrity": "sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, "node_modules/markdownlint-cli2/node_modules/js-yaml": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", - "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz", + "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", "dev": true, "license": "MIT", "dependencies": { @@ -26025,13 +25978,13 @@ "license": "MIT" }, "node_modules/markdownlint-cli2/node_modules/path-type": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-5.0.0.tgz", - "integrity": "sha512-5HviZNaZcfqP95rwpv+1HDgUamezbqdSYTyzjTvwtJSnIH+3vnbmWsItli8OFEndS984VT55M3jduxZbX351gg==", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-6.0.0.tgz", + "integrity": "sha512-Vj7sf++t5pBD637NSfkxpHSMfWaeig5+DKWLhcqIYx6mWQz5hdJTGDVMQiJcw1ZYkhs7AazKDGpRVji1LJCZUQ==", "dev": true, "license": "MIT", "engines": { - "node": ">=12" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -26050,6 +26003,19 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/markdownlint-cli2/node_modules/unicorn-magic": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/unicorn-magic/-/unicorn-magic-0.3.0.tgz", + "integrity": "sha512-+QBBXBCvifc56fsbuxZQ6Sic3wqqc3WWaqxs58gvJrcOuN83HGTCwz3oS5phzU9LthRNE9VrJCFCLUgHeeFnfA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/marky": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/marky/-/marky-1.3.0.tgz", @@ -26352,9 +26318,9 @@ } }, "node_modules/micromark": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/micromark/-/micromark-4.0.1.tgz", - "integrity": "sha512-eBPdkcoCNvYcxQOAKAlceo5SNdzZWfF+FcSupREAzdAh9rRmE239CEQAiTwIgblwnoM8zzj35sZ5ZwvSEOF6Kw==", + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/micromark/-/micromark-4.0.2.tgz", + "integrity": "sha512-zpe98Q6kvavpCr1NPVSCMebCKfD7CA2NqZ+rykeNhONIJBpc1tFKt9hucLGwha3jNTNI8lHpctWJWoimVF4PfA==", "dev": true, "funding": [ { @@ -26388,9 +26354,9 @@ } }, "node_modules/micromark-core-commonmark": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/micromark-core-commonmark/-/micromark-core-commonmark-2.0.2.tgz", - "integrity": "sha512-FKjQKbxd1cibWMM1P9N+H8TwlgGgSkWZMmfuVucLCHaYqeSvJ0hFeHsIa65pA2nYbes0f8LDHPMrd9X7Ujxg9w==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/micromark-core-commonmark/-/micromark-core-commonmark-2.0.3.tgz", + "integrity": "sha512-RDBrHEMSxVFLg6xvnXmb1Ayr2WzLAWjeSATAoxwKYJV94TeNavgoIdA0a9ytzDSVzBy2YKFK+emCPOEibLeCrg==", "dev": true, "funding": [ { @@ -26423,9 +26389,9 @@ } }, "node_modules/micromark-extension-directive": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/micromark-extension-directive/-/micromark-extension-directive-3.0.2.tgz", - "integrity": "sha512-wjcXHgk+PPdmvR58Le9d7zQYWy+vKEU9Se44p2CrCDPiLr2FMyiT4Fyb5UFKFC66wGB3kPlgD7q3TnoqPS7SZA==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-directive/-/micromark-extension-directive-4.0.0.tgz", + "integrity": "sha512-/C2nqVmXXmiseSSuCdItCMho7ybwwop6RrrRPk0KbOHW21JKoCldC+8rFOaundDoRBUWBnJJcxeA/Kvi34WQXg==", "dev": true, "license": "MIT", "dependencies": { @@ -26481,9 +26447,9 @@ } }, "node_modules/micromark-extension-gfm-table": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/micromark-extension-gfm-table/-/micromark-extension-gfm-table-2.1.0.tgz", - "integrity": "sha512-Ub2ncQv+fwD70/l4ou27b4YzfNaCJOvyX4HxXU15m7mpYY+rjuWzsLIPZHJL253Z643RpbcP1oeIJlQ/SKW67g==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-table/-/micromark-extension-gfm-table-2.1.1.tgz", + "integrity": "sha512-t2OU/dXXioARrC6yWfJ4hqB7rct14e8f7m0cbI5hUmDyyIlwv5vEtooptH8INkbLzOatzKuVbQmAYcbWoyz6Dg==", "dev": true, "license": "MIT", "dependencies": { @@ -26871,9 +26837,9 @@ "license": "MIT" }, "node_modules/micromark-util-types": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-2.0.1.tgz", - "integrity": "sha512-534m2WhVTddrcKVepwmVEVnUAmtrx9bfIjNoQHRqfnvdaHQiFytEhJoTgpWJvDEXCO5gLTQh3wYC1PgOJA4NSQ==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-2.0.2.tgz", + "integrity": "sha512-Yw0ECSpJoViF1qTU4DC6NwtC4aWGt1EkzaQB8KPPyCRR8z9TWeV0HbEFGTO+ZY1wB22zmxnJqhPyTpOVCpeHTA==", "dev": true, "funding": [ { diff --git a/package.json b/package.json index a57d2a293e..93896bddb2 100644 --- a/package.json +++ b/package.json @@ -72,7 +72,7 @@ "karma-spec-reporter": "0.0.36", "karma-webpack": "5.0.1", "lerna": "9.0.0", - "markdownlint-cli2": "0.17.2", + "markdownlint-cli2": "0.19.1", "minimatch": "9.0.5", "mocha": "11.7.5", "nock": "14.0.10", diff --git a/packages/auto-instrumentations-node/README.md b/packages/auto-instrumentations-node/README.md index ba127456b0..356c21c101 100644 --- a/packages/auto-instrumentations-node/README.md +++ b/packages/auto-instrumentations-node/README.md @@ -173,7 +173,7 @@ registerInstrumentations({ - [@opentelemetry/instrumentation-express](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-express) - [@opentelemetry/instrumentation-fastify](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-fastify) (deprecated, default disabled) - This component is **deprecated** in favor of the official instrumentation package [`@fastify/otel`](https://www.npmjs.com/package/@fastify/otel), maintained by the Fastify authors. - - Please see [here](https://github.com/fastify/otel?tab=readme-ov-file#usage) for instructions on how to use `@fastify/otel`. + - Please see [the offical plugin's README.md](https://github.com/fastify/otel?tab=readme-ov-file#usage) for instructions on how to use `@fastify/otel`. - This component will be removed on June 30, 2025 - [@opentelemetry/instrumentation-fs](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-fs) (default disabled) - [@opentelemetry/instrumentation-generic-pool](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-generic-pool) diff --git a/packages/host-metrics/README.md b/packages/host-metrics/README.md index 23bd24417e..047bacfd0b 100644 --- a/packages/host-metrics/README.md +++ b/packages/host-metrics/README.md @@ -42,8 +42,8 @@ hostMetrics.start(); ## Configuration -| Option | Type | Description | -| -------------- | ---------- | ----------- | +| Option | Type | Description | +|----------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `metricGroups` | `string[]` | Optionally specify zero or more groups of metrics to collect. This package can collect many metrics. They are grouped by metric name prefix (see the "Semantic Conventions" section below). If this option is specified, only metrics from the named groups will be collected. For example, `metricGroups: ['process.cpu', 'process.memory']` will limit collection to just those 3 metrics. | ## Semantic Conventions @@ -54,30 +54,30 @@ Ref: [opentelemetry-js/issues/4235](https://github.com/open-telemetry/openteleme Metrics collected: -| Metric | Short Description | -| ----------------------------- | --------------------------------------------------------- | -| **Group `system.cpu`** | | -| `system.cpu.time` | Seconds each logical CPU spent on each mode | -| `system.cpu.utilization` | CPU usage time (0-1) | -| **Group `system.memory`** | | -| `system.memory.usage` | Reports memory in use by state | -| `system.memory.utilization` | Memory usage (0-1) | -| **Group `system.network`** | | -| `system.network.dropped` | Count of packets that are dropped | -| `system.network.errors` | Count of network errors detected | -| `system.network.io` | Network flow direction | -| **Group `process.cpu`** | | -| `process.cpu.time` | Total CPU seconds | -| `process.cpu.utilization` | Difference in process.cpu.time since the last measurement | -| **Group `process.memory`** | | -| `process.memory.usage` | The amount of physical memory in use | +| Metric | Short Description | +|-----------------------------|-----------------------------------------------------------| +| **Group `system.cpu`** | | +| `system.cpu.time` | Seconds each logical CPU spent on each mode | +| `system.cpu.utilization` | CPU usage time (0-1) | +| **Group `system.memory`** | | +| `system.memory.usage` | Reports memory in use by state | +| `system.memory.utilization` | Memory usage (0-1) | +| **Group `system.network`** | | +| `system.network.dropped` | Count of packets that are dropped | +| `system.network.errors` | Count of network errors detected | +| `system.network.io` | Network flow direction | +| **Group `process.cpu`** | | +| `process.cpu.time` | Total CPU seconds | +| `process.cpu.utilization` | Difference in process.cpu.time since the last measurement | +| **Group `process.memory`** | | +| `process.memory.usage` | The amount of physical memory in use | Note: the "Group" names are groupings used by the `metricGroups` configuration option. Attributes collected: | Metric | Short Description | -| --------------------------- | ---------------------------------- | +|-----------------------------|------------------------------------| | `system.cpu.logical_number` | The logical CPU number | | `system.cpu.state` | The state of the CPU | | `system.memory.state` | The memory state | diff --git a/packages/instrumentation-aws-lambda/README.md b/packages/instrumentation-aws-lambda/README.md index 84e96f275b..0ff8480705 100644 --- a/packages/instrumentation-aws-lambda/README.md +++ b/packages/instrumentation-aws-lambda/README.md @@ -50,12 +50,12 @@ In your Lambda function configuration, add or update the `NODE_OPTIONS` environm ## AWS Lambda Instrumentation Options -| Options | Type | Description | -| --- | --- | --- | -| `requestHook` | `RequestHook` (function) | Hook for adding custom attributes before lambda starts handling the request. Receives params: `span, { event, context }` | -| `responseHook` | `ResponseHook` (function) | Hook for adding custom attributes before lambda returns the response. Receives params: `span, { err?, res? }` | -| `eventContextExtractor` | `EventContextExtractor` (function) | Function for providing custom context extractor in order to support different event types that are handled by AWS Lambda (e.g., SQS, CloudWatch, Kinesis, API Gateway). | -| `lambdaHandler` | `string` | By default, this instrumentation automatically determines the Lambda handler function to instrument. This option is used to override that behavior by explicitly specifying the Lambda handler to instrument. See [Specifying the Lambda Handler](#specifying-the-lambda-handler) for additional information. | +| Options | Type | Description | +|-------------------------|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `requestHook` | `RequestHook` (function) | Hook for adding custom attributes before lambda starts handling the request. Receives params: `span, { event, context }` | +| `responseHook` | `ResponseHook` (function) | Hook for adding custom attributes before lambda returns the response. Receives params: `span, { err?, res? }` | +| `eventContextExtractor` | `EventContextExtractor` (function) | Function for providing custom context extractor in order to support different event types that are handled by AWS Lambda (e.g., SQS, CloudWatch, Kinesis, API Gateway). | +| `lambdaHandler` | `string` | By default, this instrumentation automatically determines the Lambda handler function to instrument. This option is used to override that behavior by explicitly specifying the Lambda handler to instrument. See [Specifying the Lambda Handler](#specifying-the-lambda-handler) for additional information. | ### Hooks Usage Example @@ -148,7 +148,7 @@ This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which i Attributes collected: | Attribute | Short Description | -| ------------------ | ------------------------------------------------------------------------- | +|--------------------|---------------------------------------------------------------------------| | `cloud.account.id` | The cloud account ID the resource is assigned to. | | `faas.execution` | The execution ID of the current function execution. | | `faas.id` | The unique ID of the single function that this runtime instance executes. | diff --git a/packages/instrumentation-aws-sdk/README.md b/packages/instrumentation-aws-sdk/README.md index 4b4ca0830a..29ca79b8ec 100644 --- a/packages/instrumentation-aws-sdk/README.md +++ b/packages/instrumentation-aws-sdk/README.md @@ -48,25 +48,25 @@ registerInstrumentations({ aws-sdk instrumentation has few options available to choose from. You can set the following: -| Options | Type | Description | -| ----------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `preRequestHook` | `AwsSdkRequestCustomAttributeFunction` | Hook called before request send, which allow to add custom attributes to span. | -| `responseHook` | `AwsSdkResponseCustomAttributeFunction` | Hook for adding custom attributes when response is received from aws. | -| `exceptionHook` | `AwsSdkExceptionCustomAttributeFunction` | Hook for adding custom attributes when exception is received from aws. | -| `suppressInternalInstrumentation` | `boolean` | Most aws operation use http requests under the hood. Set this to `true` to hide all underlying http spans. | -| `sqsExtractContextPropagationFromPayload` | `boolean` | Will parse and extract context propagation headers from SQS Payload, false by default. [When should it be used?](./doc/sns.md#integration-with-sqs) | -| `dynamoDBStatementSerializer` | `AwsSdkDynamoDBStatementSerializer` | AWS SDK instrumentation will serialize DynamoDB commands to the `db.statement` attribute using the specified function. Defaults to using a serializer that returns `undefined`. | +| Options | Type | Description | +|-------------------------------------------|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `preRequestHook` | `AwsSdkRequestCustomAttributeFunction` | Hook called before request send, which allow to add custom attributes to span. | +| `responseHook` | `AwsSdkResponseCustomAttributeFunction` | Hook for adding custom attributes when response is received from aws. | +| `exceptionHook` | `AwsSdkExceptionCustomAttributeFunction` | Hook for adding custom attributes when exception is received from aws. | +| `suppressInternalInstrumentation` | `boolean` | Most aws operation use http requests under the hood. Set this to `true` to hide all underlying http spans. | +| `sqsExtractContextPropagationFromPayload` | `boolean` | Will parse and extract context propagation headers from SQS Payload, false by default. [When should it be used?](./doc/sns.md#integration-with-sqs) | +| `dynamoDBStatementSerializer` | `AwsSdkDynamoDBStatementSerializer` | AWS SDK instrumentation will serialize DynamoDB commands to the `db.statement` attribute using the specified function. Defaults to using a serializer that returns `undefined`. | ## Span Attributes The instrumentations are collecting the following attributes: -| Attribute Name | Type | Description | Example | -| -------------- | ---- | ----------- | ------- | -| `rpc.system` | string | Always equals "aws-api" | | -| `rpc.method` | string | The name of the operation corresponding to the request, as returned by the AWS SDK. If the SDK does not provide a way to retrieve a name, the name of the command SHOULD be used, removing the suffix `Command` if present, resulting in a PascalCase name with no spaces. | `PutObject` | -| `rpc.service` | string | The name of the service to which a request is made, as returned by the AWS SDK. If the SDK does not provide a away to retrieve a name, the name of the SDK's client interface for a service SHOULD be used, removing the suffix `Client` if present, resulting in a PascalCase name with no spaces. | `S3`, `DynamoDB`, `Route53` | -| `cloud.region` | string | Region name for the request | "eu-west-1" | +| Attribute Name | Type | Description | Example | +|----------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| `rpc.system` | string | Always equals "aws-api" | | +| `rpc.method` | string | The name of the operation corresponding to the request, as returned by the AWS SDK. If the SDK does not provide a way to retrieve a name, the name of the command SHOULD be used, removing the suffix `Command` if present, resulting in a PascalCase name with no spaces. | `PutObject` | +| `rpc.service` | string | The name of the service to which a request is made, as returned by the AWS SDK. If the SDK does not provide a away to retrieve a name, the name of the SDK's client interface for a service SHOULD be used, removing the suffix `Client` if present, resulting in a PascalCase name with no spaces. | `S3`, `DynamoDB`, `Route53` | +| `cloud.region` | string | Region name for the request | "eu-west-1" | ### Custom User Attributes @@ -110,48 +110,48 @@ This package emits telemetry using a mix of Semantic Convention versions. While Attributes collected (this list is currently not exhaustive): -| Attribute | Short Description | Service | -| --------------------------------------------- | ---------------------------------------------------------------------------------------------- | -------- | -| `http.status_code` / `http.response.status_code` | (aws-sdk) HTTP response status code. See "HTTP Semantic Convention migration" note below. | | -| `rpc.method` | The name of the (logical) method being called. | | -| `rpc.service` | The full (logical) name of the service being called. | | -| `rpc.system` | A string identifying the remoting system. | | -| `cloud.region` | The AWS Region where the requested service is being accessed. | | -| `aws.dynamodb.attribute_definitions` | The JSON-serialized value of each item in the `AttributeDefinitions` request field. | dynamodb | -| `aws.dynamodb.consistent_read` | The value of the `ConsistentRead` request parameter. | dynamodb | -| `aws.dynamodb.consumed_capacity` | The JSON-serialized value of each item in the `ConsumedCapacity` response field. | dynamodb | -| `aws.dynamodb.count` | The value of the `Count` response parameter. | dynamodb | -| `aws.dynamodb.exclusive_start_table` | The value of the `ExclusiveStartTableName` request parameter. | dynamodb | -| `aws.dynamodb.global_secondary_index_updates` | The JSON-serialized value of each item in the the `GlobalSecondaryIndexUpdates` request field. | dynamodb | -| `aws.dynamodb.global_secondary_indexes` | The JSON-serialized value of each item of the `GlobalSecondaryIndexes` request field. | dynamodb | -| `aws.dynamodb.index_name` | The value of the `IndexName` request parameter. | dynamodb | -| `aws.dynamodb.item_collection_metrics` | The JSON-serialized value of the `ItemCollectionMetrics` response field. | dynamodb | -| `aws.dynamodb.limit` | The value of the `Limit` request parameter. | dynamodb | -| `aws.dynamodb.local_secondary_indexes` | The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field. | dynamodb | -| `aws.dynamodb.projection` | The value of the `ProjectionExpression` request parameter. | dynamodb | -| `aws.dynamodb.provisioned_read_capacity` | The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. | dynamodb | -| `aws.dynamodb.provisioned_write_capacity` | The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. | dynamodb | -| `aws.dynamodb.scan_forward` | The value of the `ScanIndexForward` request parameter. | dynamodb | -| `aws.dynamodb.scanned_count` | The value of the `ScannedCount` response parameter. | dynamodb | -| `aws.dynamodb.segment` | The value of the `Segment` request parameter. | dynamodb | -| `aws.dynamodb.select` | The value of the `Select` request parameter. | dynamodb | -| `aws.dynamodb.table_count` | The number of items in the `TableNames` response parameter. | dynamodb | -| `aws.dynamodb.table_names` | The keys in the `RequestItems` object field. | dynamodb | -| `aws.dynamodb.total_segments` | The value of the `TotalSegments` request parameter. | dynamodb | -| `db.name` | The name of the database being accessed. | dynamodb | -| `db.operation` | The name of the operation being executed. | dynamodb | -| `db.statement` | The database statement being executed. | dynamodb | -| `db.system` | An identifier for the database management system (DBMS) product being used. | dynamodb | -| `faas.execution` | The execution ID of the current function execution. | lambda | -| `faas.invoked_name` | The name of the invoked function. | lambda | -| `faas.invoked_provider` | The cloud provider of the invoked function. | lambda | -| `faas.invoked_region` | The cloud region of the invoked function. | lambda | -| `messaging.destination` | The message destination name. | sns, sqs | -| `messaging.destination_kind` | The kind of message destination. | sns, sqs | -| `messaging.system` | A string identifying the messaging system. | sns, sqs | -| `messaging.operation` | A string identifying the kind of message consumption. | sqs | -| `messaging.message_id` | A value used by the messaging system as an identifier for the message. | sqs | -| `messaging.url` | The connection string. | sqs | +| Attribute | Short Description | Service | +|--------------------------------------------------|------------------------------------------------------------------------------------------------|----------| +| `http.status_code` / `http.response.status_code` | (aws-sdk) HTTP response status code. See "HTTP Semantic Convention migration" note below. | | +| `rpc.method` | The name of the (logical) method being called. | | +| `rpc.service` | The full (logical) name of the service being called. | | +| `rpc.system` | A string identifying the remoting system. | | +| `cloud.region` | The AWS Region where the requested service is being accessed. | | +| `aws.dynamodb.attribute_definitions` | The JSON-serialized value of each item in the `AttributeDefinitions` request field. | dynamodb | +| `aws.dynamodb.consistent_read` | The value of the `ConsistentRead` request parameter. | dynamodb | +| `aws.dynamodb.consumed_capacity` | The JSON-serialized value of each item in the `ConsumedCapacity` response field. | dynamodb | +| `aws.dynamodb.count` | The value of the `Count` response parameter. | dynamodb | +| `aws.dynamodb.exclusive_start_table` | The value of the `ExclusiveStartTableName` request parameter. | dynamodb | +| `aws.dynamodb.global_secondary_index_updates` | The JSON-serialized value of each item in the the `GlobalSecondaryIndexUpdates` request field. | dynamodb | +| `aws.dynamodb.global_secondary_indexes` | The JSON-serialized value of each item of the `GlobalSecondaryIndexes` request field. | dynamodb | +| `aws.dynamodb.index_name` | The value of the `IndexName` request parameter. | dynamodb | +| `aws.dynamodb.item_collection_metrics` | The JSON-serialized value of the `ItemCollectionMetrics` response field. | dynamodb | +| `aws.dynamodb.limit` | The value of the `Limit` request parameter. | dynamodb | +| `aws.dynamodb.local_secondary_indexes` | The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field. | dynamodb | +| `aws.dynamodb.projection` | The value of the `ProjectionExpression` request parameter. | dynamodb | +| `aws.dynamodb.provisioned_read_capacity` | The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. | dynamodb | +| `aws.dynamodb.provisioned_write_capacity` | The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. | dynamodb | +| `aws.dynamodb.scan_forward` | The value of the `ScanIndexForward` request parameter. | dynamodb | +| `aws.dynamodb.scanned_count` | The value of the `ScannedCount` response parameter. | dynamodb | +| `aws.dynamodb.segment` | The value of the `Segment` request parameter. | dynamodb | +| `aws.dynamodb.select` | The value of the `Select` request parameter. | dynamodb | +| `aws.dynamodb.table_count` | The number of items in the `TableNames` response parameter. | dynamodb | +| `aws.dynamodb.table_names` | The keys in the `RequestItems` object field. | dynamodb | +| `aws.dynamodb.total_segments` | The value of the `TotalSegments` request parameter. | dynamodb | +| `db.name` | The name of the database being accessed. | dynamodb | +| `db.operation` | The name of the operation being executed. | dynamodb | +| `db.statement` | The database statement being executed. | dynamodb | +| `db.system` | An identifier for the database management system (DBMS) product being used. | dynamodb | +| `faas.execution` | The execution ID of the current function execution. | lambda | +| `faas.invoked_name` | The name of the invoked function. | lambda | +| `faas.invoked_provider` | The cloud provider of the invoked function. | lambda | +| `faas.invoked_region` | The cloud region of the invoked function. | lambda | +| `messaging.destination` | The message destination name. | sns, sqs | +| `messaging.destination_kind` | The kind of message destination. | sns, sqs | +| `messaging.system` | A string identifying the messaging system. | sns, sqs | +| `messaging.operation` | A string identifying the kind of message consumption. | sqs | +| `messaging.message_id` | A value used by the messaging system as an identifier for the message. | sqs | +| `messaging.url` | The connection string. | sqs | ### HTTP Semantic Convention migration diff --git a/packages/instrumentation-bunyan/README.md b/packages/instrumentation-bunyan/README.md index a9f70d220e..1a2bfa22f9 100644 --- a/packages/instrumentation-bunyan/README.md +++ b/packages/instrumentation-bunyan/README.md @@ -84,12 +84,12 @@ Log injection can be disabled with the `disableLogCorrelation: true` option. ### Bunyan instrumentation options -| Option | Type | Description | -| ----------------------- | ----------------- | ----------- | -| `disableLogSending` | `boolean` | Whether to disable [log sending](#log-sending). Default `false`. | +| Option | Type | Description | +|-------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `disableLogSending` | `boolean` | Whether to disable [log sending](#log-sending). Default `false`. | | `logSeverity` | `SeverityNumber` | Control severity level for [log sending](#log-sending). Default `SeverityNumber.UNSPECIFIED`, it will use Bunnyan Logger's current level when unspecified. | -| `disableLogCorrelation` | `boolean` | Whether to disable [log correlation](#log-correlation). Default `false`. | -| `logHook` | `LogHookFunction` | An option hook to inject additional context to a log record after trace-context has been added. This requires `disableLogCorrelation` to be false. | +| `disableLogCorrelation` | `boolean` | Whether to disable [log correlation](#log-correlation). Default `false`. | +| `logHook` | `LogHookFunction` | An option hook to inject additional context to a log record after trace-context has been added. This requires `disableLogCorrelation` to be false. | ### Using OpenTelemetryBunyanStream without instrumentation diff --git a/packages/instrumentation-connect/README.md b/packages/instrumentation-connect/README.md index 68ab3b0994..ad24eef8fe 100644 --- a/packages/instrumentation-connect/README.md +++ b/packages/instrumentation-connect/README.md @@ -11,9 +11,9 @@ Compatible with OpenTelemetry JS API and SDK `1.0+`. ## Status -| Maturity | [Component Owner](../../.github/component_owners.yml) | Compatibility | -| ----------------------------------------------------- | -------------------------------------------------------- | --------------------- | -| [Unmaintained](../../CONTRIBUTING.md#unmaintained) | N/A | API 1.0+
SDK 1.0+ | +| Maturity | [Component Owner](../../.github/component_owners.yml) | Compatibility | +|----------------------------------------------------|-------------------------------------------------------|-----------------------| +| [Unmaintained](../../CONTRIBUTING.md#unmaintained) | N/A | API 1.0+
SDK 1.0+ | ## Installation @@ -60,7 +60,7 @@ This package implements Semantic Convention v1.33.1. Attributes collected: | Attribute | Short Description | -| ------------ | ---------------------------------- | +|--------------|------------------------------------| | `http.route` | The matched route (path template). | ## Useful links diff --git a/packages/instrumentation-dns/README.md b/packages/instrumentation-dns/README.md index 5488588426..c5bc59d833 100644 --- a/packages/instrumentation-dns/README.md +++ b/packages/instrumentation-dns/README.md @@ -11,9 +11,9 @@ Compatible with OpenTelemetry JS API and SDK `1.0+`. ## Status -| Maturity | [Component Owner](../../.github/component_owners.yml) | Compatibility | -| ----------------------------------------------------- | -------------------------------------------------------- | --------------------- | -| [Unmaintained](../../CONTRIBUTING.md#unmaintained) | N/A | API 1.0+
SDK 1.0+ | +| Maturity | [Component Owner](../../.github/component_owners.yml) | Compatibility | +|----------------------------------------------------|-------------------------------------------------------|-----------------------| +| [Unmaintained](../../CONTRIBUTING.md#unmaintained) | N/A | API 1.0+
SDK 1.0+ | ## Installation diff --git a/packages/instrumentation-document-load/README.md b/packages/instrumentation-document-load/README.md index 3e0b0c91a1..348ef650d1 100644 --- a/packages/instrumentation-document-load/README.md +++ b/packages/instrumentation-document-load/README.md @@ -117,14 +117,14 @@ See [examples/tracer-web](https://github.com/open-telemetry/opentelemetry-js/tre The document load instrumentation plugin has few options available to choose from. You can set the following: -| Options | Type | Description | -| ------- | ---- | ----------- | -| `applyCustomAttributesOnSpan.documentLoad`| `DocumentLoadCustomAttributeFunction` | Function for adding custom attributes to `documentLoad` spans. | -| `applyCustomAttributesOnSpan.documentFetch` | `DocumentLoadCustomAttributeFunction` | Function for adding custom attributes to `documentFetch` spans. | -| `applyCustomAttributesOnSpan.resourceFetch` | `ResourceFetchCustomAttributeFunction` | Function for adding custom attributes to `resourceFetch` spans | -| `ignoreNetworkEvents` | `boolean` | Ignore adding [network events as span events](https://github.com/open-telemetry/opentelemetry-js/blob/e49c4c7f42c6c444da3f802687cfa4f2d6983f46/packages/opentelemetry-sdk-trace-web/src/enums/PerformanceTimingNames.ts#L17) for document fetch and resource fetch spans. | -| `ignorePerformancePaintEvents` | `boolean` | Ignore adding performance resource paint span events to document load spans. | -| `semconvStabilityOptIn` | string | A comma-separated string of tokens as described for `OTEL_SEMCONV_STABILITY_OPT_IN` in the [HTTP semantic convention stability migration](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/non-normative/http-migration.md) guide. See the "Semantic Conventions" section below. | +| Options | Type | Description | +|---------------------------------------------|----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `applyCustomAttributesOnSpan.documentLoad` | `DocumentLoadCustomAttributeFunction` | Function for adding custom attributes to `documentLoad` spans. | +| `applyCustomAttributesOnSpan.documentFetch` | `DocumentLoadCustomAttributeFunction` | Function for adding custom attributes to `documentFetch` spans. | +| `applyCustomAttributesOnSpan.resourceFetch` | `ResourceFetchCustomAttributeFunction` | Function for adding custom attributes to `resourceFetch` spans | +| `ignoreNetworkEvents` | `boolean` | Ignore adding [network events as span events](https://github.com/open-telemetry/opentelemetry-js/blob/e49c4c7f42c6c444da3f802687cfa4f2d6983f46/packages/opentelemetry-sdk-trace-web/src/enums/PerformanceTimingNames.ts#L17) for document fetch and resource fetch spans. | +| `ignorePerformancePaintEvents` | `boolean` | Ignore adding performance resource paint span events to document load spans. | +| `semconvStabilityOptIn` | string | A comma-separated string of tokens as described for `OTEL_SEMCONV_STABILITY_OPT_IN` in the [HTTP semantic convention stability migration](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/non-normative/http-migration.md) guide. See the "Semantic Conventions" section below. | ## Semantic Conventions @@ -139,9 +139,9 @@ To select which semconv version(s) is emitted from this instrumentation, use the - `http/dup`: emit **both** the old and the new (stable) v1.23.0 semantics - By default, if `semconvStabilityOptIn` includes neither of the above tokens, the old semconv is used. -| v1.7.0 semconv | v1.23.0 semconv | Notes | -| ----------------- | --------------------- | ----- | -| `http.url` | `url.full` | Full HTTP request URL | +| v1.7.0 semconv | v1.23.0 semconv | Notes | +|-------------------|-----------------------|-------------------------------------------------------------------------------------------------------------------------| +| `http.url` | `url.full` | Full HTTP request URL | | `http.user_agent` | `user_agent.original` | Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client. | diff --git a/packages/instrumentation-express/README.md b/packages/instrumentation-express/README.md index fe951f4feb..bcb19f6b54 100644 --- a/packages/instrumentation-express/README.md +++ b/packages/instrumentation-express/README.md @@ -55,12 +55,12 @@ Because of the way express works, it's hard to correctly compute the time taken Express instrumentation has few options available to choose from. You can set the following: -| Options | Type | Example | Description | -| ------- | ---- | ------- | ----------- | -| `ignoreLayers` | `IgnoreMatcher[]` | `[/^\/_internal\//]` | Ignore layers that by match. | -| `ignoreLayersType`| `ExpressLayerType[]` | `['request_handler']` | Ignore layers of specified type. | -| `spanNameHook` | `SpanNameHook` | `() => 'my-span-name'` | Can be used to customize span names by returning a new name from the hook. | -| `requestHook` | `ExpressRequestCustomAttributeFunction (function)` | `(span, info) => {}` | Function for adding custom attributes on Express request. Receives params: `Span, ExpressRequestInfo`. | +| Options | Type | Example | Description | +|--------------------|----------------------------------------------------|------------------------|--------------------------------------------------------------------------------------------------------| +| `ignoreLayers` | `IgnoreMatcher[]` | `[/^\/_internal\//]` | Ignore layers that by match. | +| `ignoreLayersType` | `ExpressLayerType[]` | `['request_handler']` | Ignore layers of specified type. | +| `spanNameHook` | `SpanNameHook` | `() => 'my-span-name'` | Can be used to customize span names by returning a new name from the hook. | +| `requestHook` | `ExpressRequestCustomAttributeFunction (function)` | `(span, info) => {}` | Function for adding custom attributes on Express request. Receives params: `Span, ExpressRequestInfo`. | `ignoreLayers` accepts an array of elements of types: diff --git a/packages/instrumentation-fastify/README.md b/packages/instrumentation-fastify/README.md index 0d88b91baf..735a13c9f1 100644 --- a/packages/instrumentation-fastify/README.md +++ b/packages/instrumentation-fastify/README.md @@ -5,7 +5,7 @@ > [!IMPORTANT] > This component is **deprecated** in favor of the official instrumentation package [`@fastify/otel`](https://www.npmjs.com/package/@fastify/otel), maintained by the Fastify authors. -> Please see [here](https://github.com/fastify/otel?tab=readme-ov-file#usage) for instructions on how to use `@fastify/otel`. +> Please check [the offical Fastify plugin's README.md](https://github.com/fastify/otel?tab=readme-ov-file#usage) for instructions on how to use `@fastify/otel`. > > We will stop publishing new versions of `@opentelemetry/instrumentation-fastify` on June 30, 2025. @@ -53,9 +53,9 @@ See [examples/fastify](https://github.com/open-telemetry/opentelemetry-js-contri ## Fastify Instrumentation Options -| Options | Type | Example | Description | -| -------------- | ---------------------------- | -------------------------------- | ------------------------------------------------------------------------------ | -| `requestHook` | `FastifyCustomAttributeFunction` | `(span, requestInfo) => {}` | Function for adding custom attributes to Fastify requests. Receives parameters: `Span, FastifyRequestInfo`. | +| Options | Type | Example | Description | +|---------------|----------------------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------| +| `requestHook` | `FastifyCustomAttributeFunction` | `(span, requestInfo) => {}` | Function for adding custom attributes to Fastify requests. Receives parameters: `Span, FastifyRequestInfo`. | ### Using `requestHook` @@ -81,7 +81,7 @@ This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which i Attributes collected: | Attribute | Short Description | -| ------------ | ---------------------------------- | +|--------------|------------------------------------| | `http.route` | The matched route (path template). | ## Useful links diff --git a/packages/instrumentation-graphql/README.md b/packages/instrumentation-graphql/README.md index fb1907407a..b5a3f992bd 100644 --- a/packages/instrumentation-graphql/README.md +++ b/packages/instrumentation-graphql/README.md @@ -53,7 +53,7 @@ registerInstrumentations({ ## Optional Parameters | Param | type | Default Value | Description | -|:-------------------------:|:-------------------------------------------:|:-------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +|---------------------------|---------------------------------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | mergeItems | boolean | false | Whether to merge list items into a single element. example: `users.*.name` instead of `users.0.name`, `users.1.name` | | depth | number | -1 | The maximum depth of fields/resolvers to instrument. When set to 0 it will not instrument fields and resolvers. When set to -1 it will instrument all fields and resolvers. | | allowValues | boolean | false | When set to true it will not remove attributes values from schema source. By default all values that can be sensitive are removed and replaced with "*" | @@ -115,7 +115,7 @@ Downstream spans in the context of all resolvers will be child of the first span ## Examples -Can be found [here](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/examples/graphql) +Can be found [in the examples directory](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/examples/graphql) ## Semantic Conventions diff --git a/packages/instrumentation-hapi/README.md b/packages/instrumentation-hapi/README.md index 2ff3ec4d2a..dadaec202b 100644 --- a/packages/instrumentation-hapi/README.md +++ b/packages/instrumentation-hapi/README.md @@ -11,9 +11,9 @@ Compatible with OpenTelemetry JS API and SDK `1.0+`. ## Status -| Maturity | [Component Owner](../../.github/component_owners.yml) | Compatibility | -| ----------------------------------------------------- | -------------------------------------------------------- | --------------------- | -| [Unmaintained](../../CONTRIBUTING.md#unmaintained) | N/A | API 1.0+
SDK 1.0+ | +| Maturity | [Component Owner](../../.github/component_owners.yml) | Compatibility | +|----------------------------------------------------|-------------------------------------------------------|-----------------------| +| [Unmaintained](../../CONTRIBUTING.md#unmaintained) | N/A | API 1.0+
SDK 1.0+ | ## Installation @@ -84,9 +84,9 @@ To select which semconv version(s) is emitted from this instrumentation, use the The following semconv attributes are collected on hapi route spans: -| v1.7.0 semconv | v1.23.0 semconv | Notes | -| -------------- | --------------------- | ----- | -| `http.method` | `http.request.method` | HTTP request method | +| v1.7.0 semconv | v1.23.0 semconv | Notes | +|----------------|-----------------------|---------------------------------------------| +| `http.method` | `http.request.method` | HTTP request method | | `http.route` | `http.route` (same) | Route assigned to handler. Ex: `/users/:id` | ## Useful links diff --git a/packages/instrumentation-kafkajs/README.md b/packages/instrumentation-kafkajs/README.md index 14a239039b..5ee97596f3 100644 --- a/packages/instrumentation-kafkajs/README.md +++ b/packages/instrumentation-kafkajs/README.md @@ -45,7 +45,7 @@ registerInstrumentations({ You can set the following: | Options | Type | Description | -| -------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------- | +|----------------|----------------------------------------|----------------------------------------------------------------------------------------------------------| | `producerHook` | `KafkaProducerCustomAttributeFunction` | Function called before a producer message is sent. Allows for adding custom attributes to the span. | | `consumerHook` | `KafkaConsumerCustomAttributeFunction` | Function called before a consumer message is processed. Allows for adding custom attributes to the span. | @@ -56,7 +56,7 @@ This package uses `@opentelemetry/semantic-conventions` version `1.30+`, which i ### Spans Emitted | KafkaJS Object | Action | Span Kind | Span Name | Operation Type / Name | -| -------------- | -------------------------- | --------- | -------------------------- | --------------------- | +|----------------|----------------------------|-----------|----------------------------|-----------------------| | Consumer | `eachBatch` | Client | `poll ` | `receive` / `poll` | | Consumer | `eachBatch`, `eachMessage` | Consumer | `process ` [1] | `process` / `process` | | Producer | `send` | Producer | `send ` | `send` / `send` | @@ -65,12 +65,12 @@ This package uses `@opentelemetry/semantic-conventions` version `1.30+`, which i ### Metrics Emitted -| KafkaJS Object | Metric Name | Short Description | -| --------------------- | ------------------------------------- | ------------------------------------------------------------ | -| Consumer | `messaging.process.duration` | Duration of processing operation. [1] | -| Consumer | `messaging.client.consumed.messages` | Number of messages that were delivered to the application. | -| Consumer and Producer | `messaging.client.operation.duration` | Number of messages that were delivered to the application. (Only emitted for kafkajs@1.5.0 and later.) | -| Producer | `messaging.client.sent.messages` | Number of messages producer attempted to send to the broker. | +| KafkaJS Object | Metric Name | Short Description | +|-----------------------|---------------------------------------|--------------------------------------------------------------------------------------------------------| +| Consumer | `messaging.process.duration` | Duration of processing operation. [1] | +| Consumer | `messaging.client.consumed.messages` | Number of messages that were delivered to the application. | +| Consumer and Producer | `messaging.client.operation.duration` | Number of messages that were delivered to the application. (Only emitted for kafkajs@1.5.0 and later.) | +| Producer | `messaging.client.sent.messages` | Number of messages producer attempted to send to the broker. | **[1] `messaging.process.duration`:** In the context of `eachBatch`, this metric will be emitted once for each message but the value reflects the duration of the entire batch. @@ -79,7 +79,7 @@ This package uses `@opentelemetry/semantic-conventions` version `1.30+`, which i These attributes are added to both spans and metrics, where possible. | Attribute | Short Description | -| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `messaging.system` | An identifier for the messaging system being used (i.e. `"kafka"`). | | `messaging.destination.name` | The message destination name. | | `messaging.operation.type` | A string identifying the type of messaging operation. | diff --git a/packages/instrumentation-koa/README.md b/packages/instrumentation-koa/README.md index 72a08fa87b..b142fad571 100644 --- a/packages/instrumentation-koa/README.md +++ b/packages/instrumentation-koa/README.md @@ -11,9 +11,9 @@ Compatible with OpenTelemetry JS API and SDK `1.0+`. ## Status -| Maturity | [Component Owner](../../.github/component_owners.yml) | Compatibility | -| ----------------------------------------------------- | -------------------------------------------------------- | --------------------- | -| [Unmaintained](../../CONTRIBUTING.md#unmaintained) | N/A | API 1.0+
SDK 1.0+ | +| Maturity | [Component Owner](../../.github/component_owners.yml) | Compatibility | +|----------------------------------------------------|-------------------------------------------------------|-----------------------| +| [Unmaintained](../../CONTRIBUTING.md#unmaintained) | N/A | API 1.0+
SDK 1.0+ | ## Installation diff --git a/packages/instrumentation-mysql2/README.md b/packages/instrumentation-mysql2/README.md index 59f3089b52..5373601f4d 100644 --- a/packages/instrumentation-mysql2/README.md +++ b/packages/instrumentation-mysql2/README.md @@ -44,12 +44,12 @@ registerInstrumentations({ You can set the following instrumentation options: -| Options | Type | Description | -| ------- | ---- | ----------- | -| `responseHook` | `MySQL2InstrumentationExecutionResponseHook` (function) | Function for adding custom attributes from db response | -| `addSqlCommenterCommentToQueries` | `boolean` | If true, adds [sqlcommenter](https://github.com/open-telemetry/opentelemetry-sqlcommenter) specification compliant comment to queries with tracing context (default false). _NOTE: A comment will not be added to queries that already contain `--` or `/* ... */` in them, even if these are not actually part of comments_ | -| `maskStatement` | `boolean` | If true, masks the `db.statement` attribute in spans (default false) with the `maskStatementHook` | -| `maskStatementHook` | `MySQL2InstrumentationMaskStatementHook` (function) | Function for masking the `db.statement` attribute in spans Default: `return query.replace(/\b\d+\b/g, '?').replac(/(["'])(?:(?=(\\?))\2.)*?\1/g, '?');`| +| Options | Type | Description | +|-----------------------------------|---------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `responseHook` | `MySQL2InstrumentationExecutionResponseHook` (function) | Function for adding custom attributes from db response | +| `addSqlCommenterCommentToQueries` | `boolean` | If true, adds [sqlcommenter](https://github.com/open-telemetry/opentelemetry-sqlcommenter) specification compliant comment to queries with tracing context (default false). _NOTE: A comment will not be added to queries that already contain `--` or `/* ... */` in them, even if these are not actually part of comments_ | +| `maskStatement` | `boolean` | If true, masks the `db.statement` attribute in spans (default false) with the `maskStatementHook` | +| `maskStatementHook` | `MySQL2InstrumentationMaskStatementHook` (function) | Function for masking the `db.statement` attribute in spans Default: `return query.replace(/\b\d+\b/g, '?').replac(/(["'])(?:(?=(\\?))\2.)*?\1/g, '?');` | ## Semantic Conventions @@ -67,16 +67,16 @@ See [the HTTP migration guide](https://opentelemetry.io/docs/specs/semconv/non-n Attributes collected: -| Old semconv | Stable semconv | Description | -| ---------------------- | ---------------- | ----------- | -| `db.connection_string` | Removed | The connection string used to connect to the database. | -| `db.name` | Removed, integrated into the new `db.namespace` | The name of the database. | -| `db.system` | `db.system.name` | 'mysql' | -| `db.statement` | `db.query.text` | The database query being executed. | -| `db.user` | Removed | User used to connect to the database. | -| (not included) | `db.namespace` | The name of the database, fully qualified within the server address and port. | -| `net.peer.port` | `server.port` | Remote port number. | -| `net.peer.name` | `server.address` | Remote hostname or similar. | +| Old semconv | Stable semconv | Description | +|------------------------|-------------------------------------------------|-------------------------------------------------------------------------------| +| `db.connection_string` | Removed | The connection string used to connect to the database. | +| `db.name` | Removed, integrated into the new `db.namespace` | The name of the database. | +| `db.system` | `db.system.name` | 'mysql' | +| `db.statement` | `db.query.text` | The database query being executed. | +| `db.user` | Removed | User used to connect to the database. | +| (not included) | `db.namespace` | The name of the database, fully qualified within the server address and port. | +| `net.peer.port` | `server.port` | Remote port number. | +| `net.peer.name` | `server.address` | Remote hostname or similar. | ## Useful links diff --git a/packages/instrumentation-nestjs-core/README.md b/packages/instrumentation-nestjs-core/README.md index f2f11b84df..c8806c865a 100644 --- a/packages/instrumentation-nestjs-core/README.md +++ b/packages/instrumentation-nestjs-core/README.md @@ -42,11 +42,11 @@ registerInstrumentations({ ## Emitted Spans -| Name | `nestjs.type` | Description | Included attributes | -| ---- | ---- | ---- | ---- | -| `Create Nest App` | `app_creation` | Traces the bootup for the Nest App. The `NestFactory(Static).create` call. | `nestjs.module` | -| `.` | `request_context` | Traces the whole request context. | `http.*`, `nestjs.callback` | -| `` | `handler` | Traces the work of a specific controller member function. | `nestjs.callback` | +| Name | `nestjs.type` | Description | Included attributes | +|---------------------------------|-------------------|----------------------------------------------------------------------------|-----------------------------| +| `Create Nest App` | `app_creation` | Traces the bootup for the Nest App. The `NestFactory(Static).create` call. | `nestjs.module` | +| `.` | `request_context` | Traces the whole request context. | `http.*`, `nestjs.callback` | +| `` | `handler` | Traces the work of a specific controller member function. | `nestjs.callback` | ## Semantic Conventions @@ -54,17 +54,17 @@ This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which i Attributes collected: -| Attribute | Short Description | -| ------------------- | -------------------------------------------------- | -| `component`* | "@nestjs/core" | -| `nestjs.version`* | Version of instrumented `@nestjs/core` package | -| `nestjs.type`* | See [NestType](./src/enums/NestType.ts) | -| `nestjs.module` | Nest module class name | -| `nestjs.controller` | Nest controller class name | -| `nestjs.callback` | The function name of the member in the controller | -| `http.route` | Route assigned to handler. Ex: `/users/:id` | -| `http.method` / `http.request.method` | HTTP method. See "HTTP Semantic Convention migration" note below. | -| `http.url` / `url.full` | Full request URL. See "HTTP Semantic Convention migration" note below. | +| Attribute | Short Description | +|---------------------------------------|------------------------------------------------------------------------| +| `component`* | "@nestjs/core" | +| `nestjs.version`* | Version of instrumented `@nestjs/core` package | +| `nestjs.type`* | See [NestType](./src/enums/NestType.ts) | +| `nestjs.module` | Nest module class name | +| `nestjs.controller` | Nest controller class name | +| `nestjs.callback` | The function name of the member in the controller | +| `http.route` | Route assigned to handler. Ex: `/users/:id` | +| `http.method` / `http.request.method` | HTTP method. See "HTTP Semantic Convention migration" note below. | +| `http.url` / `url.full` | Full request URL. See "HTTP Semantic Convention migration" note below. | \* included in all of the spans. @@ -87,7 +87,7 @@ To select which semconv version(s) is emitted from this instrumentation, use the For this instrumentation, the only impacted attributes are as follows: | v1.7.0 semconv | v1.23.0 semconv | -| -------------- | --------------------- | +|----------------|-----------------------| | `http.method` | `http.request.method` | | `http.url` | `url.full` | diff --git a/packages/instrumentation-pino/README.md b/packages/instrumentation-pino/README.md index bea48d7a11..e609a439fa 100644 --- a/packages/instrumentation-pino/README.md +++ b/packages/instrumentation-pino/README.md @@ -93,11 +93,11 @@ Log injection can be disabled with the `disableLogCorrelation: true` option. ### Pino instrumentation options -| Option | Type | Description | -| ----------------------- | ----------------- | ----------- | -| `disableLogSending` | `boolean` | Whether to disable [log sending](#log-sending). Default `false`. | -| `disableLogCorrelation` | `boolean` | Whether to disable [log correlation](#log-correlation). Default `false`. | -| `logKeys` | record | A record with keys `traceId`, `spanId`, and `traceFlags` string fields giving the field names to use for log-correlation span data. | +| Option | Type | Description | +|-------------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| `disableLogSending` | `boolean` | Whether to disable [log sending](#log-sending). Default `false`. | +| `disableLogCorrelation` | `boolean` | Whether to disable [log correlation](#log-correlation). Default `false`. | +| `logKeys` | record | A record with keys `traceId`, `spanId`, and `traceFlags` string fields giving the field names to use for log-correlation span data. | | `logHook` | `LogHookFunction` | An option hook to inject additional context to a log record after trace-context has been added. This requires `disableLogCorrelation` to be false. | ## Semantic Conventions diff --git a/packages/instrumentation-redis/README.md b/packages/instrumentation-redis/README.md index 7b45cd5b24..57ecfecb45 100644 --- a/packages/instrumentation-redis/README.md +++ b/packages/instrumentation-redis/README.md @@ -47,7 +47,7 @@ See [examples/redis](https://github.com/open-telemetry/opentelemetry-js-contrib/ Redis instrumentation has a few options available to choose from. You can set the following: | Options | Type | Description | -| ----------------------- | ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +|-------------------------|---------------------------------------------------|----------------------------------------------------------------------------------------------------------------| | `dbStatementSerializer` | `DbStatementSerializer` (function) | Redis instrumentation will serialize the command to the `db.statement` attribute using the specified function. | | `responseHook` | `RedisResponseCustomAttributeFunction` (function) | Function for adding custom attributes on db response. Receives params: `span, moduleVersion, cmdName, cmdArgs` | | `requireParentSpan` | `boolean` | Require parent to create redis span, default when unset is false. | @@ -86,7 +86,7 @@ Attributes collected: ### Old Semantic Conventions (default) | Attribute | Short Description | -| ---------------------- | ------------------------------------------------------------ | +|------------------------|--------------------------------------------------------------| | `db.connection_string` | URL to Redis server address, of the form `redis://host:port` | | `db.statement` | Executed Redis statement | | `db.system` | Database identifier; always `redis` | @@ -95,14 +95,14 @@ Attributes collected: ### Stable Semantic Conventions (v1.33.0) -| Attribute | Short Description | -| ---------------------- | ------------------------------------------------------------ | -| `db.operation.name` | Redis command name | +| Attribute | Short Description | +|---------------------------|--------------------------------------------------------| +| `db.operation.name` | Redis command name | | `db.operation.batch.size` | Number of commands in a Redis `MULTI/EXEC` transaction | -| `db.query.text` | The database query being executed | -| `db.system.name` | Database identifier; always `redis` | -| `server.address` | Hostname or IP of the connected Redis server | -| `server.port` | Port of the connected Redis server | +| `db.query.text` | The database query being executed | +| `db.system.name` | Database identifier; always `redis` | +| `server.address` | Hostname or IP of the connected Redis server | +| `server.port` | Port of the connected Redis server | ## Useful links diff --git a/packages/instrumentation-runtime-node/README.md b/packages/instrumentation-runtime-node/README.md index 374f208acb..890269f574 100644 --- a/packages/instrumentation-runtime-node/README.md +++ b/packages/instrumentation-runtime-node/README.md @@ -60,8 +60,8 @@ nodejs_performance_event_loop_utilization 0.010140079547955264 `RuntimeNodeInstrumentation`'s constructor accepts the following options: -| name | type | unit | default | description | -| --- | --- | --- | ------- | --- | +| name | type | unit | default | description | +|---------------------------------------------|-------|-------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`monitoringPrecision`](./src/types.ts#L25) | `int` | millisecond | `10` | The approximate number of milliseconds for which to calculate event loop utilization averages. A larger value will result in more accurate averages at the expense of less granular data. Should be set to below the scrape interval of your metrics collector to avoid duplicated data points. | ## Useful links diff --git a/packages/instrumentation-typeorm/README.md b/packages/instrumentation-typeorm/README.md index 95b8c21674..eb80fb2912 100644 --- a/packages/instrumentation-typeorm/README.md +++ b/packages/instrumentation-typeorm/README.md @@ -42,19 +42,19 @@ registerInstrumentations({ You can set the following: -| Options | Type | Description | -| ---------------------------- | -------------------------------------- | ----------------------------------------------------------------------------- | -| `responseHook` | `TypeormResponseCustomAttributesFunction` | Hook called before response is returned, which allows to add custom attributes to span. | -| `suppressInternalInstrumentation` | boolean | Typeorm uses mongodb/postgres/mysql/mariadb/etc. under the hood. If, for example, postgres instrumentation is enabled, a postgres operation will also create a postgres span describing the communication. Setting the `suppressInternalInstrumentation` config value to `true` will cause the instrumentation to suppress instrumentation of underlying operations. | -| `enableInternalInstrumentation` | boolean | Some methods such as `getManyAndCount` can generate internally multiple spans. To instrument those set this to `true` | -| `enhancedDatabaseReporting` | boolean | set to `true` if you want to capture the parameter values for parameterized SQL queries (**may leak sensitive information**) | +| Options | Type | Description | +|-----------------------------------|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `responseHook` | `TypeormResponseCustomAttributesFunction` | Hook called before response is returned, which allows to add custom attributes to span. | +| `suppressInternalInstrumentation` | boolean | Typeorm uses mongodb/postgres/mysql/mariadb/etc. under the hood. If, for example, postgres instrumentation is enabled, a postgres operation will also create a postgres span describing the communication. Setting the `suppressInternalInstrumentation` config value to `true` will cause the instrumentation to suppress instrumentation of underlying operations. | +| `enableInternalInstrumentation` | boolean | Some methods such as `getManyAndCount` can generate internally multiple spans. To instrument those set this to `true` | +| `enhancedDatabaseReporting` | boolean | set to `true` if you want to capture the parameter values for parameterized SQL queries (**may leak sensitive information**) | ## Semantic Conventions Attributes collected: | Attribute | Short Description | -| -------------------- | --------------------------------------------------------------------------- | +|----------------------|-----------------------------------------------------------------------------| | `db.namespace` | The name of the database being accessed. | | `db.operation.name` | The name of the operation being executed (e.g. the SQL keyword). | | `db.collection.name` | The name of the table being accessed. | diff --git a/packages/instrumentation-undici/README.md b/packages/instrumentation-undici/README.md index cdb30de28b..13eaab2834 100644 --- a/packages/instrumentation-undici/README.md +++ b/packages/instrumentation-undici/README.md @@ -52,8 +52,8 @@ registerInstrumentations({ Undici instrumentation has few options available to choose from. You can set the following: -| Options | Type | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Options | Type | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`ignoreRequestHook`](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/packages/instrumentation-undici/src/types.ts#L73) | `IgnoreRequestFunction` | Undici instrumentation will not trace all incoming requests that matched with custom function. | | [`requestHook`](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/packages/instrumentation-undici/src/types.ts#L75) | `RequestHookFunction` | Function for adding custom attributes before request is handled. | | [`responseHook`](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/packages/instrumentation-undici/src/types.ts#L77) | `ResponseHookFunction` | Function for adding custom attributes after the response headers are received. | @@ -77,7 +77,7 @@ Ref: [opentelemetry-js/issues/4235](https://github.com/open-telemetry/openteleme Attributes collected: | Attribute | Short Description | -| ------------------------------ | ---------------------------------------------------------------------------------------------------------- | +|--------------------------------|------------------------------------------------------------------------------------------------------------| | `error.type` | Describes a class of error the operation ended with. | | `http.request.method` | HTTP request method. | | `http.request.method_original` | Original HTTP method sent by the client in the request line. | diff --git a/packages/instrumentation-winston/README.md b/packages/instrumentation-winston/README.md index 33b031b31f..a2628fa038 100644 --- a/packages/instrumentation-winston/README.md +++ b/packages/instrumentation-winston/README.md @@ -62,12 +62,12 @@ logger.info('foobar'); ### Winston instrumentation options -| Option | Type | Description | -| ----------------------- | ----------------- | ----------- | -| `disableLogSending` | `boolean` | Whether to disable [log sending](#log-sending). Default `false`. | +| Option | Type | Description | +|-------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `disableLogSending` | `boolean` | Whether to disable [log sending](#log-sending). Default `false`. | | `logSeverity` | `SeverityNumber` | Control severity level for [log sending](#log-sending). Default `SeverityNumber.UNSPECIFIED`, it will use Winston Logger's current level when unspecified. | -| `disableLogCorrelation` | `boolean` | Whether to disable [log correlation](#log-correlation). Default `false`. | -| `logHook` | `LogHookFunction` | An option hook to inject additional context to a log record after trace-context has been added. This requires `disableLogCorrelation` to be false. | +| `disableLogCorrelation` | `boolean` | Whether to disable [log correlation](#log-correlation). Default `false`. | +| `logHook` | `LogHookFunction` | An option hook to inject additional context to a log record after trace-context has been added. This requires `disableLogCorrelation` to be false. | ### Log sending diff --git a/packages/plugin-react-load/README.md b/packages/plugin-react-load/README.md index 71fdd29ae0..49029a2ba2 100644 --- a/packages/plugin-react-load/README.md +++ b/packages/plugin-react-load/README.md @@ -11,9 +11,9 @@ Compatible with OpenTelemetry JS API and SDK `1.0+`. ## Status -| Maturity | [Component Owner](../../.github/component_owners.yml) | Compatibility | -| ---------------------------------------- | -------------------------------------------------------- | --------------------- | -| [Unmaintained](../../CONTRIBUTING.md) | N/A | API 1.0+
SDK 1.0+ | +| Maturity | [Component Owner](../../.github/component_owners.yml) | Compatibility | +|---------------------------------------|-------------------------------------------------------|-----------------------| +| [Unmaintained](../../CONTRIBUTING.md) | N/A | API 1.0+
SDK 1.0+ | ## Installation diff --git a/packages/resource-detector-alibaba-cloud/README.md b/packages/resource-detector-alibaba-cloud/README.md index 1d6ac9a9a3..5a5619a791 100644 --- a/packages/resource-detector-alibaba-cloud/README.md +++ b/packages/resource-detector-alibaba-cloud/README.md @@ -32,10 +32,10 @@ This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which i ### Alibaba Cloud Ecs Detector -Populates `cloud` and `host` for processes running on [Alibaba Cloud ECS](https://www.alibabacloud.com/product/ecs). More info about Alibaba Instance Identities can be found [here](https://www.alibabacloud.com/help/en/ecs/user-guide/use-instance-identities). +Populates `cloud` and `host` for processes running on [Alibaba Cloud ECS](https://www.alibabacloud.com/product/ecs). More info about Alibaba Instance Identities can be found [in the Alibaba Cloud documentation](https://www.alibabacloud.com/help/en/ecs/user-guide/use-instance-identities). -| Resource Attribute | Description | -| ----------------------- | --------------------------------------------------------------- | +| Resource Attribute | Description | +|-------------------------|-----------------------------------------------------------------| | cloud.account.id | Value of `owner-account-id` on Alibaba Cloud | | cloud.availability_zone | Value of `zone-id` on Alibaba Cloud | | cloud.platform | In this context, it's always `alibaba_cloud_ecs` | diff --git a/packages/resource-detector-aws/README.md b/packages/resource-detector-aws/README.md index a3071cf91a..c288ea1f93 100644 --- a/packages/resource-detector-aws/README.md +++ b/packages/resource-detector-aws/README.md @@ -9,8 +9,8 @@ Resource detector for Amazon Web Services. ## Status -| Maturity | [Component Owner](../../.github/component_owners.yml) | Compatibility | -| ----------------------------------------- | ----------------------------------------------------- | --------------------- | +| Maturity | [Component Owner](../../.github/component_owners.yml) | Compatibility | +|----------------------------------------|-------------------------------------------------------|-----------------------| | [Stable](../../CONTRIBUTING.md#stable) | @jj22ee | API 1.0+
SDK 1.0+ | ## Installation @@ -40,7 +40,7 @@ This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which i Populates `service` for processes running on [AWS Elastic Beanstalk](https://aws.amazon.com/elasticbeanstalk/) | Resource Attribute | Description | -| ------------------- | ------------------------------------------------------------------------ | +|---------------------|--------------------------------------------------------------------------| | cloud.platform | The cloud platform. In this context, it's always "aws_elastic_beanstalk" | | cloud.provider | The cloud provider. In this context, it's always "aws" | | service.instance.id | Value of `deployment_id` from config file `environment.conf` | @@ -53,7 +53,7 @@ Populates `service` for processes running on [AWS Elastic Beanstalk](https://aws Populates `cloud` and `host` for processes running on [Amazon EC2](https://aws.amazon.com/ec2/), including abstractions such as ECS on EC2. Notably, it does not populate anything on AWS Fargate. | Resource Attribute | Description | -| ----------------------- | ------------------------------------------------------------------------------------- | +|-------------------------|---------------------------------------------------------------------------------------| | cloud.account.id | Value of `accountId` from `/latest/dynamic/instance-identity/document` request | | cloud.availability_zone | Value of `availabilityZone` from `/latest/dynamic/instance-identity/document` request | | cloud.platform | The cloud platform. In this context, it's always "aws_ec2" | @@ -67,26 +67,26 @@ Populates `cloud` and `host` for processes running on [Amazon EC2](https://aws.a Populates `container` for containers running on [Amazon ECS](https://aws.amazon.com/ecs/). -| Resource Attribute | Description | -| ----------------------- | -------------------------------------------------------------------------------------- | -| aws.ecs.container.arn | Value of `ContainerARN` from the request to the metadata Uri. The Metadata Uri is stored on the Environment Variable `ECS_CONTAINER_METADATA_URI_V4` | -| aws.ecs.cluster.arn | Value in the format `${baseArn}:cluster/${cluster}`, with `baseArn` and `cluster` from a `ECS_CONTAINER_METADATA_URI_V4/task` request, with values from `TaskARN` and `Cluster` respectively | -| aws.ecs.launchtype | Value of `LaunchType` from `ECS_CONTAINER_METADATA_URI_V4/task` request | -| aws.ecs.task.arn | Value of `TaskARN` from `ECS_CONTAINER_METADATA_URI_V4/task` request | -| aws.ecs.task.family | Value of `Family` from `ECS_CONTAINER_METADATA_URI_V4/task` request | -| aws.ecs.task.revision | Value of `Revision` from `ECS_CONTAINER_METADATA_URI_V4/task` request | +| Resource Attribute | Description | +|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| aws.ecs.container.arn | Value of `ContainerARN` from the request to the metadata Uri. The Metadata Uri is stored on the Environment Variable `ECS_CONTAINER_METADATA_URI_V4` | +| aws.ecs.cluster.arn | Value in the format `${baseArn}:cluster/${cluster}`, with `baseArn` and `cluster` from a `ECS_CONTAINER_METADATA_URI_V4/task` request, with values from `TaskARN` and `Cluster` respectively | +| aws.ecs.launchtype | Value of `LaunchType` from `ECS_CONTAINER_METADATA_URI_V4/task` request | +| aws.ecs.task.arn | Value of `TaskARN` from `ECS_CONTAINER_METADATA_URI_V4/task` request | +| aws.ecs.task.family | Value of `Family` from `ECS_CONTAINER_METADATA_URI_V4/task` request | +| aws.ecs.task.revision | Value of `Revision` from `ECS_CONTAINER_METADATA_URI_V4/task` request | | aws.log.group.arns | Value on format `arn:aws:logs:${logsRegion}:${awsAccount}:log-group:${logsGroupName}`, with `logsRegions` and `logsGroupName` from logs metadata, values of `awslogs-region` and `awslogs-group` respectively, and `awsAccount` parsed value from the `TaskARN`. Logs metadata values come from `LogOptions` on `ECS_CONTAINER_METADATA_URI_V4` request | -| aws.log.group.names | Value of `awslogs-group` from logs metadata. Logs metadata values come from `LogOptions` on `ECS_CONTAINER_METADATA_URI_V4` request | -| aws.log.stream.arns | Value on format `arn:aws:logs:${logsRegion}:${awsAccount}:log-group:${logsGroupName}:log-stream:${logsStreamName}`, with `logsRegions`, `logsGroupName` and `logsStreamName` from logs metadata, values of `awslogs-region`, `awslogs-group` and `awslogs-stream` respectively, and `awsAccount` parsed value from the `TaskARN` | -| aws.log.stream.names | Value of `awslogs-stream` from logs metadata | -| cloud.account.id | Parsed value from the `TaskARN` | -| cloud.availability_zone | Value of `AvailabilityZone` from `ECS_CONTAINER_METADATA_URI_V4/task` request. This value is not available in all Fargate runtimes | -| cloud.platform | The cloud platform. In this context, it's always "aws_ecs" | -| cloud.provider | The cloud provider. In this context, it's always "aws" | -| cloud.region | Parsed value from the `TaskARN` | -| cloud.resource_id | Value of `ContainerARN` from `ECS_CONTAINER_METADATA_URI_V4/task` request | -| container.id | Value from file `/proc/self/cgroup` | -| container.name | The hostname of the operating system | +| aws.log.group.names | Value of `awslogs-group` from logs metadata. Logs metadata values come from `LogOptions` on `ECS_CONTAINER_METADATA_URI_V4` request | +| aws.log.stream.arns | Value on format `arn:aws:logs:${logsRegion}:${awsAccount}:log-group:${logsGroupName}:log-stream:${logsStreamName}`, with `logsRegions`, `logsGroupName` and `logsStreamName` from logs metadata, values of `awslogs-region`, `awslogs-group` and `awslogs-stream` respectively, and `awsAccount` parsed value from the `TaskARN` | +| aws.log.stream.names | Value of `awslogs-stream` from logs metadata | +| cloud.account.id | Parsed value from the `TaskARN` | +| cloud.availability_zone | Value of `AvailabilityZone` from `ECS_CONTAINER_METADATA_URI_V4/task` request. This value is not available in all Fargate runtimes | +| cloud.platform | The cloud platform. In this context, it's always "aws_ecs" | +| cloud.provider | The cloud provider. In this context, it's always "aws" | +| cloud.region | Parsed value from the `TaskARN` | +| cloud.resource_id | Value of `ContainerARN` from `ECS_CONTAINER_METADATA_URI_V4/task` request | +| container.id | Value from file `/proc/self/cgroup` | +| container.name | The hostname of the operating system | ### AWS EKS Detector @@ -94,7 +94,7 @@ Populates `container` and `k8s.cluster_name` for containers running on [Amazon E `k8s.cluster_name` is not always available depending on the configuration of CloudWatch monitoring for the EKS cluster. | Resource Attribute | Description | -| ------------------ | --------------------------------------------------------------------------------------------------- | +|--------------------|-----------------------------------------------------------------------------------------------------| | cloud.platform | The cloud platform. In this context, it's always "aws_eks" | | cloud.provider | The cloud provider. In this context, it's always "aws" | | container.id | Value from config file `/proc/self/cgroup` | @@ -106,7 +106,7 @@ Populates `faas` and `cloud` for functions running on [AWS Lambda](https://aws.a `faas.id` is currently not populated as it is not provided by the runtime at startup. | Resource Attribute | Description | -| ------------------ | ------------------------------------------------------------------- | +|--------------------|---------------------------------------------------------------------| | cloud.platform | The cloud platform. In this context, it's always "aws_lambda" | | cloud.provider | The cloud provider. In this context, it's always "aws" | | cloud.region | Value of Process Environment Variable `AWS_REGION` | diff --git a/packages/resource-detector-azure/README.md b/packages/resource-detector-azure/README.md index edaf741e6a..8305c8ba60 100644 --- a/packages/resource-detector-azure/README.md +++ b/packages/resource-detector-azure/README.md @@ -31,45 +31,45 @@ This package implements Semantic Convention [Version 1.37.0](https://github.com/ ### App Service Resource Detector -| Resource Attribute | Description | -| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| azure.app.service.stamp | The specific "stamp" cluster within Azure where the App Service is running, e.g., "waws-prod-sn1-001". Value of Process Environment Variable `APP_SERVICE_ATTRIBUTE_ENV_VARS`. | -| cloud.platform | The cloud platform. Here, it's always "azure.app_service". | -| cloud.provider | The cloud service provider. In this context, it's always "azure". | -| cloud.region | The Azure region where the App Service is hosted, e.g., "East US", "West Europe", etc. Value of Process Environment Variable `REGION_NAME`. | -| cloud.resource_id | The Azure Resource Manager URI uniquely identifying the Azure App Service. Typically in the format `/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Web/sites/{siteName}`. | -| deployment.environment.name | The deployment slot where the Azure App Service is running, such as "staging", "production", etc. Value of Process Environment Variable `WEBSITE_SLOT_NAME`. | -| host.id | The primary hostname for the app, excluding any custom hostnames. Value of Process Environment Variable `WEBSITE_HOSTNAME`. | -| service.instance.id | The specific instance of the Azure App Service, useful in a scaled-out configuration. Value of Process Environment Variable `WEBSITE_INSTANCE_ID`. | -| service.name | The name of the Azure App Service. Value of Process Environment Variable `WEBSITE_SITE_NAME`. | +| Resource Attribute | Description | +|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| azure.app.service.stamp | The specific "stamp" cluster within Azure where the App Service is running, e.g., "waws-prod-sn1-001". Value of Process Environment Variable `APP_SERVICE_ATTRIBUTE_ENV_VARS`. | +| cloud.platform | The cloud platform. Here, it's always "azure.app_service". | +| cloud.provider | The cloud service provider. In this context, it's always "azure". | +| cloud.region | The Azure region where the App Service is hosted, e.g., "East US", "West Europe", etc. Value of Process Environment Variable `REGION_NAME`. | +| cloud.resource_id | The Azure Resource Manager URI uniquely identifying the Azure App Service. Typically in the format `/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Web/sites/{siteName}`. | +| deployment.environment.name | The deployment slot where the Azure App Service is running, such as "staging", "production", etc. Value of Process Environment Variable `WEBSITE_SLOT_NAME`. | +| host.id | The primary hostname for the app, excluding any custom hostnames. Value of Process Environment Variable `WEBSITE_HOSTNAME`. | +| service.instance.id | The specific instance of the Azure App Service, useful in a scaled-out configuration. Value of Process Environment Variable `WEBSITE_INSTANCE_ID`. | +| service.name | The name of the Azure App Service. Value of Process Environment Variable `WEBSITE_SITE_NAME`. | ### VM Resource Detector -| Resource Attribute | Description | -| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| azure.vm.scaleset.name | The name of the Virtual Machine Scale Set if the VM is part of one. Value from `vmScaleSetName` key on `/metadata/instance/compute` request. | -| azure.vm.sku | The SKU of the Azure Virtual Machine's operating system. For instance, for a VM running Windows Server 2019 Datacenter edition, this value would be "2019-Datacenter". Value from `sku` key on `/metadata/instance/compute` request. | -| cloud.platform | The cloud platform, which is always set to "azure.vm" in this context. | -| cloud.provider | The cloud service provider, which is always set to "azure" in this context. | -| cloud.region | The Azure region where the Virtual Machine is hosted, such as "East US", "West Europe", etc. Value from `location` key on `/metadata/instance/compute` request. | -| cloud.resource_id | The Azure Resource Manager URI uniquely identifying the Azure Virtual Machine. It typically follows this format: `/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/virtualMachines/{vmName}`. Value from `resourceId` key on `/metadata/instance/compute` request.| -| host.id | A unique identifier for the VM host, for instance, "02aab8a4-74ef-476e-8182-f6d2ba4166a6". Value from `vmId` key on `/metadata/instance/compute` request. | -| host.name | The name of the host machine. Value from `name` key on `/metadata/instance/compute` request. | -| host.type | The size of the VM instance, for example, "Standard_D2s_v3". Value from `vmSize` key on `/metadata/instance/compute` request. | -| os.version | The version of the operating system running on the VM. Value from `version` key on `/metadata/instance/compute` request. | +| Resource Attribute | Description | +|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| azure.vm.scaleset.name | The name of the Virtual Machine Scale Set if the VM is part of one. Value from `vmScaleSetName` key on `/metadata/instance/compute` request. | +| azure.vm.sku | The SKU of the Azure Virtual Machine's operating system. For instance, for a VM running Windows Server 2019 Datacenter edition, this value would be "2019-Datacenter". Value from `sku` key on `/metadata/instance/compute` request. | +| cloud.platform | The cloud platform, which is always set to "azure.vm" in this context. | +| cloud.provider | The cloud service provider, which is always set to "azure" in this context. | +| cloud.region | The Azure region where the Virtual Machine is hosted, such as "East US", "West Europe", etc. Value from `location` key on `/metadata/instance/compute` request. | +| cloud.resource_id | The Azure Resource Manager URI uniquely identifying the Azure Virtual Machine. It typically follows this format: `/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/virtualMachines/{vmName}`. Value from `resourceId` key on `/metadata/instance/compute` request. | +| host.id | A unique identifier for the VM host, for instance, "02aab8a4-74ef-476e-8182-f6d2ba4166a6". Value from `vmId` key on `/metadata/instance/compute` request. | +| host.name | The name of the host machine. Value from `name` key on `/metadata/instance/compute` request. | +| host.type | The size of the VM instance, for example, "Standard_D2s_v3". Value from `vmSize` key on `/metadata/instance/compute` request. | +| os.version | The version of the operating system running on the VM. Value from `version` key on `/metadata/instance/compute` request. | ### Azure Functions Resource Detector -| Resource Attribute | Description | -| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| cloud.platform | The cloud platform. Here, it's always "azure.functions". | -| cloud.provider | The cloud service provider. In this context, it's always "azure". | -| cloud.region | The Azure region where the Azure Function is hosted, e.g., "East US", "West Europe", etc. Value of Process Environment Variable `REGION_NAME`. | -| faas.instance | The specific instance of the Azure App Service, useful in a scaled-out configuration. Value from Process Environment Variable `WEBSITE_INSTANCE_ID`. | -| faas.max_memory | The amount of memory available to the Azure Function expressed in MiB. value from Process Environment Variable `WEBSITE_MEMORY_LIMIT_MB`. | -| service.name | The name of the service the Azure Functions runs within. Value from Process Environment Variable `WEBSITE_SITE_NAME`. | -| cloud.resource_id | The Azure Resource Manager URI uniquely identifying the Azure Virtual Machine. It typically follows this format: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/virtualMachines/{vmName}. Value from resourceId key on /metadata/instance/compute request. | -| process.pid | The process ID collected from the running process. | +| Resource Attribute | Description | +|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| cloud.platform | The cloud platform. Here, it's always "azure.functions". | +| cloud.provider | The cloud service provider. In this context, it's always "azure". | +| cloud.region | The Azure region where the Azure Function is hosted, e.g., "East US", "West Europe", etc. Value of Process Environment Variable `REGION_NAME`. | +| faas.instance | The specific instance of the Azure App Service, useful in a scaled-out configuration. Value from Process Environment Variable `WEBSITE_INSTANCE_ID`. | +| faas.max_memory | The amount of memory available to the Azure Function expressed in MiB. value from Process Environment Variable `WEBSITE_MEMORY_LIMIT_MB`. | +| service.name | The name of the service the Azure Functions runs within. Value from Process Environment Variable `WEBSITE_SITE_NAME`. | +| cloud.resource_id | The Azure Resource Manager URI uniquely identifying the Azure Virtual Machine. It typically follows this format: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/virtualMachines/{vmName}. Value from resourceId key on /metadata/instance/compute request. | +| process.pid | The process ID collected from the running process. | ## Useful links