You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/07/31 08:27:07 UTC

[GitHub] [apisix] juzhiyuan opened a new issue, #7579: docs: add Prerequisite steps in the Prometheus plugin documentation

juzhiyuan opened a new issue, #7579:
URL: https://github.com/apache/apisix/issues/7579

   ### Current State
   
   ### Background
   
   The Slack user reported that after installing the `apache/apisix` project, only the prometheus functionality doesn't work as expected.
   
   After checking, the main reason is **this documentation[2] doesn't mention we should also install another project - the `Prometheus.`**
   
   Another improvement is Prometheus's default port is 9090, and APISIX's Control API[3] also uses the `9090` port. This will lead to unexpected cases happened.
   
   [1] https://the-asf.slack.com/archives/CUC5MN17A/p1659251120138759
   [2] https://apisix.apache.org/docs/apisix/plugins/prometheus/
   [3] https://apisix.apache.org/docs/apisix/control-api/
   
   ### Desired State
   
   In the Prometheus plugin's documentation:
   
   1. Add the Prerequisite/Note section to tell users: that APISIX and Prometheus are two different components, and we must install both when using this plugin. P.S We could use Docker with an All-in-one solution[1] instead for a quick start.
   2. Highlight: Prometheus's default port (9090) is the same as APISIX's Control API, be careful when using Control API and Prometheus.
   
   In the Control API documentation:
   
   1. How about adding a NOTE section that mentions there will have conflict when using Prometheus together?
   
   cc @bzp2010 to have a confirmation 🙏
   
   [1] https://github.com/apache/apisix-docker
   [2] https://apisix.apache.org/docs/apisix/control-api/


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [apisix] spacewander commented on issue #7579: docs: add Prerequisite steps in the Prometheus plugin documentation

Posted by GitBox <gi...@apache.org>.
spacewander commented on issue #7579:
URL: https://github.com/apache/apisix/issues/7579#issuecomment-1200411839

   > How about adding a NOTE section that mentions there will have conflict when using Prometheus together
   
   I am confused in what case do people need to deploy Prometheus with the gateway in the same machine? It is pretty strange in production env.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [apisix] tzssangglass commented on issue #7579: docs: add Prerequisite steps in the Prometheus plugin documentation

Posted by GitBox <gi...@apache.org>.
tzssangglass commented on issue #7579:
URL: https://github.com/apache/apisix/issues/7579#issuecomment-1200591854

   IMO, I don't think there is a need to resolve the 9090 port conflict issue. Users need to choose the right port for their environment and configure it in config.yaml. Even if the control API is made to avoid 9090, it may conflict with the default port of other services. This is a difference in the user's environment.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [apisix] spacewander commented on issue #7579: docs: add Prerequisite steps in the Prometheus plugin documentation

Posted by GitBox <gi...@apache.org>.
spacewander commented on issue #7579:
URL: https://github.com/apache/apisix/issues/7579#issuecomment-1200418877

   In my opinion, when we doc the port used by the Control API, we already show that if the other services also use the same port in the same network namespace, they can't work together. So there is no need to doc the conflict with the Prometheus's default port, which will make things more complex.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [apisix] juzhiyuan closed issue #7579: docs: add Prerequisite steps in the Prometheus plugin documentation

Posted by GitBox <gi...@apache.org>.
juzhiyuan closed issue #7579: docs: add Prerequisite steps in the Prometheus plugin documentation 
URL: https://github.com/apache/apisix/issues/7579


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org