Opentelemetry-js: [ioredis] No traces

[naseemkullah]

Please answer these questions before submitting a bug report.

What version of OpenTelemetry are you using?

0.3.2

What version of Node are you using?

12.x.x

What did you do?

const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
const opentelemetry = require('@opentelemetry/core');
const { NodeTracer } = require('@opentelemetry/node');
const { SimpleSpanProcessor } = require('@opentelemetry/tracing');

const tracer = new NodeTracer();
const exporter = new JaegerExporter({ serviceName: 'redis-tester' });
tracer.addSpanProcessor(new SimpleSpanProcessor(exporter));

// Initialize the tracer
opentelemetry.initGlobalTracer(tracer);

const Redis = require('ioredis');

const redisOptions = {
  host: process.env.REDIS_HOST || 'localhost',
  port: process.env.REDIS_PORT || 6379,
};

const redis = new Redis(redisOptions)
redis.set('test', 'data');

setInterval(async () => {
  const value = await redis.get('test')
  console.log(value);
}, 1000);

What did you expect to see?

traces in Jaeger

What did you see instead?

Nothing

Additional context

output of command:

node index.js
PluginLoader#load: trying loading [email protected]
PluginLoader#load: applying patch to [email protected] using @opentelemetry/plugin-ioredis module
data
data
data
data
data
[...]

Does this have anything to do with no parentSpan existing when redis is called/not called within an http route?

[dyladan]

Even if a plugin starts a span with no parent (e.g. a root span) it should generate a trace. I'll try to reproduce this monday morning.

[dyladan]

@naseemkullah i'm assigning both of us to this since you wrote the plugin.

[OlivierAlbertini]

Is this happens with Zipkin ?

[naseemkullah]

Is this happens with Zipkin ?

Yep!
It's an issue with the ioredis plugin 😞

[dyladan]

@naseemkullah the "supported versions" specifier is ^2.0.0. The current version of ioredis is 4.14.1. Please update the ioredis version specifier and test with 3 and 4.

[dyladan]

https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-plugin-ioredis/src/ioredis.ts#L25

[mayurkale22]

At first glance, looks like supported version for ioredis is ^2.0.0 (https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-plugin-ioredis/src/ioredis.ts#L25) but the installed version is 4.14.1.

[mayurkale22]

@dyladan you beat me by few seconds :)

[naseemkullah]

Thanks for pointing this out. I'm not sure how to test for version 3.x.x and 4.x.x

I've installed versions 2.x.x, 3.x.x and 4.x.x in the plugin folder itself and ran npm run test:local successfully, not sure why that is.

Furthermore, I tried running the example in the ioredis example PR with ioredis 2.x.x but got:

.../open-telemetry/opentelemetry-js/examples/ioredis/index.js:7
const redis = new Redis();
              ^

TypeError: Redis is not a constructor

which I assume has something to do with the redis types package in the plugin? We should probably remove ^2.0.0 as a supported version, I guess?

Finally, I do not know how to test an updated version of the package with versions ^3.0.0 and ^4.0.0 added as supported versions. Please advise.

[naseemkullah]

In any case https://github.com/open-telemetry/opentelemetry-js/pull/671 created

[dyladan]

The tests pass because they do not depend on the plugin loader. The plugin loader is what is preventing the plugin from being loaded when the version specifier doesn't match in a regular application. In the tests, you explicitly enable() the plugin regardless of the version of ioredis installed as a dependency.

I would install ioredis version 3.x.x and 4.x.x in the example and make sure it works as expected, but it seems like the current plugin is actually targeting 4.x.x not 2.x.x anyway.

[naseemkullah]

The tests pass because they do not depend on the plugin loader. The plugin loader is what is preventing the plugin from being loaded when the version specifier doesn't match in a regular application. In the tests, you explicitly enable() the plugin regardless of the version of ioredis installed as a dependency.

Ah I see, thanks for explaining.

I would install ioredis version 3.x.x and 4.x.x in the example and make sure it works as expected, but it seems like the current plugin is actually targeting 4.x.x not 2.x.x anyway.

I've installed 3.x.x and 4.x.x in the example but the plugin does not patch as it does with 2.x.x, which errors out with TypeError: Redis is not a constructor... how does the current plugin target 4.x.x ? I thought it targetted the supportedVersion of 2.x.x

[naseemkullah]

Furthermore, how can I have the example override the ioredis-plugin in npm, with one in my local repo (where I edit the supportedVersions) ? I tried running lerna link but that did not seem to do it

[dyladan]

You don't use link, but actually put the filepath directly in the package.json. So you would have:

{
  dependencies: {
    "@opentelemetry/plugin-ioredis": "../../path/to/plugin"
  }
}

[naseemkullah]

Thanks @dyladan , As for:

const redis = new Redis();
              ^

TypeError: Redis is not a constructor

which appears regardless of ioredis version used by main application, I've tried adding "esModuleInterop": true and then also "allowSyntheticDefaultImports": true to the tscfonfig file which did not seem to help. Any other ideas?

[dyladan]

I think it is probably a simple matter of using the ioredis module incorrectly. If you're changing the ioredis module version, but not the @types/ioredis, then they probably don't match.

[naseemkullah]

I am changing the ioredis version in the main/example app, which does not have @types/ioredis.

@types/ioredis and ioredis in the plugin stay the same (both at latest available versions).

[naseemkullah]

This should be fixed by #714 when merged.