You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by "navendu-pottekkat (via GitHub)" <gi...@apache.org> on 2023/01/31 14:26:14 UTC
[GitHub] [apisix-ingress-controller] navendu-pottekkat opened a new pull request, #1635: docs: update Prometheus tutorial
navendu-pottekkat opened a new pull request, #1635:
URL: https://github.com/apache/apisix-ingress-controller/pull/1635
Signed-off-by: Navendu Pottekkat <na...@apache.org>
Updates the tutorial on using Prometheus with Apache APISIX.
--
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-ingress-controller] juzhiyuan commented on a diff in pull request #1635: docs: update Prometheus tutorial
Posted by "juzhiyuan (via GitHub)" <gi...@apache.org>.
juzhiyuan commented on code in PR #1635:
URL: https://github.com/apache/apisix-ingress-controller/pull/1635#discussion_r1092613665
##########
docs/en/latest/tutorials/how-to-access-Apache-APISIX-Prometheus-Metrics-on-k8s.md:
##########
@@ -21,24 +26,21 @@ title: How to access Apache APISIX Prometheus metrics on Kubernetes
#
-->
-Observability (monitoring functionality) has always played an essential role in system maintenance. A sound monitoring system can help engineers quickly understand the status of services running in production environments and locate problems or give early warning of anomalies when they occur.
+This tutorial explains how you can export APISIX metrics in Prometheus format.
-*Prometheus* is a leading open-source project focused on metrics and alerting that has changed the way the world does monitoring and observability. For more information, see *Prometheus*'s official [website](https://prometheus.io/).
+:::note
-## Before you begin
+This tutorial requires APISIX version > 2.13.
-In the APISIX Ingress environment, ensure that the `public-api` and `prometheus` plugins are enabled and the [prometheus pluginAttrs](https://apisix.apache.org/docs/apisix/plugins/prometheus/#specifying-metrics) are configured. Please refer to the following install example:
+:::
-```sh
-helm repo add apisix https://charts.apiseven.com
-helm repo update
-helm install apisix apisix/apisix -f values.yaml --create-namespace -n ingress-apisix
-```
+## Enable the prometheus Plugin
-<details>
- <summary>values.yaml</summary>
+First, you have to enable the [prometheus](https://apisix.apache.org/docs/apisix/plugins/prometheus) Plugin. You can do this by adding to your `values.yaml` file while you install APISIX Ingress via Helm. You can also enable the [public-api](https://apisix.apache.org/docs/apisix/next/plugins/public-api) Plugin to expose these metrics.
Review Comment:
Can we remove the "next" prefix in documentation url?
--
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-ingress-controller] navendu-pottekkat commented on a diff in pull request #1635: docs: update Prometheus tutorial
Posted by "navendu-pottekkat (via GitHub)" <gi...@apache.org>.
navendu-pottekkat commented on code in PR #1635:
URL: https://github.com/apache/apisix-ingress-controller/pull/1635#discussion_r1092825412
##########
docs/en/latest/tutorials/how-to-access-Apache-APISIX-Prometheus-Metrics-on-k8s.md:
##########
@@ -129,16 +131,11 @@ spec:
enable: true
```
-### Step 2: Enable `public-api` Plugin
+## Expose metrics with the public-api Plugin
-Let's make a basic routing setup, and please note that further configuration should be done based on your local backend service information. The primary solution concept is to use the `public-api` plugin to protect the routes exposed by *Prometheus*. For a more detailed configuration, you can refer to the [example](https://apisix.apache.org/docs/apisix/plugins/public-api/#example) section of the `public-api` plugin.
-
-```bash
-kubectl apply -f prometheus-route.yaml -n ingress-apisix
Review Comment:
> Have you tried this tutorial?
Yes. I always try the tutorial/docs pages to make sure that there are no errors or if we need to make any updates.
> If you want to delete this line, please add the description of the specified namespace. Or specify the namespace in yaml.
Yes. Makes sense. Explicitly mentioning the namespace is a good idea. I will add it.
--
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-ingress-controller] AlinsRan commented on a diff in pull request #1635: docs: update Prometheus tutorial
Posted by "AlinsRan (via GitHub)" <gi...@apache.org>.
AlinsRan commented on code in PR #1635:
URL: https://github.com/apache/apisix-ingress-controller/pull/1635#discussion_r1092823271
##########
docs/en/latest/tutorials/how-to-access-Apache-APISIX-Prometheus-Metrics-on-k8s.md:
##########
@@ -129,16 +131,11 @@ spec:
enable: true
```
-### Step 2: Enable `public-api` Plugin
+## Expose metrics with the public-api Plugin
-Let's make a basic routing setup, and please note that further configuration should be done based on your local backend service information. The primary solution concept is to use the `public-api` plugin to protect the routes exposed by *Prometheus*. For a more detailed configuration, you can refer to the [example](https://apisix.apache.org/docs/apisix/plugins/public-api/#example) section of the `public-api` plugin.
-
-```bash
-kubectl apply -f prometheus-route.yaml -n ingress-apisix
Review Comment:
Have you tried this tutorial?
--
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-ingress-controller] navendu-pottekkat commented on a diff in pull request #1635: docs: update Prometheus tutorial
Posted by "navendu-pottekkat (via GitHub)" <gi...@apache.org>.
navendu-pottekkat commented on code in PR #1635:
URL: https://github.com/apache/apisix-ingress-controller/pull/1635#discussion_r1092657023
##########
docs/en/latest/tutorials/how-to-access-Apache-APISIX-Prometheus-Metrics-on-k8s.md:
##########
@@ -21,24 +26,21 @@ title: How to access Apache APISIX Prometheus metrics on Kubernetes
#
-->
-Observability (monitoring functionality) has always played an essential role in system maintenance. A sound monitoring system can help engineers quickly understand the status of services running in production environments and locate problems or give early warning of anomalies when they occur.
+This tutorial explains how you can export APISIX metrics in Prometheus format.
-*Prometheus* is a leading open-source project focused on metrics and alerting that has changed the way the world does monitoring and observability. For more information, see *Prometheus*'s official [website](https://prometheus.io/).
+:::note
-## Before you begin
+This tutorial requires APISIX version > 2.13.
-In the APISIX Ingress environment, ensure that the `public-api` and `prometheus` plugins are enabled and the [prometheus pluginAttrs](https://apisix.apache.org/docs/apisix/plugins/prometheus/#specifying-metrics) are configured. Please refer to the following install example:
+:::
-```sh
-helm repo add apisix https://charts.apiseven.com
-helm repo update
-helm install apisix apisix/apisix -f values.yaml --create-namespace -n ingress-apisix
-```
+## Enable the prometheus Plugin
-<details>
- <summary>values.yaml</summary>
+First, you have to enable the [prometheus](https://apisix.apache.org/docs/apisix/plugins/prometheus) Plugin. You can do this by adding to your `values.yaml` file while you install APISIX Ingress via Helm. You can also enable the [public-api](https://apisix.apache.org/docs/apisix/next/plugins/public-api) Plugin to expose these metrics.
Review Comment:
Yes. I always forget it.
--
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-ingress-controller] AlinsRan commented on a diff in pull request #1635: docs: update Prometheus tutorial
Posted by "AlinsRan (via GitHub)" <gi...@apache.org>.
AlinsRan commented on code in PR #1635:
URL: https://github.com/apache/apisix-ingress-controller/pull/1635#discussion_r1092821153
##########
docs/en/latest/tutorials/how-to-access-Apache-APISIX-Prometheus-Metrics-on-k8s.md:
##########
@@ -129,16 +131,11 @@ spec:
enable: true
```
-### Step 2: Enable `public-api` Plugin
+## Expose metrics with the public-api Plugin
-Let's make a basic routing setup, and please note that further configuration should be done based on your local backend service information. The primary solution concept is to use the `public-api` plugin to protect the routes exposed by *Prometheus*. For a more detailed configuration, you can refer to the [example](https://apisix.apache.org/docs/apisix/plugins/public-api/#example) section of the `public-api` plugin.
-
-```bash
-kubectl apply -f prometheus-route.yaml -n ingress-apisix
Review Comment:
If you want to delete this line, please add the description of the specified namespace. Or specify the namespace in yaml.
--
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-ingress-controller] juzhiyuan merged pull request #1635: docs: update Prometheus tutorial
Posted by "juzhiyuan (via GitHub)" <gi...@apache.org>.
juzhiyuan merged PR #1635:
URL: https://github.com/apache/apisix-ingress-controller/pull/1635
--
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-ingress-controller] navendu-pottekkat commented on a diff in pull request #1635: docs: update Prometheus tutorial
Posted by "navendu-pottekkat (via GitHub)" <gi...@apache.org>.
navendu-pottekkat commented on code in PR #1635:
URL: https://github.com/apache/apisix-ingress-controller/pull/1635#discussion_r1094049497
##########
docs/en/latest/tutorials/how-to-access-Apache-APISIX-Prometheus-Metrics-on-k8s.md:
##########
@@ -129,16 +131,11 @@ spec:
enable: true
```
-### Step 2: Enable `public-api` Plugin
+## Expose metrics with the public-api Plugin
-Let's make a basic routing setup, and please note that further configuration should be done based on your local backend service information. The primary solution concept is to use the `public-api` plugin to protect the routes exposed by *Prometheus*. For a more detailed configuration, you can refer to the [example](https://apisix.apache.org/docs/apisix/plugins/public-api/#example) section of the `public-api` plugin.
-
-```bash
-kubectl apply -f prometheus-route.yaml -n ingress-apisix
Review Comment:
@AlinsRan Is it okay now?
--
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