Remove `meter.md` doc, because `mal.md` has covered all the content. (#13018)
This commit is contained in:
parent
babc22e159
commit
c2cdf07871
|
|
@ -171,7 +171,7 @@ NOTICE, this sharding concept is NOT just for splitting data into different data
|
|||
|
||||
* Reconstruction doc menu for v9.
|
||||
* Update backend-alarm.md doc, support op "=" to "==".
|
||||
* Update backend-meter.md doc .
|
||||
* Update backend-mal.md doc .
|
||||
* Add <STAM: Enhancing Topology Auto Detection For A Highly Distributed and Large-Scale Application System> paper.
|
||||
* Add Academy menu for recommending articles.
|
||||
* Remove `All` source relative document and examples.
|
||||
|
|
|
|||
|
|
@ -104,6 +104,7 @@
|
|||
* Simplified the release process with removing maven central publish relative processes.
|
||||
* Add Circuit Breaking mechanism doc.
|
||||
* Add `Get Node List in the Cluster` API doc.
|
||||
* Remove `meter.md` doc, because `mal.md` has covered all the content.
|
||||
|
||||
|
||||
All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/224?closed=1)
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
# Meter System -- Analysis Metrics and Meters
|
||||
Meter system is a metric streaming process system, which focus on processing and analyzing aggregated metrics data.
|
||||
Metrics from OpenTelemetry, Zabbix, Prometheus, SkyWalking meter APIs, etc., are all statistics, so they are processed
|
||||
by the meter system.
|
||||
|
||||
# Meter Analysis Language
|
||||
|
||||
The meter system provides a functional analysis language called MAL (Meter Analysis Language) that lets users analyze and
|
||||
|
|
|
|||
|
|
@ -1,24 +0,0 @@
|
|||
# Meter System
|
||||
Meter system is another streaming calculation mode designed for metrics data. In the [OAL](oal.md), there are clear
|
||||
[Scope Definitions](scope-definitions.md), including definitions for native objects. Meter system is focused on the data type itself,
|
||||
and provides a more flexible approach to the end user in defining the scope entity.
|
||||
|
||||
The meter system is open to different receivers and fetchers in the backend,
|
||||
see the [backend setup document](../setup/backend/backend-setup.md) for more details.
|
||||
|
||||
Every metric is declared in the meter system to include the following attributes:
|
||||
1. **Metrics Name**. A globally unique name to avoid overlapping between the OAL variable names.
|
||||
1. **Function Name**. The function used for this metric, namely distributed aggregation, value calculation or down sampling calculation
|
||||
based on the function implementation. Further, the data structure is determined by the function as well, such as function Avg is for Long.
|
||||
1. **Scope Type**. Unlike within the OAL, there are plenty of logic scope definitions. In the meter system, only type is required.
|
||||
Type values include service, instance, and endpoint, just as we have described in the Overview section.
|
||||
The values of scope entity name, such as service name, are required when metrics data are generated with the metrics data values.
|
||||
|
||||
NOTE: The metrics must be declared in the bootstrap stage, and there must be no change to runtime.
|
||||
|
||||
The Meter System supports the following binding functions:
|
||||
- **avg**. Calculates the avg value for every entity under the same metrics name.
|
||||
- **histogram**. Aggregates the counts in the configurable buckets. Buckets are configurable but must be assigned in the declaration stage.
|
||||
- **percentile**. See [percentile in WIKI](https://en.wikipedia.org/wiki/Percentile). Unlike the OAL, we provide
|
||||
50/75/90/95/99 by default. In the meter system function, the percentile function accepts several ranks, which should be in
|
||||
the (0, 100) range.
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
SkyWalking leverages jmx prometheus exporter for collecting metrics data from ActiveMQ classic. It leverages OpenTelemetry
|
||||
Collector to transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
## Data flow
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# APISIX monitoring
|
||||
## APISIX performance from `apisix prometheus plugin`
|
||||
SkyWalking leverages OpenTelemetry Collector to transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
### Data flow
|
||||
1. [APISIX Prometheus plugin](https://apisix.apache.org/docs/apisix/plugins/prometheus/) collects metrics data from APSIX.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# AWS API Gateway monitoring
|
||||
Amazon API Gateway is an AWS service for creating, publishing, maintaining, monitoring, and securing REST, HTTP, and WebSocket APIs. SkyWalking leverages [AWS Kinesis Data Firehose receiver](./aws-firehose-receiver.md) to transfer the CloudWatch metrics of API Gateway(HTTP and REST APIs) to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
### Data flow
|
||||
1. AWS CloudWatch collect metrics for API Gateway(REST and HTTP APIs), refer to [API Gateway HTTP APIs monitoring with CloudWatch](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-metrics.html) and [API Gateway REST APIs monitoring with CloudWatch](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-metrics-and-dimensions.html)
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# AWS DynamoDb monitoring
|
||||
SkyWalking leverages Amazon Kinesis Data Filehose with [Amazon CloudWatch](https://aws.amazon.com/cn/cloudwatch/) to transfer the metrics into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
SkyWalking leverages Amazon Kinesis Data Filehose with [Amazon CloudWatch](https://aws.amazon.com/cn/cloudwatch/) to transfer the metrics into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
### Data flow
|
||||
1. Amazon CloudWatch fetches metrics from DynamoDB and pushes metrics to SkyWalking OAP Server via Amazon Kinesis data firehose.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# AWS Cloud EKS monitoring
|
||||
SkyWalking leverages OpenTelemetry Collector with [AWS Container Insights Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/awscontainerinsightreceiver/README.md) to transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
### Data flow
|
||||
1. OpenTelemetry Collector fetches metrics from EKS via [AWS Container Insights Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/awscontainerinsightreceiver/README.md) and pushes metrics to SkyWalking OAP Server via OpenTelemetry gRPC exporter.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# AWS Cloud S3 monitoring
|
||||
Amazon Simple Storage Service (Amazon S3) is an object storage service. SkyWalking leverages [AWS Kinesis Data Firehose receiver](./aws-firehose-receiver.md) to transfer the CloudWatch metrics of s3 to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
### Data flow
|
||||
1. AWS CloudWatch collect metrics for S3, refer to [S3 monitoring with CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/userguide/cloudwatch-monitoring.html)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# BookKeeper monitoring
|
||||
|
||||
SkyWalking leverages OpenTelemetry Collector to collect metrics data from the BookKeeper and leverages OpenTelemetry Collector to transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
Kafka entity as a `Service` in OAP and on the `Layer: BOOKKEEPER.
|
||||
|
||||
## Data flow
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
SkyWalking leverages ClickHouse built-in metrics data since v20.1.2.4. It leverages OpenTelemetry Collector to transfer
|
||||
the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
### Data flow
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
SkyWalking leverages elasticsearch-exporter for collecting metrics data from Elasticsearch. It leverages OpenTelemetry
|
||||
Collector to transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
## Data flow
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Kubernetes (K8s) monitoring from kube-state-metrics and cAdvisor
|
||||
SkyWalking leverages K8s kube-state-metrics (KSM) and cAdvisor for collecting metrics data from K8s. It leverages OpenTelemetry Collector to transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md). This feature requires authorizing the OAP Server to access K8s's `API Server`.
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md). This feature requires authorizing the OAP Server to access K8s's `API Server`.
|
||||
|
||||
## Data flow
|
||||
1. K8s kube-state-metrics and cAdvisor collect metrics data from K8s.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Kafka monitoring
|
||||
|
||||
SkyWalking leverages Prometheus JMX Exporter to collect metrics data from the Kafka and leverages OpenTelemetry Collector to transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
Kafka entity as a `Service` in OAP and on the `Layer: KAFKA`.
|
||||
|
||||
## Data flow
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
The [kong-prometheus](https://github.com/Kong/kong/tree/master/kong/plugins/prometheus) is a lua library that can be used with Kong to collect metrics.
|
||||
It exposes metrics related to Kong and proxied upstream services in Prometheus exposition format, which can be scraped by a Prometheus Server.
|
||||
SkyWalking leverages OpenTelemetry Collector to transfer the metrics to[OpenTelemetry receiver](opentelemetry-receiver.md)
|
||||
and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
### Data flow
|
||||
1. [KONG Prometheus plugin](https://docs.konghq.com/hub/kong-inc/prometheus/) collects metrics data from KONG.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
The meter receiver accepts the metrics
|
||||
of [meter protocol](https://github.com/apache/skywalking-data-collect-protocol/blob/master/language-agent/Meter.proto)
|
||||
into the [meter system](./../../concepts-and-designs/meter.md).
|
||||
into the [meter system](./../../concepts-and-designs/mal.md).
|
||||
|
||||
## Module definition
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
SkyWalking leverages mongodb-exporter for collecting metrics data from MongoDB. It leverages OpenTelemetry
|
||||
Collector to transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
## Data flow
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# MySQL/MariaDB monitoring
|
||||
## MySQL/MariaDB server performance from `prometheus/mysqld_exporter`
|
||||
SkyWalking leverages prometheus/mysqld_exporter for collecting metrics data. It leverages OpenTelemetry Collector to transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
### Data flow
|
||||
1. mysqld_exporter collect metrics data from MySQL/MariaDB.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ The [nginx-lua-prometheus](https://github.com/knyar/nginx-lua-prometheus) is a l
|
|||
and expose them on a separate web page.
|
||||
To use this library, you will need Nginx with [lua-nginx-module](https://github.com/openresty/lua-nginx-module) or directly [OpenResty](https://openresty.org/).
|
||||
|
||||
SkyWalking leverages OpenTelemetry Collector to transfer the metrics to [OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
SkyWalking leverages OpenTelemetry Collector to transfer the metrics to [OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
### Data flow
|
||||
1. [nginx-lua-prometheus](https://github.com/knyar/nginx-lua-prometheus) collects metrics from Nginx and expose them to an endpoint.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# PostgreSQL monitoring
|
||||
## PostgreSQL server performance from `postgres-exporter`
|
||||
SkyWalking leverages postgres-exporter for collecting metrics data from PostgreSQL. It leverages OpenTelemetry Collector to transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
### Data flow
|
||||
1. postgres-exporter collect metrics data from PostgreSQL.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Pulsar monitoring
|
||||
|
||||
SkyWalking leverages OpenTelemetry Collector to collect metrics data in Prometheus format from the Pulsar and transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
Kafka entity as a `Service` in OAP and on the `Layer: PULSAR.
|
||||
|
||||
## Data flow
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
SkyWalking leverages `rabbitmq_prometheus` plugin for collecting metrics data from RabbitMQ. It leverages OpenTelemetry
|
||||
Collector to transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
## Data flow
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Redis monitoring
|
||||
## Redis server performance from `redis-exporter`
|
||||
SkyWalking leverages redis-exporter for collecting metrics data from Redis. It leverages OpenTelemetry Collector to transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
### Data flow
|
||||
1. redis-exporter collect metrics data from Redis.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
SkyWalking leverages rocketmq-exporter for collecting metrics data from RocketMQ. It leverages OpenTelemetry
|
||||
Collector to transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
## Data flow
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
# Linux Monitoring
|
||||
SkyWalking leverages Prometheus node-exporter to collect metrics data from the VMs and leverages OpenTelemetry Collector to transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
VM entity as a `Service` in OAP and on the `Layer: OS_LINUX`.
|
||||
|
||||
SkyWalking also provides InfluxDB Telegraf to receive VMs' metrics data by [Telegraf receiver](./telegraf-receiver.md).
|
||||
The telegraf receiver plugin receiver, process and convert the metrics, then it send converted metrics to [Meter System](./../../concepts-and-designs/meter.md).
|
||||
The telegraf receiver plugin receiver, process and convert the metrics, then it send converted metrics to [Meter System](./../../concepts-and-designs/mal.md).
|
||||
VM entity as a `Service` in OAP and on the `Layer: OS_LINUX`.
|
||||
|
||||
## Data flow
|
||||
|
|
@ -16,7 +16,7 @@ VM entity as a `Service` in OAP and on the `Layer: OS_LINUX`.
|
|||
**For Telegraf receiver:**
|
||||
1. The InfluxDB Telegraf [input plugins](https://docs.influxdata.com/telegraf/v1.24/plugins/) collects various metrics data from the VMs.
|
||||
2. The cpu, mem, system, disk and diskio input plugins should be set in telegraf.conf file.
|
||||
2. The InfluxDB Telegraf send `JSON` format metrics by `HTTP` messages to Telegraf Receiver, then pushes converted metrics to the SkyWalking OAP Server [Meter System](./../../concepts-and-designs/meter.md).
|
||||
2. The InfluxDB Telegraf send `JSON` format metrics by `HTTP` messages to Telegraf Receiver, then pushes converted metrics to the SkyWalking OAP Server [Meter System](./../../concepts-and-designs/mal.md).
|
||||
3. The SkyWalking OAP Server parses the expression with [MAL](../../concepts-and-designs/mal.md) to filter/calculate/aggregate ad store the results.
|
||||
4. The meter_vm_cpu_average_used metrics indicates the average usage of each CPU core for telegraf receiver.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Windows Monitoring
|
||||
SkyWalking leverages Prometheus windows_exporter to collect metrics data from the Windows and leverages OpenTelemetry Collector to transfer the metrics to
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
Windows entity as a `Service` in OAP and on the `Layer: OS_WINDOWS`.
|
||||
|
||||
## Data flow
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# Zabbix Receiver
|
||||
The Zabbix receiver accepts metrics of [Zabbix Agent Active Checks protocol](https://www.zabbix.com/documentation/current/manual/appendix/items/activepassive#active_checks) format into the [Meter System](./../../concepts-and-designs/meter.md).
|
||||
The Zabbix receiver accepts metrics of [Zabbix Agent Active Checks protocol](https://www.zabbix.com/documentation/current/manual/appendix/items/activepassive#active_checks) format into the [Meter System](./../../concepts-and-designs/mal.md).
|
||||
Zabbix Agent is based on GPL-2.0 License, only version `6.x` and below are supported.
|
||||
|
||||
## Module definition
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# MicroMeter Observations setup
|
||||
|
||||
Micrometer Observation is part of the Micrometer project and contains the Observation API.
|
||||
SkyWalking integrates its MicroMeter 1.10 APIs so that it can send metrics to the SkyWalking [Meter System](./../../concepts-and-designs/meter.md).
|
||||
SkyWalking integrates its MicroMeter 1.10 APIs so that it can send metrics to the SkyWalking [Meter System](./../../concepts-and-designs/mal.md).
|
||||
|
||||
Follow Java agent [Observations docs](https://skywalking.apache.org/docs/skywalking-java/next/en/setup/service-agent/java-agent/application-toolkit-micrometer-1.10/) to set up agent in the Spring first.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue