grafana / alloy

OpenTelemetry Collector distribution with programmable pipelines
https://grafana.com/oss/alloy
Apache License 2.0
1.33k stars 181 forks source link

Officically Document proxy_url support #530

Open metzgertie opened 2 years ago

metzgertie commented 2 years ago

The documentation for the agent is currently out of date and does not mention the support for proxy_url. You'll need to search the supported prometheus drop-in options or the link pointing at it.

https://community.grafana.com/t/grafana-agent-behind-network-firewall-cant-specify-proxy/65044

rfratto commented 2 years ago

Hi, thanks for the report.

Unfortunately it's unclear where proxy_url is supported. Our docs for metrics_config link out to Prometheus for remote_write, which is where the proxy_url field is defined.

This is something we've struggled with historically and are trying to find a good middle ground for: if we're directly exposing Prometheus fields to users, duplicating information is risky because you can become out of date. On the other hand, linking out to information can make it become unclear what is actually supported.

We'll spend some time thinking about what to do about this and improve our documentation.

metzgertie commented 2 years ago

@rfratto Thanks for the answer. I just noticed it because I suddendly needed to setup a agent in a third-party environment with a custom proxy. I'd like to see a clarified stance on proxy support in the agent.

github-actions[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had any activity in the past 30 days. The next time this stale check runs, the stale label will be removed if there is new activity. The issue will be closed in 7 days if there is no new activity. Thank you for your contributions!