grafana / grafana/pyroscope

[DOC] Wrong documentation for NodeJS pull mode.

Open
#2,819 1 comment 0 reactions 0 assignees View on GitHub
documentation type/docs
Dominant language
Go
Stars
11.7k
Forks
802
Avg merge
1d 19h
Merged PRs (30d)
80

Description

### Discussed in https://github.com/grafana/pyroscope/discussions/2477

Originally posted by **brunobastosg** October 2, 2023
Hi, all!

According to the [NodeJS Language SDK documentation](https://grafana.com/docs/pyroscope/latest/configure-client/language-sdks/nodejs/), to use pull mode, I need to add [scrape configuration](https://grafana.com/docs/pyroscope/latest/configure-client/language-sdks/nodejs/#scrape-configuration) to the Pyroscope config file.

However, in the [configuration reference](https://grafana.com/docs/pyroscope/latest/configure-server/reference-configuration-parameters/), there is no mention of a configuration parameter called `scrape-configs`.

I even checked the source code, but couldn't find anything.

Even so, I started Pyroscope with a custom config file with the `scrape-configs` block as instructed. There was no error, but no scraping was being done.

I also checked the [express-pull](https://github.com/grafana/pyroscope/tree/main/examples/nodejs/express-pull) example in the repository, but it uses the Grafana Agent instead of a `scrape-configs` block in the configuration file.

So, is the documentation wrong? Or is this an upcoming feature? Or should I use the Grafana Agent?

Thank you in advance!

Related:
* https://github.com/grafana/pyroscope/issues/3666
* https://github.com/grafana/pyroscope/issues/3646
* https://github.com/grafana/pyroscope/discussions/2477

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.