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/09/14 18:25:00 UTC
[GitHub] [apisix] Boburmirzo opened a new pull request, #7921: docs: Add How-to guides section with the first guide
Boburmirzo opened a new pull request, #7921:
URL: https://github.com/apache/apisix/pull/7921
### Description
Added How-To guide section with the first guide for Observe your APIs which shows use cases of observability plugins.
Fixes #7854
### Checklist
- [ ] I have explained the need for this PR and the problem it solves
- [ ] I have explained the changes or the new features added to this PR
- [ ] I have added tests corresponding to this change
- [ ] I have updated the documentation to reflect this change
- [ ] I have verified that this change is backward compatible (If not, please discuss on the [APISIX mailing list](https://github.com/apache/apisix/tree/master#community) first)
<!--
Note
1. Mark the PR as draft until it's ready to be reviewed.
2. Always add/update tests for any changes unless you have a good reason.
3. Always update the documentation to reflect the changes made in the PR.
4. Make a new commit to resolve conversations instead of `push -f`.
5. To resolve merge conflicts, merge master instead of rebasing.
6. Use "request review" to notify the reviewer after making changes.
7. Only a reviewer can mark a conversation as resolved.
-->
--
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] Boburmirzo commented on pull request #7921: docs: Add How-to guides section with the first guide
Posted by GitBox <gi...@apache.org>.
Boburmirzo commented on PR #7921:
URL: https://github.com/apache/apisix/pull/7921#issuecomment-1250344197
@hf400159 One question, do these changes go with the next APISIX release, right?
--
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] SylviaBABY commented on a diff in pull request #7921: docs: Add How-to guides section with the first guide
Posted by GitBox <gi...@apache.org>.
SylviaBABY commented on code in PR #7921:
URL: https://github.com/apache/apisix/pull/7921#discussion_r971729510
##########
docs/en/latest/how-to-guides/observe-your-api.md:
##########
@@ -0,0 +1,251 @@
+---
+title: Observer your APIs
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Observability
+ - Monitor
+ - Plugins
+description: Apache APISIX Observability Plugins and take a look at how to set up these plugins.
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+In this guide, we can leverage the power of some [Apache APISIX](https://apisix.apache.org/) Observability Plugins and take a look at how to set up these plugins, how to use them to understand API behavior, and later solve problems that impact our users.
+
+## API Observability
+
+Nowadays **API Observability** is already a part of every API development as it addresses many problems related to API consistency, reliability, and the ability to quickly iterate on new API features. When you design for full-stack observability, you get everything you need to find issues and catch breaking changes.
+
+API observability can help every team in your organization:
+
+- Sales and growth teams to monitor your API usage, free trials, observe expansion opportunities and ensure that API serves the correct data.
+
+- Engineering teams to monitor and troubleshoot API issues.
+
+- Product teams to understand API usage and business value.
+
+- Security teams to detect and protect from API threats.
+
+
+
+## A central point for observation
+
+We know that **an API gateway** offers a central control point for incoming traffic to a variety of destinations but it can also be a central point for observation as well since it is uniquely qualified to know about all the traffic moving between clients and our service networks.
+
+The core of observability breaks down into _three key areas_: structured logs, metrics, and traces. Let’s break down each pillar of API observability and learn how with Apache APISIX Plugins we can simplify these tasks and provides a solution that you can use to better understand API usage.
+
+
+
+## Prerequisites
+
+Before enabling our plugins we need to install Apache APISIX, create a route, an upstream, and map the route to the upstream. You can simply follow [getting started guide](https://apisix.apache.org/docs/apisix/getting-started) provided on the website.
+
+## Logs
+
+**Logs** are also easy to instrument and trivial steps of API observability, they can be used to inspect API calls in real-time for debugging, auditing, and recording time-stamped events that happened over time. There are several logger plugins Apache APISIX provides such as:
+
+- [http-logger](https://apisix.apache.org/docs/apisix/plugins/http-logger/)
+
+- [skywalking-logger](https://apisix.apache.org/docs/apisix/plugins/skywalking-logger/)
+
+- [tcp-logger](https://apisix.apache.org/docs/apisix/plugins/tcp-logger)
+
+- [kafka-logger](https://apisix.apache.org/docs/apisix/plugins/kafka-logger)
+
+- [rocketmq-logger](https://apisix.apache.org/docs/apisix/plugins/rocketmq-logger)
+
+- [udp-logger](https://apisix.apache.org/docs/apisix/plugins/udp-logger)
+
+- [clickhouse-logger](https://apisix.apache.org/docs/apisix/plugins/clickhouse-logger)
+
+- [error-logger](https://apisix.apache.org/docs/apisix/plugins/error-log-logger)
+
+- [google-cloud-logging](https://apisix.apache.org/docs/apisix/plugins/google-cloud-logging)
+
+And you can see the [full list](https://apisix.apache.org/docs/apisix/plugins/zipkin) on the official website of Apache APISIX. Now for demo purposes, let's choose a simple but mostly used _http-logger_ plugin that is capable of sending API Log data requests to HTTP/HTTPS servers or sends as JSON objects to Monitoring tools. We can assume that a route and an upstream are created. You can learn how to set up them in the **[Getting started with Apache APISIX](https://youtu.be/dUOjJkb61so)** video tutorial. Also, you can find all command-line examples on the GitHub page [apisix-observability-plugins](https://boburmirzo.github.io/apisix-observability-plugins/)
+
+You can generate a mock HTTP server at [mockbin.com](https://mockbin.org/) to record and view the logs. Note that we also bind the route to an upstream (You can refer to this documentation to learn about more [core concepts of Apache APISIX](https://apisix.apache.org/docs/apisix/architecture-design/apisix)).
+
+The following is an example of how to enable the http-logger for a specific route.
+
+```bash
+
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "plugins": {
+ "http-logger": {
+ "uri": "http://mockbin.org/bin/5451b7cd-af27-41b8-8df1-282ffea13a61"
+ }
+ },
+ "upstream_id": "1",
+ "uri": "/get"
+}'
+
+```
+
+> To http-logger plugin settings, your can just put your mock server URI address like below:
+
+```json
+{
+ "uri": "http://mockbin.org/bin/5451b7cd-af27-41b8-8df1-282ffea13a61"
+}
+```
+
+Once we get a successful response from APISIX server, we can send a request to this _get_ endpoint to generate logs.
+
+```bash
Review Comment:
```suggestion
```shell
```
##########
docs/en/latest/how-to-guides/observe-your-api.md:
##########
@@ -0,0 +1,251 @@
+---
+title: Observer your APIs
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Observability
+ - Monitor
+ - Plugins
+description: Apache APISIX Observability Plugins and take a look at how to set up these plugins.
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+In this guide, we can leverage the power of some [Apache APISIX](https://apisix.apache.org/) Observability Plugins and take a look at how to set up these plugins, how to use them to understand API behavior, and later solve problems that impact our users.
+
+## API Observability
+
+Nowadays **API Observability** is already a part of every API development as it addresses many problems related to API consistency, reliability, and the ability to quickly iterate on new API features. When you design for full-stack observability, you get everything you need to find issues and catch breaking changes.
+
+API observability can help every team in your organization:
+
+- Sales and growth teams to monitor your API usage, free trials, observe expansion opportunities and ensure that API serves the correct data.
+
+- Engineering teams to monitor and troubleshoot API issues.
+
+- Product teams to understand API usage and business value.
+
+- Security teams to detect and protect from API threats.
+
+
+
+## A central point for observation
+
+We know that **an API gateway** offers a central control point for incoming traffic to a variety of destinations but it can also be a central point for observation as well since it is uniquely qualified to know about all the traffic moving between clients and our service networks.
+
+The core of observability breaks down into _three key areas_: structured logs, metrics, and traces. Let’s break down each pillar of API observability and learn how with Apache APISIX Plugins we can simplify these tasks and provides a solution that you can use to better understand API usage.
+
+
+
+## Prerequisites
+
+Before enabling our plugins we need to install Apache APISIX, create a route, an upstream, and map the route to the upstream. You can simply follow [getting started guide](https://apisix.apache.org/docs/apisix/getting-started) provided on the website.
+
+## Logs
+
+**Logs** are also easy to instrument and trivial steps of API observability, they can be used to inspect API calls in real-time for debugging, auditing, and recording time-stamped events that happened over time. There are several logger plugins Apache APISIX provides such as:
+
+- [http-logger](https://apisix.apache.org/docs/apisix/plugins/http-logger/)
+
+- [skywalking-logger](https://apisix.apache.org/docs/apisix/plugins/skywalking-logger/)
+
+- [tcp-logger](https://apisix.apache.org/docs/apisix/plugins/tcp-logger)
+
+- [kafka-logger](https://apisix.apache.org/docs/apisix/plugins/kafka-logger)
+
+- [rocketmq-logger](https://apisix.apache.org/docs/apisix/plugins/rocketmq-logger)
+
+- [udp-logger](https://apisix.apache.org/docs/apisix/plugins/udp-logger)
+
+- [clickhouse-logger](https://apisix.apache.org/docs/apisix/plugins/clickhouse-logger)
+
+- [error-logger](https://apisix.apache.org/docs/apisix/plugins/error-log-logger)
+
+- [google-cloud-logging](https://apisix.apache.org/docs/apisix/plugins/google-cloud-logging)
+
+And you can see the [full list](https://apisix.apache.org/docs/apisix/plugins/zipkin) on the official website of Apache APISIX. Now for demo purposes, let's choose a simple but mostly used _http-logger_ plugin that is capable of sending API Log data requests to HTTP/HTTPS servers or sends as JSON objects to Monitoring tools. We can assume that a route and an upstream are created. You can learn how to set up them in the **[Getting started with Apache APISIX](https://youtu.be/dUOjJkb61so)** video tutorial. Also, you can find all command-line examples on the GitHub page [apisix-observability-plugins](https://boburmirzo.github.io/apisix-observability-plugins/)
+
+You can generate a mock HTTP server at [mockbin.com](https://mockbin.org/) to record and view the logs. Note that we also bind the route to an upstream (You can refer to this documentation to learn about more [core concepts of Apache APISIX](https://apisix.apache.org/docs/apisix/architecture-design/apisix)).
+
+The following is an example of how to enable the http-logger for a specific route.
+
+```bash
+
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "plugins": {
+ "http-logger": {
+ "uri": "http://mockbin.org/bin/5451b7cd-af27-41b8-8df1-282ffea13a61"
+ }
+ },
+ "upstream_id": "1",
+ "uri": "/get"
+}'
+
+```
+
+> To http-logger plugin settings, your can just put your mock server URI address like below:
+
+```json
+{
+ "uri": "http://mockbin.org/bin/5451b7cd-af27-41b8-8df1-282ffea13a61"
+}
+```
+
+Once we get a successful response from APISIX server, we can send a request to this _get_ endpoint to generate logs.
+
+```bash
+
+curl -i http://127.0.0.1:9080/get
+
+```
+
+Then if you click and navigate to the following our [mock server link](http://mockbin.org/bin/5451b7cd-af27-41b8-8df1-282ffea13a61/log) some recent logs are sent and we can see them:
+
+
+
+## Metrics
+
+**Metrics** are a numeric representation of data measured over intervals of time. You can also aggregate this data into daily or weekly frequency and run queries against a distributed system like [Elasticsearch](https://www.elastic.co/). Or sometimes based on metrics you trigger alerts to take any action later. Once API metrics are collected, you can track them with metrics tracking tools such as [Prometheus](https://prometheus.io/).
+
+Apache APISIX API Gateway also offers [prometheus-plugin](https://apisix.apache.org/docs/apisix/plugins/prometheus/) to fetch your API metrics and expose them in Prometheus. Behind the scene, Apache APISIX downloads the Grafana dashboard meta, imports it to [Grafana](https://grafana.com/), and fetches real-time metrics from the Prometheus plugin.
+
+Let’s enable prometheus-plugin for our route:
+
+```bash
Review Comment:
```suggestion
```shell
```
##########
docs/en/latest/how-to-guides/observe-your-api.md:
##########
@@ -0,0 +1,251 @@
+---
+title: Observer your APIs
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Observability
+ - Monitor
+ - Plugins
+description: Apache APISIX Observability Plugins and take a look at how to set up these plugins.
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+In this guide, we can leverage the power of some [Apache APISIX](https://apisix.apache.org/) Observability Plugins and take a look at how to set up these plugins, how to use them to understand API behavior, and later solve problems that impact our users.
+
+## API Observability
+
+Nowadays **API Observability** is already a part of every API development as it addresses many problems related to API consistency, reliability, and the ability to quickly iterate on new API features. When you design for full-stack observability, you get everything you need to find issues and catch breaking changes.
+
+API observability can help every team in your organization:
+
+- Sales and growth teams to monitor your API usage, free trials, observe expansion opportunities and ensure that API serves the correct data.
+
+- Engineering teams to monitor and troubleshoot API issues.
+
+- Product teams to understand API usage and business value.
+
+- Security teams to detect and protect from API threats.
+
+
+
+## A central point for observation
+
+We know that **an API gateway** offers a central control point for incoming traffic to a variety of destinations but it can also be a central point for observation as well since it is uniquely qualified to know about all the traffic moving between clients and our service networks.
+
+The core of observability breaks down into _three key areas_: structured logs, metrics, and traces. Let’s break down each pillar of API observability and learn how with Apache APISIX Plugins we can simplify these tasks and provides a solution that you can use to better understand API usage.
+
+
+
+## Prerequisites
+
+Before enabling our plugins we need to install Apache APISIX, create a route, an upstream, and map the route to the upstream. You can simply follow [getting started guide](https://apisix.apache.org/docs/apisix/getting-started) provided on the website.
+
+## Logs
+
+**Logs** are also easy to instrument and trivial steps of API observability, they can be used to inspect API calls in real-time for debugging, auditing, and recording time-stamped events that happened over time. There are several logger plugins Apache APISIX provides such as:
+
+- [http-logger](https://apisix.apache.org/docs/apisix/plugins/http-logger/)
+
+- [skywalking-logger](https://apisix.apache.org/docs/apisix/plugins/skywalking-logger/)
+
+- [tcp-logger](https://apisix.apache.org/docs/apisix/plugins/tcp-logger)
+
+- [kafka-logger](https://apisix.apache.org/docs/apisix/plugins/kafka-logger)
+
+- [rocketmq-logger](https://apisix.apache.org/docs/apisix/plugins/rocketmq-logger)
+
+- [udp-logger](https://apisix.apache.org/docs/apisix/plugins/udp-logger)
+
+- [clickhouse-logger](https://apisix.apache.org/docs/apisix/plugins/clickhouse-logger)
+
+- [error-logger](https://apisix.apache.org/docs/apisix/plugins/error-log-logger)
+
+- [google-cloud-logging](https://apisix.apache.org/docs/apisix/plugins/google-cloud-logging)
+
+And you can see the [full list](https://apisix.apache.org/docs/apisix/plugins/zipkin) on the official website of Apache APISIX. Now for demo purposes, let's choose a simple but mostly used _http-logger_ plugin that is capable of sending API Log data requests to HTTP/HTTPS servers or sends as JSON objects to Monitoring tools. We can assume that a route and an upstream are created. You can learn how to set up them in the **[Getting started with Apache APISIX](https://youtu.be/dUOjJkb61so)** video tutorial. Also, you can find all command-line examples on the GitHub page [apisix-observability-plugins](https://boburmirzo.github.io/apisix-observability-plugins/)
+
+You can generate a mock HTTP server at [mockbin.com](https://mockbin.org/) to record and view the logs. Note that we also bind the route to an upstream (You can refer to this documentation to learn about more [core concepts of Apache APISIX](https://apisix.apache.org/docs/apisix/architecture-design/apisix)).
+
+The following is an example of how to enable the http-logger for a specific route.
+
+```bash
+
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "plugins": {
+ "http-logger": {
+ "uri": "http://mockbin.org/bin/5451b7cd-af27-41b8-8df1-282ffea13a61"
+ }
+ },
+ "upstream_id": "1",
+ "uri": "/get"
+}'
+
+```
+
+> To http-logger plugin settings, your can just put your mock server URI address like below:
+
+```json
+{
+ "uri": "http://mockbin.org/bin/5451b7cd-af27-41b8-8df1-282ffea13a61"
+}
+```
+
+Once we get a successful response from APISIX server, we can send a request to this _get_ endpoint to generate logs.
+
+```bash
+
+curl -i http://127.0.0.1:9080/get
+
+```
+
+Then if you click and navigate to the following our [mock server link](http://mockbin.org/bin/5451b7cd-af27-41b8-8df1-282ffea13a61/log) some recent logs are sent and we can see them:
+
+
+
+## Metrics
+
+**Metrics** are a numeric representation of data measured over intervals of time. You can also aggregate this data into daily or weekly frequency and run queries against a distributed system like [Elasticsearch](https://www.elastic.co/). Or sometimes based on metrics you trigger alerts to take any action later. Once API metrics are collected, you can track them with metrics tracking tools such as [Prometheus](https://prometheus.io/).
+
+Apache APISIX API Gateway also offers [prometheus-plugin](https://apisix.apache.org/docs/apisix/plugins/prometheus/) to fetch your API metrics and expose them in Prometheus. Behind the scene, Apache APISIX downloads the Grafana dashboard meta, imports it to [Grafana](https://grafana.com/), and fetches real-time metrics from the Prometheus plugin.
+
+Let’s enable prometheus-plugin for our route:
+
+```bash
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "uri": "/get",
+ "plugins": {
+ "prometheus": {}
+ },
+ "upstream_id": "1"
+}'
+```
+
+We fetch the metric data from the specified URL `/apisix/prometheus/`metrics.
+
+```bash
+curl -i http://127.0.0.1:9091/apisix/prometheus/metrics
+```
+
+You will get a response with Prometheus metrics something like below:
+
+```text
+HTTP/1.1 200 OK
+Server: openresty
+Content-Type: text/plain; charset=utf-8
+Transfer-Encoding: chunked
+Connection: keep-alive
+
+# HELP apisix_batch_process_entries batch process remaining entries
+# TYPE apisix_batch_process_entries gauge
+apisix_batch_process_entries{name="http logger",route_id="1",server_addr="172.19.0.8"} 0
+# HELP apisix_etcd_modify_indexes Etcd modify index for APISIX keys
+# TYPE apisix_etcd_modify_indexes gauge
+apisix_etcd_modify_indexes{key="consumers"} 17819
+apisix_etcd_modify_indexes{key="global_rules"} 17832
+apisix_etcd_modify_indexes{key="max_modify_index"} 20028
+apisix_etcd_modify_indexes{key="prev_index"} 18963
+apisix_etcd_modify_indexes{key="protos"} 0
+apisix_etcd_modify_indexes{key="routes"} 20028
+...
+```
+
+And we can also check the status of our endpoint at the Prometheus dashboard by pointing to this URL `http://localhost:9090/targets`
+
+
+
+As you can see, Apache APISIX exposed metrics endpoint is upon and running.
+
+Now you can query metrics for `apisix_http_status` to see what HTTP requests are handled by API Gateway and what was the outcome.
+
+
+
+In addition to this, you can view the Grafana dashboard running in your local instance. Go to `http://localhost:3000/`
+
+
+
+You can also check two other plugins for metrics:
+
+- [Node status Plugin](https://apisix.apache.org/docs/apisix/plugins/node-status/)
+
+- [Datadog Plugin](https://apisix.apache.org/docs/apisix/plugins/opentelemetry)
+
+## Tracing
+
+The third is **tracing** or distributed tracing allows you to understand the life of a request as it traverses your service network and allows you to answer questions like what service has this request touched and how much latency was introduced. Traces enable you to further explore which logs to look at for a particular session or related set of API calls.
+
+[Zipkin](https://zipkin.io/) an open-source distributed tracing system. [APISIX plugin](https://apisix.apache.org/docs/apisix/plugins/zipkin) is supported to collect tracing and report to Zipkin Collector based on [Zipkin API specification](https://zipkin.io/pages/instrumenting.html).
+
+Here’s an example to enable the _zipkin plugin_ on the specified route:
+
+```bash
Review Comment:
```suggestion
```shell
```
##########
docs/en/latest/how-to-guides/observe-your-api.md:
##########
@@ -0,0 +1,251 @@
+---
+title: Observer your APIs
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Observability
+ - Monitor
+ - Plugins
+description: Apache APISIX Observability Plugins and take a look at how to set up these plugins.
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+In this guide, we can leverage the power of some [Apache APISIX](https://apisix.apache.org/) Observability Plugins and take a look at how to set up these plugins, how to use them to understand API behavior, and later solve problems that impact our users.
+
+## API Observability
+
+Nowadays **API Observability** is already a part of every API development as it addresses many problems related to API consistency, reliability, and the ability to quickly iterate on new API features. When you design for full-stack observability, you get everything you need to find issues and catch breaking changes.
+
+API observability can help every team in your organization:
+
+- Sales and growth teams to monitor your API usage, free trials, observe expansion opportunities and ensure that API serves the correct data.
+
+- Engineering teams to monitor and troubleshoot API issues.
+
+- Product teams to understand API usage and business value.
+
+- Security teams to detect and protect from API threats.
+
+
+
+## A central point for observation
+
+We know that **an API gateway** offers a central control point for incoming traffic to a variety of destinations but it can also be a central point for observation as well since it is uniquely qualified to know about all the traffic moving between clients and our service networks.
+
+The core of observability breaks down into _three key areas_: structured logs, metrics, and traces. Let’s break down each pillar of API observability and learn how with Apache APISIX Plugins we can simplify these tasks and provides a solution that you can use to better understand API usage.
+
+
+
+## Prerequisites
+
+Before enabling our plugins we need to install Apache APISIX, create a route, an upstream, and map the route to the upstream. You can simply follow [getting started guide](https://apisix.apache.org/docs/apisix/getting-started) provided on the website.
+
+## Logs
+
+**Logs** are also easy to instrument and trivial steps of API observability, they can be used to inspect API calls in real-time for debugging, auditing, and recording time-stamped events that happened over time. There are several logger plugins Apache APISIX provides such as:
+
+- [http-logger](https://apisix.apache.org/docs/apisix/plugins/http-logger/)
+
+- [skywalking-logger](https://apisix.apache.org/docs/apisix/plugins/skywalking-logger/)
+
+- [tcp-logger](https://apisix.apache.org/docs/apisix/plugins/tcp-logger)
+
+- [kafka-logger](https://apisix.apache.org/docs/apisix/plugins/kafka-logger)
+
+- [rocketmq-logger](https://apisix.apache.org/docs/apisix/plugins/rocketmq-logger)
+
+- [udp-logger](https://apisix.apache.org/docs/apisix/plugins/udp-logger)
+
+- [clickhouse-logger](https://apisix.apache.org/docs/apisix/plugins/clickhouse-logger)
+
+- [error-logger](https://apisix.apache.org/docs/apisix/plugins/error-log-logger)
+
+- [google-cloud-logging](https://apisix.apache.org/docs/apisix/plugins/google-cloud-logging)
+
+And you can see the [full list](https://apisix.apache.org/docs/apisix/plugins/zipkin) on the official website of Apache APISIX. Now for demo purposes, let's choose a simple but mostly used _http-logger_ plugin that is capable of sending API Log data requests to HTTP/HTTPS servers or sends as JSON objects to Monitoring tools. We can assume that a route and an upstream are created. You can learn how to set up them in the **[Getting started with Apache APISIX](https://youtu.be/dUOjJkb61so)** video tutorial. Also, you can find all command-line examples on the GitHub page [apisix-observability-plugins](https://boburmirzo.github.io/apisix-observability-plugins/)
+
+You can generate a mock HTTP server at [mockbin.com](https://mockbin.org/) to record and view the logs. Note that we also bind the route to an upstream (You can refer to this documentation to learn about more [core concepts of Apache APISIX](https://apisix.apache.org/docs/apisix/architecture-design/apisix)).
+
+The following is an example of how to enable the http-logger for a specific route.
+
+```bash
Review Comment:
```suggestion
```shell
```
##########
docs/en/latest/how-to-guides/observe-your-api.md:
##########
@@ -0,0 +1,251 @@
+---
+title: Observer your APIs
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Observability
+ - Monitor
+ - Plugins
+description: Apache APISIX Observability Plugins and take a look at how to set up these plugins.
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+In this guide, we can leverage the power of some [Apache APISIX](https://apisix.apache.org/) Observability Plugins and take a look at how to set up these plugins, how to use them to understand API behavior, and later solve problems that impact our users.
+
+## API Observability
+
+Nowadays **API Observability** is already a part of every API development as it addresses many problems related to API consistency, reliability, and the ability to quickly iterate on new API features. When you design for full-stack observability, you get everything you need to find issues and catch breaking changes.
+
+API observability can help every team in your organization:
+
+- Sales and growth teams to monitor your API usage, free trials, observe expansion opportunities and ensure that API serves the correct data.
+
+- Engineering teams to monitor and troubleshoot API issues.
+
+- Product teams to understand API usage and business value.
+
+- Security teams to detect and protect from API threats.
+
+
+
+## A central point for observation
+
+We know that **an API gateway** offers a central control point for incoming traffic to a variety of destinations but it can also be a central point for observation as well since it is uniquely qualified to know about all the traffic moving between clients and our service networks.
+
+The core of observability breaks down into _three key areas_: structured logs, metrics, and traces. Let’s break down each pillar of API observability and learn how with Apache APISIX Plugins we can simplify these tasks and provides a solution that you can use to better understand API usage.
+
+
+
+## Prerequisites
+
+Before enabling our plugins we need to install Apache APISIX, create a route, an upstream, and map the route to the upstream. You can simply follow [getting started guide](https://apisix.apache.org/docs/apisix/getting-started) provided on the website.
+
+## Logs
+
+**Logs** are also easy to instrument and trivial steps of API observability, they can be used to inspect API calls in real-time for debugging, auditing, and recording time-stamped events that happened over time. There are several logger plugins Apache APISIX provides such as:
+
+- [http-logger](https://apisix.apache.org/docs/apisix/plugins/http-logger/)
+
+- [skywalking-logger](https://apisix.apache.org/docs/apisix/plugins/skywalking-logger/)
+
+- [tcp-logger](https://apisix.apache.org/docs/apisix/plugins/tcp-logger)
+
+- [kafka-logger](https://apisix.apache.org/docs/apisix/plugins/kafka-logger)
+
+- [rocketmq-logger](https://apisix.apache.org/docs/apisix/plugins/rocketmq-logger)
+
+- [udp-logger](https://apisix.apache.org/docs/apisix/plugins/udp-logger)
+
+- [clickhouse-logger](https://apisix.apache.org/docs/apisix/plugins/clickhouse-logger)
+
+- [error-logger](https://apisix.apache.org/docs/apisix/plugins/error-log-logger)
+
+- [google-cloud-logging](https://apisix.apache.org/docs/apisix/plugins/google-cloud-logging)
+
+And you can see the [full list](https://apisix.apache.org/docs/apisix/plugins/zipkin) on the official website of Apache APISIX. Now for demo purposes, let's choose a simple but mostly used _http-logger_ plugin that is capable of sending API Log data requests to HTTP/HTTPS servers or sends as JSON objects to Monitoring tools. We can assume that a route and an upstream are created. You can learn how to set up them in the **[Getting started with Apache APISIX](https://youtu.be/dUOjJkb61so)** video tutorial. Also, you can find all command-line examples on the GitHub page [apisix-observability-plugins](https://boburmirzo.github.io/apisix-observability-plugins/)
+
+You can generate a mock HTTP server at [mockbin.com](https://mockbin.org/) to record and view the logs. Note that we also bind the route to an upstream (You can refer to this documentation to learn about more [core concepts of Apache APISIX](https://apisix.apache.org/docs/apisix/architecture-design/apisix)).
+
+The following is an example of how to enable the http-logger for a specific route.
+
+```bash
+
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "plugins": {
+ "http-logger": {
+ "uri": "http://mockbin.org/bin/5451b7cd-af27-41b8-8df1-282ffea13a61"
+ }
+ },
+ "upstream_id": "1",
+ "uri": "/get"
+}'
+
+```
+
+> To http-logger plugin settings, your can just put your mock server URI address like below:
+
+```json
+{
+ "uri": "http://mockbin.org/bin/5451b7cd-af27-41b8-8df1-282ffea13a61"
+}
+```
+
+Once we get a successful response from APISIX server, we can send a request to this _get_ endpoint to generate logs.
+
+```bash
+
+curl -i http://127.0.0.1:9080/get
+
+```
+
+Then if you click and navigate to the following our [mock server link](http://mockbin.org/bin/5451b7cd-af27-41b8-8df1-282ffea13a61/log) some recent logs are sent and we can see them:
+
+
+
+## Metrics
+
+**Metrics** are a numeric representation of data measured over intervals of time. You can also aggregate this data into daily or weekly frequency and run queries against a distributed system like [Elasticsearch](https://www.elastic.co/). Or sometimes based on metrics you trigger alerts to take any action later. Once API metrics are collected, you can track them with metrics tracking tools such as [Prometheus](https://prometheus.io/).
+
+Apache APISIX API Gateway also offers [prometheus-plugin](https://apisix.apache.org/docs/apisix/plugins/prometheus/) to fetch your API metrics and expose them in Prometheus. Behind the scene, Apache APISIX downloads the Grafana dashboard meta, imports it to [Grafana](https://grafana.com/), and fetches real-time metrics from the Prometheus plugin.
+
+Let’s enable prometheus-plugin for our route:
+
+```bash
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "uri": "/get",
+ "plugins": {
+ "prometheus": {}
+ },
+ "upstream_id": "1"
+}'
+```
+
+We fetch the metric data from the specified URL `/apisix/prometheus/`metrics.
+
+```bash
Review Comment:
```suggestion
```shell
```
##########
docs/en/latest/how-to-guides/observe-your-api.md:
##########
@@ -0,0 +1,251 @@
+---
+title: Observer your APIs
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Observability
+ - Monitor
+ - Plugins
+description: Apache APISIX Observability Plugins and take a look at how to set up these plugins.
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+In this guide, we can leverage the power of some [Apache APISIX](https://apisix.apache.org/) Observability Plugins and take a look at how to set up these plugins, how to use them to understand API behavior, and later solve problems that impact our users.
+
+## API Observability
+
+Nowadays **API Observability** is already a part of every API development as it addresses many problems related to API consistency, reliability, and the ability to quickly iterate on new API features. When you design for full-stack observability, you get everything you need to find issues and catch breaking changes.
+
+API observability can help every team in your organization:
+
+- Sales and growth teams to monitor your API usage, free trials, observe expansion opportunities and ensure that API serves the correct data.
+
+- Engineering teams to monitor and troubleshoot API issues.
+
+- Product teams to understand API usage and business value.
+
+- Security teams to detect and protect from API threats.
+
+
+
+## A central point for observation
+
+We know that **an API gateway** offers a central control point for incoming traffic to a variety of destinations but it can also be a central point for observation as well since it is uniquely qualified to know about all the traffic moving between clients and our service networks.
+
+The core of observability breaks down into _three key areas_: structured logs, metrics, and traces. Let’s break down each pillar of API observability and learn how with Apache APISIX Plugins we can simplify these tasks and provides a solution that you can use to better understand API usage.
+
+
+
+## Prerequisites
+
+Before enabling our plugins we need to install Apache APISIX, create a route, an upstream, and map the route to the upstream. You can simply follow [getting started guide](https://apisix.apache.org/docs/apisix/getting-started) provided on the website.
+
+## Logs
+
+**Logs** are also easy to instrument and trivial steps of API observability, they can be used to inspect API calls in real-time for debugging, auditing, and recording time-stamped events that happened over time. There are several logger plugins Apache APISIX provides such as:
+
+- [http-logger](https://apisix.apache.org/docs/apisix/plugins/http-logger/)
+
+- [skywalking-logger](https://apisix.apache.org/docs/apisix/plugins/skywalking-logger/)
+
+- [tcp-logger](https://apisix.apache.org/docs/apisix/plugins/tcp-logger)
+
+- [kafka-logger](https://apisix.apache.org/docs/apisix/plugins/kafka-logger)
+
+- [rocketmq-logger](https://apisix.apache.org/docs/apisix/plugins/rocketmq-logger)
+
+- [udp-logger](https://apisix.apache.org/docs/apisix/plugins/udp-logger)
+
+- [clickhouse-logger](https://apisix.apache.org/docs/apisix/plugins/clickhouse-logger)
+
+- [error-logger](https://apisix.apache.org/docs/apisix/plugins/error-log-logger)
+
+- [google-cloud-logging](https://apisix.apache.org/docs/apisix/plugins/google-cloud-logging)
+
+And you can see the [full list](https://apisix.apache.org/docs/apisix/plugins/zipkin) on the official website of Apache APISIX. Now for demo purposes, let's choose a simple but mostly used _http-logger_ plugin that is capable of sending API Log data requests to HTTP/HTTPS servers or sends as JSON objects to Monitoring tools. We can assume that a route and an upstream are created. You can learn how to set up them in the **[Getting started with Apache APISIX](https://youtu.be/dUOjJkb61so)** video tutorial. Also, you can find all command-line examples on the GitHub page [apisix-observability-plugins](https://boburmirzo.github.io/apisix-observability-plugins/)
+
+You can generate a mock HTTP server at [mockbin.com](https://mockbin.org/) to record and view the logs. Note that we also bind the route to an upstream (You can refer to this documentation to learn about more [core concepts of Apache APISIX](https://apisix.apache.org/docs/apisix/architecture-design/apisix)).
+
+The following is an example of how to enable the http-logger for a specific route.
+
+```bash
+
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "plugins": {
+ "http-logger": {
+ "uri": "http://mockbin.org/bin/5451b7cd-af27-41b8-8df1-282ffea13a61"
+ }
+ },
+ "upstream_id": "1",
+ "uri": "/get"
+}'
+
+```
+
+> To http-logger plugin settings, your can just put your mock server URI address like below:
+
+```json
+{
+ "uri": "http://mockbin.org/bin/5451b7cd-af27-41b8-8df1-282ffea13a61"
+}
+```
+
+Once we get a successful response from APISIX server, we can send a request to this _get_ endpoint to generate logs.
+
+```bash
+
+curl -i http://127.0.0.1:9080/get
+
+```
+
+Then if you click and navigate to the following our [mock server link](http://mockbin.org/bin/5451b7cd-af27-41b8-8df1-282ffea13a61/log) some recent logs are sent and we can see them:
+
+
+
+## Metrics
+
+**Metrics** are a numeric representation of data measured over intervals of time. You can also aggregate this data into daily or weekly frequency and run queries against a distributed system like [Elasticsearch](https://www.elastic.co/). Or sometimes based on metrics you trigger alerts to take any action later. Once API metrics are collected, you can track them with metrics tracking tools such as [Prometheus](https://prometheus.io/).
+
+Apache APISIX API Gateway also offers [prometheus-plugin](https://apisix.apache.org/docs/apisix/plugins/prometheus/) to fetch your API metrics and expose them in Prometheus. Behind the scene, Apache APISIX downloads the Grafana dashboard meta, imports it to [Grafana](https://grafana.com/), and fetches real-time metrics from the Prometheus plugin.
+
+Let’s enable prometheus-plugin for our route:
+
+```bash
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "uri": "/get",
+ "plugins": {
+ "prometheus": {}
+ },
+ "upstream_id": "1"
+}'
+```
+
+We fetch the metric data from the specified URL `/apisix/prometheus/`metrics.
+
+```bash
+curl -i http://127.0.0.1:9091/apisix/prometheus/metrics
+```
+
+You will get a response with Prometheus metrics something like below:
+
+```text
+HTTP/1.1 200 OK
+Server: openresty
+Content-Type: text/plain; charset=utf-8
+Transfer-Encoding: chunked
+Connection: keep-alive
+
+# HELP apisix_batch_process_entries batch process remaining entries
+# TYPE apisix_batch_process_entries gauge
+apisix_batch_process_entries{name="http logger",route_id="1",server_addr="172.19.0.8"} 0
+# HELP apisix_etcd_modify_indexes Etcd modify index for APISIX keys
+# TYPE apisix_etcd_modify_indexes gauge
+apisix_etcd_modify_indexes{key="consumers"} 17819
+apisix_etcd_modify_indexes{key="global_rules"} 17832
+apisix_etcd_modify_indexes{key="max_modify_index"} 20028
+apisix_etcd_modify_indexes{key="prev_index"} 18963
+apisix_etcd_modify_indexes{key="protos"} 0
+apisix_etcd_modify_indexes{key="routes"} 20028
+...
+```
+
+And we can also check the status of our endpoint at the Prometheus dashboard by pointing to this URL `http://localhost:9090/targets`
+
+
+
+As you can see, Apache APISIX exposed metrics endpoint is upon and running.
+
+Now you can query metrics for `apisix_http_status` to see what HTTP requests are handled by API Gateway and what was the outcome.
+
+
+
+In addition to this, you can view the Grafana dashboard running in your local instance. Go to `http://localhost:3000/`
+
+
+
+You can also check two other plugins for metrics:
+
+- [Node status Plugin](https://apisix.apache.org/docs/apisix/plugins/node-status/)
+
+- [Datadog Plugin](https://apisix.apache.org/docs/apisix/plugins/opentelemetry)
+
+## Tracing
+
+The third is **tracing** or distributed tracing allows you to understand the life of a request as it traverses your service network and allows you to answer questions like what service has this request touched and how much latency was introduced. Traces enable you to further explore which logs to look at for a particular session or related set of API calls.
+
+[Zipkin](https://zipkin.io/) an open-source distributed tracing system. [APISIX plugin](https://apisix.apache.org/docs/apisix/plugins/zipkin) is supported to collect tracing and report to Zipkin Collector based on [Zipkin API specification](https://zipkin.io/pages/instrumenting.html).
+
+Here’s an example to enable the _zipkin plugin_ on the specified route:
+
+```bash
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "methods": [
+ "GET"
+ ],
+ "uri": "/get",
+ "plugins": {
+ "zipkin": {
+ "endpoint": "http://127.0.0.1:9411/api/v2/spans",
+ "sample_ratio": 1
+ }
+ },
+ "upstream_id": "1"
+}'
+```
+
+We can test our example by simply running the following curl command:
+
+```bash
Review Comment:
```suggestion
```shell
```
--
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] Boburmirzo commented on pull request #7921: docs: Add How-to guides section with the first guide
Posted by GitBox <gi...@apache.org>.
Boburmirzo commented on PR #7921:
URL: https://github.com/apache/apisix/pull/7921#issuecomment-1250683639
> Yes. You can find it here. https://apisix.apache.org/docs/apisix/next/how-to-guides/observe-your-api/ cc@Boburmirzo 
Great! I will work on yet another guide soon.
--
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] hf400159 commented on a diff in pull request #7921: docs: Add How-to guides section with the first guide
Posted by GitBox <gi...@apache.org>.
hf400159 commented on code in PR #7921:
URL: https://github.com/apache/apisix/pull/7921#discussion_r971449688
##########
docs/en/latest/how-to-guides/observe-your-api.md:
##########
@@ -0,0 +1,232 @@
+---
+title: Observer your APIs
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Observability
+ - Monitor
+ - Plugins
+description: Apache APISIX Observability Plugins and take a look at how to set up these plugins.
+---
+
Review Comment:
##########
docs/en/latest/how-to-guides/observe-your-api.md:
##########
@@ -0,0 +1,232 @@
+---
+title: Observer your APIs
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Observability
+ - Monitor
+ - Plugins
+description: Apache APISIX Observability Plugins and take a look at how to set up these plugins.
+---
+
Review Comment:
please add ASF 2.0 license. please refer to: https://github.com/apache/apisix/edit/master/docs/en/latest/plugins/api-breaker.md
--
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] Boburmirzo commented on pull request #7921: docs: Add How-to guides section with the first guide
Posted by GitBox <gi...@apache.org>.
Boburmirzo commented on PR #7921:
URL: https://github.com/apache/apisix/pull/7921#issuecomment-1247822561
@SylviaBABY Thanks, I updated the requested changes.
--
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] Boburmirzo commented on pull request #7921: docs: Add How-to guides section with the first guide
Posted by GitBox <gi...@apache.org>.
Boburmirzo commented on PR #7921:
URL: https://github.com/apache/apisix/pull/7921#issuecomment-1247636975
@juzhiyuan We need one more reviewer and approver:)
--
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 merged pull request #7921: docs: Add How-to guides section with the first guide
Posted by GitBox <gi...@apache.org>.
juzhiyuan merged PR #7921:
URL: https://github.com/apache/apisix/pull/7921
--
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] hf400159 commented on pull request #7921: docs: Add How-to guides section with the first guide
Posted by GitBox <gi...@apache.org>.
hf400159 commented on PR #7921:
URL: https://github.com/apache/apisix/pull/7921#issuecomment-1250453090
Yes. You can find it here. https://apisix.apache.org/docs/apisix/next/how-to-guides/observe-your-api/ cc@Boburmirzo
--
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] Boburmirzo commented on a diff in pull request #7921: docs: Add How-to guides section with the first guide
Posted by GitBox <gi...@apache.org>.
Boburmirzo commented on code in PR #7921:
URL: https://github.com/apache/apisix/pull/7921#discussion_r971569397
##########
docs/en/latest/how-to-guides/observe-your-api.md:
##########
@@ -0,0 +1,232 @@
+---
+title: Observer your APIs
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Observability
+ - Monitor
+ - Plugins
+description: Apache APISIX Observability Plugins and take a look at how to set up these plugins.
+---
+
Review Comment:
@hf400159 Right, I added now license description.
--
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