MetricReader is not bound to a MetricProducer

[Eomm]

What version of OpenTelemetry are you using?

    "@opentelemetry/api": "^1.1.0",
    "@opentelemetry/exporter-prometheus": "^0.28.0",
    "@opentelemetry/host-metrics": "^0.27.1",

What version of Node are you using?

v16.13.0

What did you do?

const { MeterProvider } = require('@opentelemetry/sdk-metrics-base');
const { HostMetrics } = require('@opentelemetry/host-metrics');
const { PrometheusExporter } = require('@opentelemetry/exporter-prometheus');

const exporter = new PrometheusExporter(
  {
    startServer: true
  }, () => {
    console.log('prometheus scrape endpoint: http://localhost:9464/metrics')
  }
)

const meterProvider = new MeterProvider({
  exporter,
  interval: 2000
})

const hostMetrics = new HostMetrics({ meterProvider, name: 'example-host-metrics' })
hostMetrics.start()

const fastify = require('fastify')()
fastify.listen(8080)

What did you expect to see?

Host metrics

What did you see instead?

By reaching the URL: http://localhost:9464/metrics
I get:

# failed to export metrics: Error: MetricReader is not bound to a MetricProducer

Additional context

I was trying to add the HostMetrics to the opentelemetry.NodeSDK component, but unsuccessfully. So I tried the basic example, and I get the same error.

[Eomm]

Digging a bit, I think it relates to #983

[legendecas]

Metrics API is still experimental and we are working to adopt the latest metrics spec changes towards GA. From @opentelemetry/sdk-metrics-base v0.28.0, you'll need to apply the following changes the get the example in the OP working:

const exporter = new PrometheusExporter(
  {
    startServer: true
  }, () => {
    console.log('prometheus scrape endpoint: http://localhost:9464/metrics')
  }
)

const meterProvider = new MeterProvider({
-   exporter,
-   interval: 2000
})

+ meterProvider.addMetricReader(exporter);

And the @opentelemetry/host-metrics that are compatible with sdk-metrics-base v0.28.0 is pending release: #947

[Eomm]

Applying your suggestion leads to:

TypeError: meterProvider.addMetricProvider is not a function

My versions

├─┬ @opentelemetry/[email protected]
│ └── @opentelemetry/[email protected] deduped
├─┬ @opentelemetry/[email protected]
│ └── @opentelemetry/[email protected]
├── @opentelemetry/[email protected]
└─┬ @opentelemetry/[email protected]
  └── @opentelemetry/[email protected] deduped

Should I wait for @opentelemetry/host-metrics v0.28?

[dyladan]

Should I wait for @opentelemetry/host-metrics v0.28?

yes

[Eomm]

Is there any release plan?

[dyladan]

I'm cutting a release today sorry. The release automation failed while we were at kubecon and i'm looking into it

[BakrFlow]

Is there any updates?, I still get the same error even with @opentelemetry/host-metrics v0.28

[Eomm]

I will get the chance to test it by my side on the next days

[github-actions]

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

[dyladan]

@Eomm any update on if this is still an issue?

[Eomm]

Just tried the doc example but same error for me by using node v16.x: https://www.npmjs.com/package/@opentelemetry/host-metrics

Switching to node.js v18.6.0 I get the same:

I wonder if it is an OS issue (I'm using mac os)

Deps:

    "@opentelemetry/api": "^1.2.0",
    "@opentelemetry/exporter-prometheus": "^0.33.0",
    "@opentelemetry/exporter-zipkin": "^1.7.0",
    "@opentelemetry/host-metrics": "^0.30.0",
    "@opentelemetry/instrumentation-dns": "^0.30.0",
    "@opentelemetry/instrumentation-fastify": "^0.29.0",
    "@opentelemetry/instrumentation-http": "^0.33.0",
    "@opentelemetry/instrumentation-mongodb": "^0.32.0",
    "@opentelemetry/sdk-metrics-base": "^0.31.0",
    "@opentelemetry/sdk-node": "^0.33.0",
    "@opentelemetry/semantic-conventions": "^1.7.0",

[legendecas]

Would you mind updating the dependency opentelemetry/sdk-metrics-base with opentelemetry/sdk-metrics v0.33.0? It has been renamed in the recent release. Thank you!

[Eomm]

Sure, but.. the same result.
Am I the only one that is facing this issue?

I have rm -rf node_modules and reinstalled only these packages:

    "@opentelemetry/exporter-prometheus": "^0.33.0",
    "@opentelemetry/host-metrics": "^0.30.0",
    "@opentelemetry/sdk-metrics": "^0.33.0",
    "@opentelemetry/sdk-node": "^0.33.0",

Here the code I'm running:

Click to expand!

const { MeterProvider } = require('@opentelemetry/sdk-metrics')
const { HostMetrics } = require('@opentelemetry/host-metrics')
const { PrometheusExporter } = require('@opentelemetry/exporter-prometheus')

const exporter = new PrometheusExporter(
  {
    startServer: true
  }, () => {
    console.log('prometheus scrape endpoint: http://localhost:9464/metrics')
  }
)

const meterProvider = new MeterProvider({
  exporter,
  interval: 2000
})

const hostMetrics = new HostMetrics({ meterProvider, name: 'example-host-metrics' })
hostMetrics.start()

// const fastify = require('fastify')()
// fastify.listen(8080)
setInterval(() => { console.log('tick') }, 10000)

[legendecas]

Sorry but you have to apply the patch mentioned at #1014 (comment) too.

[Eomm]

Yeah, I did it, but I keep getting the is not a function error and the module is up to date:

$ npm ls @opentelemetry/sdk-metrics       
[email protected] /_experiments/prj
├─┬ @opentelemetry/[email protected]
│ └── @opentelemetry/[email protected] deduped
├─┬ @opentelemetry/[email protected]
│ └── @opentelemetry/[email protected]
├── @opentelemetry/[email protected]
└─┬ @opentelemetry/[email protected]
  └── @opentelemetry/[email protected] deduped

$ node prova.js                    
/_experiments/prj/prova.js:17
meterProvider.addMetricProvider(exporter)
              ^

TypeError: meterProvider.addMetricProvider is not a function
    at Object.<anonymous> (/_experiments/prj/prova.js:17:15)
    at Module._compile (node:internal/modules/cjs/loader:1101:14)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1153:10)
    at Module.load (node:internal/modules/cjs/loader:981:32)
    at Function.Module._load (node:internal/modules/cjs/loader:822:12)
    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)
    at node:internal/main/run_main_module:17:47

[legendecas]

Sorry, it's not addMetricProvider but rather addMetricReader. The code snippet I use is as follows:

const { MeterProvider } = require('@opentelemetry/sdk-metrics');
const { HostMetrics } = require('@opentelemetry/host-metrics');
const { PrometheusExporter } = require('@opentelemetry/exporter-prometheus');

const exporter = new PrometheusExporter(
  {
    startServer: true
  }, () => {
    console.log('prometheus scrape endpoint: http://localhost:9464/metrics')
  }
)

const meterProvider = new MeterProvider()
meterProvider.addMetricReader(exporter)

const hostMetrics = new HostMetrics({ meterProvider, name: 'example-host-metrics' })
hostMetrics.start()

[Eomm]

Thanks, it works!
I should study a but the APIs