chore: add 'lint:semconv-deps'

[trentm]

This adds a lint step that checks that packages in the workspace
are following our "rules" on usage of '@opentelemetry/semantic-conventions'
dep: don't pin it, don't use the 'incubating' entry point.
https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#unstable-semconv

Refs: #2549 (comment)
Refs: open-telemetry/opentelemetry-js#5182

checklist

• merge fix(detector-aws): remove semconv incubating import #2668 and fix(instrumentation-aws-lambda): do not import from semantic-conventions incubating entry-point #2670 first to fix linting errors reported by this new lint step

[trentm]

Currently there is one package that is breaking this rule:

% npm run lint:semconv-deps

> [email protected] lint:semconv-deps
> ./scripts/lint-semconv-deps.mjs

lint-semconv-deps error: package @opentelemetry/instrumentation-aws-lambda (in plugins/node/opentelemetry-instrumentation-aws-lambda) imports "@opentelemetry/semantic-conventions/incubating" but does not *pin* the dependency: `"@opentelemetry/semantic-conventions": "^1.27.0"`

% echo $?
1

I'll update that dep in a commit on this PR.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.40%. Comparing base (58bc158) to head (9fbca7f).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2569   +/-   ##
=======================================
  Coverage   92.40%   92.40%           
=======================================
  Files         171      171           
  Lines        8142     8142           
  Branches     1647     1647           
=======================================
  Hits         7524     7524           
  Misses        618      618           

[trivikr]

Should instrumentation-aws-lambda be removed from commit message since the script is global?

[trentm]

Should instrumentation-aws-lambda be removed from commit message since the script is global?

This includes a change to instrumentation-aws-lambda's package.json#dependencies for which there should be a new version of this package, so I think it should stay. IIRC keeping it in the commit title is what gets the release process to notice that there should be a new version of this package.

[jj22ee]

Approving update to instrumentation-aws-lambda's package.json.

[trentm]

Given the decision here: open-telemetry/opentelemetry-js#5182 (comment)
(and the coming docs for that: open-telemetry/opentelemetry-js#5256), I'll be changing this PR so that the linting breaks if the semconv 'incubating' is used at all in runtime code.

[trentm]

Okay, I've switch over the linting behaviour to the final guidance from open-telemetry/opentelemetry-js#5182 (comment)

In the current repo state there are these lint failures:

% npm run lint:semconv-deps

> [email protected] lint:semconv-deps
> ./scripts/lint-semconv-deps.mjs

lint-semconv-deps error: plugins/node/opentelemetry-instrumentation-aws-lambda/src/instrumentation.ts: uses the 'incubating' entry-point from '@opentelemetry/semantic-conventions', but should not (see https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#unstable-semconv)
lint-semconv-deps error: detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsLambdaDetectorSync.ts: uses the 'incubating' entry-point from '@opentelemetry/semantic-conventions', but should not (see https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#unstable-semconv)
lint-semconv-deps error: detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsEksDetectorSync.ts: uses the 'incubating' entry-point from '@opentelemetry/semantic-conventions', but should not (see https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#unstable-semconv)
lint-semconv-deps error: detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsEcsDetectorSync.ts: uses the 'incubating' entry-point from '@opentelemetry/semantic-conventions', but should not (see https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#unstable-semconv)
lint-semconv-deps error: detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsEc2DetectorSync.ts: uses the 'incubating' entry-point from '@opentelemetry/semantic-conventions', but should not (see https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#unstable-semconv)
lint-semconv-deps error: detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsBeanstalkDetectorSync.ts: uses the 'incubating' entry-point from '@opentelemetry/semantic-conventions', but should not (see https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#unstable-semconv)

Those were added recently in #2642. I'll open a PR to fix those. That one should be merged before this one.

[trentm]

Those were added recently in #2642. I'll open a PR to fix those. That one should be merged before this one.

Ah, Gary beat me to it with: #2668

[trentm]

I'm not sure why I had added the fix(instrumentation-aws-lambda): prefix to this PR before. I think long ago it may have included some fixes to that instruemtnation that have since been pulled out.

[pichlermarc]

thanks 👍