Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs feedback: prometheus.Receiver -> prometheus.MetricsReceiver #1978

Open
candlerb opened this issue Oct 27, 2024 · 0 comments
Open

Docs feedback: prometheus.Receiver -> prometheus.MetricsReceiver #1978

candlerb opened this issue Oct 27, 2024 · 0 comments
Labels
type/docs Docs Squad label across all Grafana Labs repos

Comments

@candlerb
Copy link

URL

https://grafana.com/docs/alloy/latest/get-started/configuration-syntax/expressions/types_and_values/#capsules

Feedback

At the URL above it says:

If an attribute expects a capsule("prometheus.Receiver"), you can only assign a capsule("prometheus.Receiver") type. The specific type of capsule expected is explicitly documented for any component that uses or exports them.

In the following example, the prometheus.remote_write component exports a receiver, which is a capsule("prometheus.Receiver") type. You can use this capsule in the forward_to attribute of prometheus.scrape, which expects an array of capsule("prometheus.Receiver").

However, elsewhere in the documentation it says that these components consume and export prometheus.MetricsReceiver.

Therefore, I think you should change prometheus.Receiver -> prometheus.MetricsReceiver

@candlerb candlerb added the type/docs Docs Squad label across all Grafana Labs repos label Oct 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

No branches or pull requests

1 participant