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 2021/11/04 03:52:51 UTC
[GitHub] [apisix-website] lijing-21 opened a new pull request #706: docs: add skywalking bolg
lijing-21 opened a new pull request #706:
URL: https://github.com/apache/apisix-website/pull/706
add skywalking bolg
--
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-website] yzeng25 commented on a change in pull request #706: docs: add skywalking blog
Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #706:
URL: https://github.com/apache/apisix-website/pull/706#discussion_r742559900
##########
File path: website/blog/2021/11/04/skywalking.md
##########
@@ -0,0 +1,104 @@
+---
+title: "The observability of Apache APISIX"
+author: "Haochao Zhuang"
+authorURL: "https://github.com/dmsolr"
+authorImageURL: "https://avatars.githubusercontent.com/u/29735230?v=4"
+keywords:
+- Apache APISIX
+- observability
+- SkyWalking
+- Apache
+- Prometheus
+description: This article introduces the observability capabilities of Apache APISIX and how to improve the observability capabilities of Apache APISIX through Apache SkyWalking.
+tags: [Technology]
+---
+
+> This article introduces the observability capabilities of Apache APISIX and how to improve the observability capabilities of Apache APISIX through Apache SkyWalking.
+
+<!--truncate-->
+
+Observability is the ability to observe the runtime state and resource usage of the internal program of the system from the outside of the system. The main measures of observability are Metrics, Logging, and Tracing, and the following diagram shows the relationship between Metrics, Logging, and Tracing.
+
+
+
+For example, the overlap between Tracing and Logging represents the logs generated by Tracing at the request level, and the Tracing ID is used to associate Tracing and Logging. After performing certain aggregation operations on this log, some Metrics can be obtained. Tracing itself also generates some Metrics, such as the relationship between the call volume.
+
+## Observability Capabilities of Apache APISIX
+
+Apache APISIX has comprehensive observability capabilities: support for Tracing and Metrics, a rich ecosystem of Logging plug-ins, and support for querying node status.
+
+### Tracing
+
+Apache APISIX supports a variety of Tracing plugins, including: Zipkin, OpenTracing and SkyWalking. Note that: Tracing plug-in is closed by default, you need to manually open Tracing plug-in before use. Tracing plugin needs to be bound to routing or global rules. If there is no requirement for sampling rate, it is recommended to bind to global rules to avoid omissions.
+
+### Metrics
+
+In Apache APISIX, Metrics related information is reported through Prometheus Exporter, which is compatible with the Prometheus data format. There are two things to be aware of when using the Prometheus Plugin in Apache APISIX.
+
+**First, please try to improve the readability of the names of all three - route, service and upstream.**
+
+There is a parameter named `prefer_name` in Prometheus Plugin. When the value of this parameter is set to `true`, that is: `prefer_name: true`. If the names of routing, service and upstream are relatively readable, This will bring some benefits: when you monitor the parameters on the large screen through Grafana, you can not only clearly display all the data, but also clearly know the source of the data. If the value of the `prefer_name` parameter is `false`, only the ID of the resource will be displayed as the data source, such as the routing ID and upstream ID, which will cause the problem of low readability of the monitor screen.
+
+**Second, the Prometheus Plugin must be bound to a route or global rule before it can view the metrics of the specified resource.**
+
+After the above setup, the Metrics data will be stored in Prometheus. Since Prometheus has good storage performance, but poor display performance, we need to use the Grafana Dashboard to display the data. We can see the Metrics for the Nginx instance, the Metrics for the network bandwidth, the Metrics for the routes and upstream, and more, as shown in the following image.
+
+
+
+### Logging
+
+Apache APISIX supports a variety of logging plugins to share log data directly with other external platforms. The Error Log plug-in supports HTTP and TCP protocols, and is compatible with the log format of SkyWalking. Logs can also be synchronized to logging platforms for processing through log collection components such as FluentBit.
+
+The Access Log plugin does not currently support nesting inside the log format. Because the Access Log plugin is route-level, it needs to be bound to a route in order to collect access logs for the route. However, the log format is global, and there can only be one global log format.
+
+### Support Querying Node Status
+
+Apache APISIX supports querying node status. When enabled, information about the nodes can be collected via `/apisix/status`, including the number of nodes, the number of waiting links, the number of connections processed, etc.
+
+
+
+### Fly in the Ointment
Review comment:
```suggestion
### Pitfalls
```
--
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-website] juzhiyuan merged pull request #706: docs: added skywalking blog
Posted by GitBox <gi...@apache.org>.
juzhiyuan merged pull request #706:
URL: https://github.com/apache/apisix-website/pull/706
--
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