feat(auto-instrumentations-node)!: disable @opentelemetry/instrumentation-fastify by default

[pichlermarc]

Which problem is this PR solving?

See #2647 - there is now an official instrumentation for fastify that is maintained by the Fastify authors. As such we'll be retiring the instrumentation package in favor of the official instrumentation. This PR drops @opentelemetry/instrumentation-fastify into a default-disabled state.

This PR disables the instrumentation by default.

Temporary Workaround until full removal on March 25, 2025

Important

The below is a temporary workaround for users that want to update, but for whom the disabled @opentelemetry/instrumetnation-fastify is a blocker. Starting March 25, 2025, we will drop @opentelemetry/instrumentation-fastify and you will not be able to enable it like this anymore.

If you use this workaround, we therefore recommend that you migrate to @fastify/otel as soon as possible. Click here to learn how to use the new, official instrumentation package. You can stop using this workaround once you have migrated.

You can still enable @opentelemetry/instrumentation-fastify until it is removed by adding fastify to the comma seperated list in OTEL_NODE_ENABLED_INSTRUMENTATIONS.

If you're using @opentelemetry/auto-instrumentations-node/register without OTEL_NODE_ENABLED_INSTRUMENTATIONS set previously

• set OTEL_NODE_ENABLED_INSTRUMENTATIONS=amqplib,aws-lambda,aws-sdk,bunyan,cassandra-driver,connect,cucumber,dataloader,dns,express,fastify,pool,graphql,grpc,hapi,http,ioredis,kafkajs,knex,koa,memoizer,memcached,instrumentation-mongodb,instrumentation-mongoose,instrumentation-mysql2,instrumentation-mysql,instrumentation-nestjs-core,instrumentation-net,instrumentation-pg,instrumentation-pino,instrumentation-redis,instrumentation-redis-4,instrumentation-restify,instrumentation-router

If you're using getAutoInstrumentationsNode() without an options object that contains @opentelemetry/fastify and without OTEL_NODE_ENABLED_INSTRUMENTATIONS set previously

• set OTEL_NODE_ENABLED_INSTRUMENTATIONS=amqplib,aws-lambda,aws-sdk,bunyan,cassandra-driver,connect,cucumber,dataloader,dns,express,fastify,pool,graphql,grpc,hapi,http,ioredis,kafkajs,knex,koa,memoizer,memcached,instrumentation-mongodb,instrumentation-mongoose,instrumentation-mysql2,instrumentation-mysql,instrumentation-nestjs-core,instrumentation-net,instrumentation-pg,instrumentation-pino,instrumentation-redis,instrumentation-redis-4,instrumentation-restify,instrumentation-router

If you're using getAutoInstrumentationsNode() but you don't want to use environment variables

• change the code to

    getNodeAutoInstrumentations({
      '@opentelemetry/instrumentation-fastify': {
        enabled: true,
      },
    }),

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.79%. Comparing base (e57f3e4) to head (ae3ddef).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2652   +/-   ##
=======================================
  Coverage   90.79%   90.79%           
=======================================
  Files         169      169           
  Lines        8061     8061           
  Branches     1646     1646           
=======================================
  Hits         7319     7319           
  Misses        742      742           

Files with missing lines	Coverage Δ
...tapackages/auto-instrumentations-node/src/utils.ts	98.23% <100.00%> (ø)