This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking.git
The following commit(s) were added to refs/heads/master by this push:
new cf08a2d refine backend doc (#7451)
cf08a2d is described below
commit cf08a2da3797a17e6dfac9c97deeced59ed6104d
Author: Wing <[email protected]>
AuthorDate: Fri Aug 13 06:06:17 2021 -0700
refine backend doc (#7451)
---
docs/en/setup/backend/backend-start-up-mode.md | 22 +-
docs/en/setup/backend/backend-storage.md | 97 ++---
docs/en/setup/backend/backend-telemetry.md | 47 +-
docs/en/setup/backend/backend-token-auth.md | 23 +-
docs/en/setup/backend/backend-vm-monitoring.md | 10 +-
docs/en/setup/backend/backend-zabbix.md | 16 +-
docs/en/setup/backend/configuration-vocabulary.md | 505 +++++++++++-----------
7 files changed, 357 insertions(+), 363 deletions(-)
diff --git a/docs/en/setup/backend/backend-start-up-mode.md
b/docs/en/setup/backend/backend-start-up-mode.md
index 6b868c2..50d5b1b 100644
--- a/docs/en/setup/backend/backend-start-up-mode.md
+++ b/docs/en/setup/backend/backend-start-up-mode.md
@@ -1,23 +1,21 @@
# Start up mode
-In different deployment tool, such as k8s, you may need different startup mode.
-We provide another two optional startup modes.
+In different deployment tools, such as k8s, you may need different startup
modes.
+We provide two other optional startup modes.
## Default mode
-Default mode. Do initialization works if necessary, start listen and provide
service.
+The default mode carries out tasks to initialize as necessary, starts to
listen, and provide services.
-Run `/bin/oapService.sh`(.bat) to start in this mode. Also when use
`startup.sh`(.bat) to start.
+Run `/bin/oapService.sh`(.bat) to start in this mode. This is also applicable
when you're using `startup.sh`(.bat) to start.
## Init mode
-In this mode, oap server starts up to do initialization works, then exit.
-You could use this mode to init your storage, such as ElasticSearch indexes,
MySQL and TiDB tables,
-and init data.
+In this mode, the OAP server starts up to carry out initialization, and then
exits.
+You could use this mode to initialize your storage (such as ElasticSearch
indexes, MySQL, and TiDB tables),
+as well as your data.
Run `/bin/oapServiceInit.sh`(.bat) to start in this mode.
## No-init mode
-In this mode, oap server starts up without initialization works,
-but it waits for ElasticSearch indexes, MySQL and TiDB tables existed,
-start listen and provide service. Meaning,
-this oap server expect another oap server to do the initialization.
+In this mode, the OAP server starts up without carrying out initialization.
Rather, it watches out for the ElasticSearch indexes, MySQL, and TiDB tables,
+starts to listen, and provide services. In other words, the OAP server would
anticipate having another OAP server to carry out the initialization.
-Run `/bin/oapServiceNoInit.sh`(.bat) to start in this mode.
\ No newline at end of file
+Run `/bin/oapServiceNoInit.sh`(.bat) to start in this mode.
diff --git a/docs/en/setup/backend/backend-storage.md
b/docs/en/setup/backend/backend-storage.md
index 9f56f9c..e750e0d 100644
--- a/docs/en/setup/backend/backend-storage.md
+++ b/docs/en/setup/backend/backend-storage.md
@@ -1,13 +1,13 @@
# Backend storage
-SkyWalking storage is pluggable, we have provided the following storage
solutions, you could easily
-use one of them by specifying it as the `selector` in the `application.yml`：
+The SkyWalking storage is pluggable. We have provided the following storage
solutions, which allows you to easily
+use one of them by specifying it as the `selector` in `application.yml`：
```yaml
storage:
selector: ${SW_STORAGE:elasticsearch7}
```
-Native supported storage
+Natively supported storage:
- H2
- OpenSearch
- ElasticSearch 6, 7
@@ -18,9 +18,9 @@ Native supported storage
## H2
-Active H2 as storage, set storage provider to **H2** In-Memory Databases.
Default in distribution package.
-Please read `Database URL Overview` in [H2 official
document](http://www.h2database.com/html/features.html),
-you could set the target to H2 in **Embedded**, **Server** and **Mixed** modes.
+Activate H2 as storage, set storage provider to **H2** In-Memory Databases.
Default in distribution package.
+Please read `Database URL Overview` in [H2 official
document](http://www.h2database.com/html/features.html).
+You can set the target to H2 in **Embedded**, **Server** and **Mixed** modes.
Setting fragment example
```yaml
@@ -40,7 +40,7 @@ Please download the `apache-skywalking-bin-es7.tar.gz` if you
want to use OpenSe
## ElasticSearch
-**NOTICE:** Elastic announced through their blog that Elasticsearch will be
moving over to a Server Side Public
+**NOTE:** Elastic announced through their blog that Elasticsearch will be
moving over to a Server Side Public
License (SSPL), which is incompatible with Apache License 2.0. This license
change is effective from Elasticsearch
version 7.11. So please choose the suitable ElasticSearch version according to
your usage.
@@ -49,10 +49,10 @@ version 7.11. So please choose the suitable ElasticSearch
version according to y
**Required ElasticSearch 6.3.2 or higher. HTTP RestHighLevelClient is used to
connect server.**
-- For ElasticSearch 6.3.2 ~ 7.0.0 (excluded), please download the
`apache-skywalking-bin.tar.gz`,
-- For ElasticSearch 7.0.0 ~ 8.0.0 (excluded), please download the
`apache-skywalking-bin-es7.tar.gz`.
+- For ElasticSearch 6.3.2 ~ 7.0.0 (excluded), please download
`apache-skywalking-bin.tar.gz`.
+- For ElasticSearch 7.0.0 ~ 8.0.0 (excluded), please download
`apache-skywalking-bin-es7.tar.gz`.
-For now, ElasticSearch 6 and ElasticSearch 7 share the same configurations, as
follows:
+For now, ElasticSearch 6 and ElasticSearch 7 share the same configurations as
follows:
```yaml
storage:
@@ -88,7 +88,7 @@ storage:
### ElasticSearch 6 With Https SSL Encrypting communications.
-example:
+Example:
```yaml
storage:
@@ -103,37 +103,37 @@ storage:
protocol: ${SW_STORAGE_ES_HTTP_PROTOCOL:"https"}
...
```
-- File at `trustStorePath` is being monitored, once it is changed, the
ElasticSearch client will do reconnecting.
-- `trustStorePass` could be changed on the runtime through [**Secrets
Management File Of ElasticSearch
Authentication**](#secrets-management-file-of-elasticsearch-authentication).
+- File at `trustStorePath` is being monitored. Once it is changed, the
ElasticSearch client will reconnect.
+- `trustStorePass` could be changed in the runtime through [**Secrets
Management File Of ElasticSearch
Authentication**](#secrets-management-file-of-elasticsearch-authentication).
### Daily Index Step
-Daily index step(`storage/elasticsearch/dayStep`, default 1) represents the
index creation period. In this period, several days(dayStep value)' metrics are
saved.
+Daily index step(`storage/elasticsearch/dayStep`, default 1) represents the
index creation period. In this period, metrics for several days (dayStep value)
are saved.
-Mostly, users don't need to change the value manually. As SkyWalking is
designed to observe large scale distributed system.
-But in some specific cases, users want to set a long TTL value, such as more
than 60 days, but their ElasticSearch cluster isn't powerful due to the low
traffic in the production environment.
-This value could be increased to 5(or more), if users could make sure single
one index could support these days(5 in this case) metrics and traces.
+In most cases, users don't need to change the value manually, as SkyWalking is
designed to observe large scale distributed systems.
+But in some cases, users may want to set a long TTL value, such as more than
60 days. However, their ElasticSearch cluster may not be powerful enough due to
low traffic in the production environment.
+This value could be increased to 5 (or more), if users could ensure a single
index could support the metrics and traces for these days (5 in this case).
-Such as, if dayStep == 11,
-1. data in [2000-01-01, 2000-01-11] will be merged into the index-20000101.
-1. data in [2000-01-12, 2000-01-22] will be merged into the index-20000112.
+For example, if dayStep == 11,
+1. Data in [2000-01-01, 2000-01-11] will be merged into the index-20000101.
+1. Data in [2000-01-12, 2000-01-22] will be merged into the index-20000112.
-`storage/elasticsearch/superDatasetDayStep` override the
`storage/elasticsearch/dayStep` if the value is positive.
-This would affect the record related entities, such as the trace segment. In
some cases, the size of metrics is much less than the record(trace), this would
help the shards balance in the ElasticSearch cluster.
+`storage/elasticsearch/superDatasetDayStep` overrides the
`storage/elasticsearch/dayStep` if the value is positive.
+This would affect the record-related entities, such as trace segments. In some
cases, the size of metrics is much smaller than the record (trace). This would
improve the shards balance in the ElasticSearch cluster.
-NOTICE, TTL deletion would be affected by these. You should set an extra more
dayStep in your TTL. Such as you want to TTL == 30 days and dayStep == 10, you
actually need to set TTL = 40;
+NOTE: TTL deletion would be affected by these steps. You should set an extra
dayStep in your TTL. For example, if you want to have TTL == 30 days and
dayStep == 10, you are commended to set TTL = 40.
### Secrets Management File Of ElasticSearch Authentication
The value of `secretsManagementFile` should point to the secrets management
file absolute path.
-The file includes username, password and JKS password of ElasticSearch server
in the properties format.
+The file includes username, password, and JKS password of the ElasticSearch
server in the properties format.
```properties
user=xxx
password=yyy
trustStorePass=zzz
```
-The major difference between using `user, password, trustStorePass` configs in
the `application.yaml` file is, the **Secrets Management File** is being
watched by the OAP server.
-Once it is changed manually or through 3rd party tool, such as
[Vault](https://github.com/hashicorp/vault),
-the storage provider will use the new username, password and JKS password to
establish the connection and close the old one. If the information exist in the
file,
+The major difference between using `user, password, trustStorePass` configs in
the `application.yaml` file is that the **Secrets Management File** is being
watched by the OAP server.
+Once it is changed manually or through a 3rd party tool, such as
[Vault](https://github.com/hashicorp/vault),
+the storage provider will use the new username, password, and JKS password to
establish the connection and close the old one. If the information exists in
the file,
the `user/password` will be overrided.
### Advanced Configurations For Elasticsearch Index
@@ -149,7 +149,7 @@ storage:
```
### Recommended ElasticSearch server-side configurations
-You could add following config to `elasticsearch.yml`, set the value based on
your env.
+You could add the following configuration to `elasticsearch.yml`, and set the
value based on your environment.
```yml
# In tracing scenario, consider to set more than this at least.
@@ -160,13 +160,12 @@ thread_pool.write.queue_size: 1000 # Suitable for
ElasticSearch 6 and 7
index.max_result_window: 1000000
```
-We strongly advice you to read more about these configurations from
ElasticSearch official document.
-This effects the performance of ElasticSearch very much.
+We strongly recommend that you read more about these configurations from
ElasticSearch's official document, since they have a direct impact on the
performance of ElasticSearch.
### ElasticSearch 7 with Zipkin trace extension
-This implementation shares most of `elasticsearch7`, just extends to support
zipkin span storage.
-It has all same configs.
+This implementation is very similar to `elasticsearch7`, except that it
extends to support Zipkin span storage.
+The configurations are largely the same.
```yaml
storage:
selector: ${SW_STORAGE:zipkin-elasticsearch7}
@@ -186,13 +185,13 @@ storage:
```
### About Namespace
-When namespace is set, names of all indexes in ElasticSearch will use it as
prefix.
+When namespace is set, all index names in ElasticSearch will use it as prefix.
## MySQL
Active MySQL as storage, set storage provider to **mysql**.
-**NOTICE:** MySQL driver is NOT allowed in Apache official distribution and
source codes.
-Please download MySQL driver by yourself. Copy the connection driver jar to
`oap-libs`.
+**NOTE:** MySQL driver is NOT allowed in Apache official distribution and
source codes.
+Please download MySQL driver on your own. Copy the connection driver jar to
`oap-libs`.
```yaml
storage:
@@ -208,12 +207,12 @@ storage:
dataSource.useServerPrepStmts:
${SW_DATA_SOURCE_USE_SERVER_PREP_STMTS:true}
metadataQueryMaxSize: ${SW_STORAGE_MYSQL_QUERY_MAX_SIZE:5000}
```
-All connection related settings including link url, username and password are
in `application.yml`.
-Here are some of the settings, please follow
[HikariCP](https://github.com/brettwooldridge/HikariCP) connection pool
document for all the settings.
+All connection-related settings, including URL link, username, and password
are found in `application.yml`.
+Only part of the settings are listed here. See the
[HikariCP](https://github.com/brettwooldridge/HikariCP) connection pool
document for full settings.
## TiDB
-Tested TiDB Server 4.0.8 version and Mysql Client driver 8.0.13 version
currently.
-Active TiDB as storage, set storage provider to **tidb**.
+Tested TiDB Server 4.0.8 version and MySQL Client driver 8.0.13 version are
currently available.
+Activate TiDB as storage, and set storage provider to **tidb**.
```yaml
storage:
@@ -232,8 +231,8 @@ storage:
maxSizeOfArrayColumn: ${SW_STORAGE_MAX_SIZE_OF_ARRAY_COLUMN:20}
numOfSearchableValuesPerTag:
${SW_STORAGE_NUM_OF_SEARCHABLE_VALUES_PER_TAG:2}
```
-All connection related settings including link url, username and password are
in `application.yml`.
-These settings can refer to the configuration of *MySQL* above.
+All connection-related settings, including URL link, username, and password
are found in `application.yml`.
+For details on settings, refer to the configuration of *MySQL* above.
## InfluxDB
InfluxDB storage provides a time-series database as a new storage option.
@@ -250,11 +249,11 @@ storage:
duration: ${SW_STORAGE_INFLUXDB_DURATION:1000} # the time to wait at most
(milliseconds)
fetchTaskLogMaxSize: ${SW_STORAGE_INFLUXDB_FETCH_TASK_LOG_MAX_SIZE:5000} #
the max number of fetch task log in a request
```
-All connection related settings including link url, username and password are
in `application.yml`. The Metadata storage provider settings can refer to the
configuration of **H2/MySQL** above.
+All connection related settings, including URL link, username, and password
are found in `application.yml`. For metadata storage provider settings, refer
to the configurations of **H2/MySQL** above.
## PostgreSQL
-PostgreSQL jdbc driver uses version 42.2.18, it supports PostgreSQL 8.2 or
newer.
-Active PostgreSQL as storage, set storage provider to **postgresql**.
+PostgreSQL jdbc driver uses version 42.2.18. It supports PostgreSQL 8.2 or
newer.
+Activate PostgreSQL as storage, and set storage provider to **postgresql**.
```yaml
storage:
@@ -272,9 +271,9 @@ storage:
maxSizeOfArrayColumn: ${SW_STORAGE_MAX_SIZE_OF_ARRAY_COLUMN:20}
numOfSearchableValuesPerTag:
${SW_STORAGE_NUM_OF_SEARCHABLE_VALUES_PER_TAG:2}
```
-All connection related settings including link url, username and password are
in `application.yml`.
-Here are some of the settings, please follow
[HikariCP](https://github.com/brettwooldridge/HikariCP) connection pool
document for all the settings.
+All connection-related settings, including URL link, username, and password
are found in `application.yml`.
+Only part of the settings are listed here. Please follow
[HikariCP](https://github.com/brettwooldridge/HikariCP) connection pool
document for full settings.
-## More storage solution extension
-Follow [Storage extension development
guide](../../guides/storage-extention.md)
-in [Project Extensions document](../../guides/README.md#project-extensions) in
development guide.
+## More storage extension solutions
+Follow the [Storage extension development
guide](../../guides/storage-extention.md)
+in the [Project Extensions
document](../../guides/README.md#project-extensions).
diff --git a/docs/en/setup/backend/backend-telemetry.md
b/docs/en/setup/backend/backend-telemetry.md
index a958c54..871f24e 100644
--- a/docs/en/setup/backend/backend-telemetry.md
+++ b/docs/en/setup/backend/backend-telemetry.md
@@ -2,7 +2,7 @@
The OAP backend cluster itself is a distributed streaming process system. To
assist the Ops team,
we provide the telemetry for the OAP backend itself.
-By default, the telemetry is disabled by setting `selector` to `none`, like
this
+By default, the telemetry is disabled by setting `selector` to `none`, like
this:
```yaml
telemetry:
@@ -16,16 +16,16 @@ telemetry:
sslCertChainPath: ${SW_TELEMETRY_PROMETHEUS_SSL_CERT_CHAIN_PATH:""}
```
-but you can set one of `prometheus` to enable them, for more information,
refer to the details below.
+You may also set `Prometheus` to enable them. For more information, refer to
the details below.
## Self Observability
### Static IP or hostname
-SkyWalking supports to collect telemetry data into OAP backend directly. Users
could check them out through UI or
-GraphQL API then.
+SkyWalking supports collecting telemetry data into OAP backend directly. Users
could check them out through UI or
+GraphQL API.
-Adding following configuration to enable self-observability related modules.
+Add the following configuration to enable self-observability related modules.
-1. Setting up prometheus telemetry.
+1. Set up prometheus telemetry.
```yaml
telemetry:
selector: ${SW_TELEMETRY:prometheus}
@@ -34,7 +34,7 @@ telemetry:
port: 1543
```
-2. Setting up prometheus fetcher
+2. Set up prometheus fetcher.
```yaml
prometheus-fetcher:
@@ -46,8 +46,8 @@ prometheus-fetcher:
3. Make sure `config/fetcher-prom-rules/self.yaml` exists.
Once you deploy an oap-server cluster, the target host should be replaced with
a dedicated IP or hostname. For instances,
-there are three oap server in your cluster, their host is `service1`,
`service2` and `service3` respectively. You should
-update each `self.yaml` to twist target host.
+there are three OAP servers in your cluster. Their host is `service1`,
`service2`, and `service3` respectively. You should
+update each `self.yaml` to switch the target host.
service1:
```yaml
@@ -91,25 +91,25 @@ staticConfig:
...
```
### Service discovery (k8s)
-If you deploy an oap-server cluster on k8s, the oap-server instance(pod) could
not has the static IP or hostname. We can leverage [OpenTelemetry
Collector](https://opentelemetry.io/docs/collector/getting-started/#kubernetes)
to discover the oap-server instance and scrape & transfer the metrics to OAP
[OpenTelemetry receiver](backend-receivers.md#opentelemetry-receiver).
+If you deploy an oap-server cluster on k8s, the oap-server instance (pod)
would not have a static IP or hostname. We can leverage [OpenTelemetry
Collector](https://opentelemetry.io/docs/collector/getting-started/#kubernetes)
to discover the oap-server instance, and scrape & transfer the metrics to OAP
[OpenTelemetry receiver](backend-receivers.md#opentelemetry-receiver).
-How to install SkyWalking on k8s can refer to [Apache SkyWalking
Kubernetes](https://github.com/apache/skywalking-kubernetes)
+On how to install SkyWalking on k8s, you can refer to [Apache SkyWalking
Kubernetes](https://github.com/apache/skywalking-kubernetes).
-To set this up by the following steps:
+Set this up following these steps:
-1. Set up oap-server
-- Set the metrics port
+1. Set up oap-server.
+- Set the metrics port.
```
prometheus-port: 1234
```
-- Set environment variables
+- Set environment variables.
```
SW_TELEMETRY=prometheus
SW_OTEL_RECEIVER=default
SW_OTEL_RECEIVER_ENABLED_OC_RULES=oap
```
- Here is the example to install by Apache SkyWalking Kubernetes:
+ Here is an example to install by Apache SkyWalking Kubernetes:
```
helm -n istio-system install skywalking skywalking \
--set elasticsearch.replicas=1 \
@@ -144,20 +144,19 @@ To set this up by the following steps:
regex: (.+)
replacement: $$1
```
- The full example for OpenTelemetry Collector configuration and recommend
version can refer to [otel-collector-oap.yaml](otel-collector-oap.yaml).
+For the full example for OpenTelemetry Collector configuration and recommended
version, you can refer to [otel-collector-oap.yaml](otel-collector-oap.yaml).
___
-**WARNING**, since Apr 21, 2021, **Grafana** project has been relicensed to
**AGPL-v3**, no as Apache 2.0 anymore. Check the LICENSE details.
-The following Prometheus + Grafana solution is optional, not a recommendation.
+**NOTE**: Since Apr 21, 2021, the **Grafana** project has been relicensed to
**AGPL-v3**, and is no longer licensed for Apache 2.0. Check the LICENSE
details.
+The following Prometheus + Grafana solution is optional, rather than
recommended.
## Prometheus
-Prometheus is supported as telemetry implementor.
-By using this, prometheus collects metrics from SkyWalking backend.
+Prometheus is supported as a telemetry implementor, which collects metrics
from SkyWalking's backend.
-Set `prometheus` to provider. The endpoint open at `http://0.0.0.0:1234/` and
`http://0.0.0.0:1234/metrics`.
+Set `prometheus` to provider. The endpoint opens at `http://0.0.0.0:1234/` and
`http://0.0.0.0:1234/metrics`.
```yaml
telemetry:
selector: ${SW_TELEMETRY:prometheus}
@@ -173,7 +172,7 @@ telemetry:
port: 1543
```
-Set SSL relevant settings to expose a secure endpoint. Notice private key file
and cert chain file could be uploaded once
+Set relevant SSL settings to expose a secure endpoint. Note that the private
key file and cert chain file could be uploaded once
changes are applied to them.
```yaml
telemetry:
@@ -187,7 +186,7 @@ telemetry:
```
### Grafana Visualization
-Provide the grafana dashboard settings.
+Provide the Grafana dashboard settings.
Check [SkyWalking OAP Cluster Monitor Dashboard](grafana-cluster.json) config
and [SkyWalking OAP Instance Monitor Dashboard](grafana-instance.json) config.
diff --git a/docs/en/setup/backend/backend-token-auth.md
b/docs/en/setup/backend/backend-token-auth.md
index 9579a23..78c62b5 100644
--- a/docs/en/setup/backend/backend-token-auth.md
+++ b/docs/en/setup/backend/backend-token-auth.md
@@ -2,12 +2,12 @@
## Supported version
7.0.0+
-## Why need token authentication after we have TLS?
-TLS is about transport security, which makes sure the network can be trusted.
-The token authentication is about monitoring application data **can be
trusted**.
+## Why do we need token authentication after TLS?
+TLS is about transport security, which makes sure that a network can be
trusted.
+On the other hand, token authentication is about monitoring **whether
application data can be trusted**.
## Token
-In current version, Token is considered as a simple string.
+In the current version, token is considered a simple string.
### Set Token
1. Set token in agent.config file
@@ -25,19 +25,18 @@ receiver-sharing-server:
······
```
-## Authentication fails
-The Skywalking OAP verifies every request from agent, only allows requests
whose token matches the one configured in `application.yml`.
+## Authentication failure
+The Skywalking OAP verifies every request from the agent, and only allows
requests whose token matches the one configured in `application.yml` to pass
through.
-If the token is not right, you will see the following log in agent
+If the token does not match, you will see the following log in the agent:
```
org.apache.skywalking.apm.dependencies.io.grpc.StatusRuntimeException:
PERMISSION_DENIED
```
## FAQ
### Can I use token authentication instead of TLS?
-No, you shouldn't. In tech way, you can of course, but token and TLS are used
for untrusted network env. In that circumstance,
-TLS has higher priority than this. Token can be trusted only under TLS
protection.Token can be stolen easily if you
-send it through a non-TLS network.
+No, you shouldn't. Of course it's technically possible, but token and TLS are
used for untrusted network environments. In these circumstances,
+TLS has a higher priority. Tokens can be trusted only under TLS protection,
and they can be easily stolen if sent through a non-TLS network.
-### Do you support other authentication mechanisms? Such as ak/sk?
-For now, no. But we appreciate someone contributes this feature.
+### Do you support other authentication mechanisms, such as ak/sk?
+Not for now. But we welcome contributions on this feature.
diff --git a/docs/en/setup/backend/backend-vm-monitoring.md
b/docs/en/setup/backend/backend-vm-monitoring.md
index 4202f13..3093ee5 100644
--- a/docs/en/setup/backend/backend-vm-monitoring.md
+++ b/docs/en/setup/backend/backend-vm-monitoring.md
@@ -1,16 +1,16 @@
# VMs monitoring
-SkyWalking leverages Prometheus node-exporter for collecting metrics data from
the VMs, and leverages OpenTelemetry Collector to transfer the metrics to
+SkyWalking leverages Prometheus node-exporter to collect metrics data from the
VMs, and leverages OpenTelemetry Collector to transfer the metrics to
[OpenTelemetry receiver](backend-receivers.md#opentelemetry-receiver) and into
the [Meter System](./../../concepts-and-designs/meter.md).
We define the VM entity as a `Service` in OAP, and use `vm::` as a prefix to
identify it.
## Data flow
1. The Prometheus node-exporter collects metrics data from the VMs.
-2. The OpenTelemetry Collector fetches metrics from the node-exporter via
Prometheus Receiver and pushes metrics to SkyWalking OAP Server via the
OpenCensus gRPC Exporter.
+2. The OpenTelemetry Collector fetches metrics from node-exporter via
Prometheus Receiver and pushes metrics to the SkyWalking OAP Server via the
OpenCensus gRPC Exporter.
3. The SkyWalking OAP Server parses the expression with
[MAL](../../concepts-and-designs/mal.md) to filter/calculate/aggregate and
store the results.
## Setup
-1. Setup [Prometheus
node-exporter](https://prometheus.io/docs/guides/node-exporter/).
-2. Setup [OpenTelemetry Collector ](https://opentelemetry.io/docs/collector/).
This is an example for OpenTelemetry Collector configuration
[otel-collector-config.yaml](../../../../test/e2e/e2e-test/docker/promOtelVM/otel-collector-config.yaml).
+1. Set up [Prometheus
node-exporter](https://prometheus.io/docs/guides/node-exporter/).
+2. Set up [OpenTelemetry Collector
](https://opentelemetry.io/docs/collector/). This is an example for
OpenTelemetry Collector configuration
[otel-collector-config.yaml](../../../../test/e2e/e2e-test/docker/promOtelVM/otel-collector-config.yaml).
3. Config SkyWalking [OpenTelemetry
receiver](backend-receivers.md#opentelemetry-receiver).
## Supported Metrics
@@ -23,7 +23,7 @@ We define the VM entity as a `Service` in OAP, and use `vm::`
as a prefix to ide
| CPU Average Used | % | meter_vm_cpu_average_used | The percentage usage of
the CPU core in each mode | Prometheus node-exporter |
| CPU Load | | meter_vm_cpu_load1<br />meter_vm_cpu_load5<br
/>meter_vm_cpu_load15 | The CPU 1m / 5m / 15m average load | Prometheus
node-exporter |
| Memory RAM | MB | meter_vm_memory_total<br />meter_vm_memory_available<br
/>meter_vm_memory_used | The RAM statistics, including Total / Available / Used
| Prometheus node-exporter |
-| Memory Swap | MB | meter_vm_memory_swap_free<br />meter_vm_memory_swap_total
| The swap memory statistics, including Free / Total | Prometheus node-exporter
|
+| Memory Swap | MB | meter_vm_memory_swap_free<br />meter_vm_memory_swap_total
| Swap memory statistics, including Free / Total | Prometheus node-exporter |
| File System Mountpoint Usage | % | meter_vm_filesystem_percentage | The
percentage usage of the file system at each mount point | Prometheus
node-exporter |
| Disk R/W | KB/s | meter_vm_disk_read,meter_vm_disk_written | The disk read
and written | Prometheus node-exporter |
| Network Bandwidth Usage | KB/s | meter_vm_network_receive<br
/>meter_vm_network_transmit | The network receive and transmit | Prometheus
node-exporter |
diff --git a/docs/en/setup/backend/backend-zabbix.md
b/docs/en/setup/backend/backend-zabbix.md
index 513062b..97d0b19 100644
--- a/docs/en/setup/backend/backend-zabbix.md
+++ b/docs/en/setup/backend/backend-zabbix.md
@@ -1,8 +1,8 @@
# Zabbix Receiver
-Zabbix receiver is accepting the 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).
-Zabbix Agent is base on GPL-2.0 License.
+The Zabbix receiver acceps 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).
+Zabbix Agent is based on GPL-2.0 License.
-## Module define
+## Module definition
```yaml
receiver-zabbix:
selector: ${SW_RECEIVER_ZABBIX:default}
@@ -16,16 +16,16 @@ receiver-zabbix:
```
## Configuration file
-Zabbix receiver is configured via a configuration file. The configuration file
defines everything related to receiving
+The Zabbix receiver is configured via a configuration file that defines
everything related to receiving
from agents, as well as which rule files to load.
-OAP can load the configuration at bootstrap. If the new configuration is not
well-formed, OAP fails to start up. The files
+The OAP can load the configuration at bootstrap. If the new configuration is
not well-formed, the OAP fails to start up. The files
are located at `$CLASSPATH/zabbix-rules`.
The file is written in YAML format, defined by the scheme described below.
Square brackets indicate that a parameter is optional.
-An example for zabbix agent configuration could be found
[here](../../../../test/e2e/e2e-test/docker/zabbix/zabbix_agentd.conf).
-You could find the Zabbix agent detail items from [Zabbix Agent
documentation](https://www.zabbix.com/documentation/current/manual/config/items/itemtypes/zabbix_agent).
+An example for Zabbix agent configuration could be found
[here](../../../../test/e2e/e2e-test/docker/zabbix/zabbix_agentd.conf).
+You could find details on Zabbix agent items from [Zabbix Agent
documentation](https://www.zabbix.com/documentation/current/manual/config/items/itemtypes/zabbix_agent).
### Configuration file
@@ -70,4 +70,4 @@ name: <string>
exp: <string>
```
-More about MAL, please refer to [mal.md](../../concepts-and-designs/mal.md).
+For more on MAL, please refer to [mal.md](../../concepts-and-designs/mal.md).
diff --git a/docs/en/setup/backend/configuration-vocabulary.md
b/docs/en/setup/backend/configuration-vocabulary.md
index e671774..4592250 100644
--- a/docs/en/setup/backend/configuration-vocabulary.md
+++ b/docs/en/setup/backend/configuration-vocabulary.md
@@ -1,297 +1,296 @@
# Configuration Vocabulary
-Configuration Vocabulary lists all available configurations provided by
`application.yml`.
+The Configuration Vocabulary lists all available configurations provided by
`application.yml`.
Module | Provider | Settings | Value(s) and Explanation | System Environment
Variable¹ | Default |
----------- | ---------- | --------- | --------- |--------- |--------- |
-core|default|role|Option values, `Mixed/Receiver/Aggregator`. **Receiver**
mode OAP open the service to the agents, analysis and aggregate the results and
forward the results for distributed aggregation. Aggregator mode OAP receives
data from Mixer and Receiver role OAP nodes, and do 2nd level aggregation.
**Mixer** means being Receiver and Aggregator both.|SW_CORE_ROLE|Mixed|
-| - | - | restHost| Binding IP of restful service. Services include GraphQL
query and HTTP data report|SW_CORE_REST_HOST|0.0.0.0|
-| - | - | restPort | Binding port of restful service | SW_CORE_REST_PORT|12800|
-| - | - | restContextPath| Web context path of restful service|
SW_CORE_REST_CONTEXT_PATH|/|
-| - | - | restMinThreads| Min threads number of restful service|
SW_CORE_REST_JETTY_MIN_THREADS|1|
-| - | - | restMaxThreads| Max threads number of restful service|
SW_CORE_REST_JETTY_MAX_THREADS|200|
-| - | - | restIdleTimeOut| Connector idle timeout in milliseconds of restful
service| SW_CORE_REST_JETTY_IDLE_TIMEOUT|30000|
-| - | - | restAcceptorPriorityDelta| Thread priority delta to give to acceptor
threads of restful service| SW_CORE_REST_JETTY_DELTA|0|
-| - | - | restAcceptQueueSize| ServerSocketChannel backlog of restful
service| SW_CORE_REST_JETTY_QUEUE_SIZE|0|
-| - | - | httpMaxRequestHeaderSize| Maximum request header size accepted|
SW_CORE_HTTP_MAX_REQUEST_HEADER_SIZE|8192|
-| - | - | gRPCHost|Binding IP of gRPC service. Services include gRPC data
report and internal communication among OAP nodes|SW_CORE_GRPC_HOST|0.0.0.0|
-| - | - | gRPCPort| Binding port of gRPC service | SW_CORE_GRPC_PORT|11800|
-| - | - | gRPCSslEnabled| Activate SSL for gRPC service |
SW_CORE_GRPC_SSL_ENABLED|false|
-| - | - | gRPCSslKeyPath| The file path of gRPC SSL key|
SW_CORE_GRPC_SSL_KEY_PATH| - |
-| - | - | gRPCSslCertChainPath| The file path of gRPC SSL cert chain|
SW_CORE_GRPC_SSL_CERT_CHAIN_PATH| - |
-| - | - | gRPCSslTrustedCAPath| The file path of gRPC trusted CA|
SW_CORE_GRPC_SSL_TRUSTED_CA_PATH| - |
-| - | - | downsampling| The activated level of down sampling aggregation | |
Hour,Day|
-| - | - | persistentPeriod| The execution period of the persistent timer. Unit
is second. | | 25 |
-| - | - | enableDataKeeperExecutor|Controller of TTL scheduler. Once disabled,
TTL wouldn't work.|SW_CORE_ENABLE_DATA_KEEPER_EXECUTOR|true|
-| - | - | dataKeeperExecutePeriod|The execution period of TTL scheduler, unit
is minute. Execution doesn't mean deleting data. The storage provider could
override this, such as ElasticSearch
storage.|SW_CORE_DATA_KEEPER_EXECUTE_PERIOD|5|
-| - | - | recordDataTTL|The lifecycle of record data. Record data includes
traces, top n sampled records, and logs. Unit is day. Minimal value is
2.|SW_CORE_RECORD_DATA_TTL|3|
-| - | - | metricsDataTTL|The lifecycle of metrics data, including the
metadata. Unit is day. Recommend metricsDataTTL >= recordDataTTL. Minimal value
is 2.| SW_CORE_METRICS_DATA_TTL|7|
-| - | - | l1FlushPeriod| The period of L1 aggregation flush to L2 aggregation.
Unit is ms. | SW_CORE_L1_AGGREGATION_FLUSH_PERIOD | 500 |
-| - | - | storageSessionTimeout| The threshold of session time. Unit is ms.
Default value is 70s. | SW_CORE_STORAGE_SESSION_TIMEOUT | 70000 |
-| - | - | enableDatabaseSession|Cache metrics data for 1 minute to reduce
database queries, and if the OAP cluster changes within that
minute.|SW_CORE_ENABLE_DATABASE_SESSION|true|
-| - | - | topNReportPeriod|The execution period of top N sampler, which saves
sampled data into the storage. Unit is minute|SW_CORE_TOPN_REPORT_PERIOD|10|
-| - | - | activeExtraModelColumns|Append the names of entity, such as service
name, into the metrics storage
entities.|SW_CORE_ACTIVE_EXTRA_MODEL_COLUMNS|false|
-| - | - | serviceNameMaxLength| Max length limitation of service
name.|SW_SERVICE_NAME_MAX_LENGTH|70|
-| - | - | instanceNameMaxLength| Max length limitation of service instance
name. The max length of service + instance names should be less than
200.|SW_INSTANCE_NAME_MAX_LENGTH|70|
-| - | - | endpointNameMaxLength| Max length limitation of endpoint name. The
max length of service + endpoint names should be less than
240.|SW_ENDPOINT_NAME_MAX_LENGTH|150|
-| - | - | searchableTracesTags | Define the set of span tag keys, which should
be searchable through the GraphQL. Multiple values should be separated through
the comma. | SW_SEARCHABLE_TAG_KEYS |
http.method,status_code,db.type,db.instance,mq.queue,mq.topic,mq.broker|
-| - | - | searchableLogsTags | Define the set of log tag keys, which should be
searchable through the GraphQL. Multiple values should be separated through the
comma. | SW_SEARCHABLE_LOGS_TAG_KEYS | level |
-| - | - | searchableAlarmTags | Define the set of alarm tag keys, which should
be searchable through the GraphQL. Multiple values should be separated through
the comma. | SW_SEARCHABLE_ALARM_TAG_KEYS | level |
-| - | - | gRPCThreadPoolSize|Pool size of gRPC server|
SW_CORE_GRPC_THREAD_POOL_SIZE | CPU core * 4|
-| - | - | gRPCThreadPoolQueueSize| The queue size of gRPC server|
SW_CORE_GRPC_POOL_QUEUE_SIZE | 10000|
+core|default|role|Option values: `Mixed/Receiver/Aggregator`. **Receiver**
mode OAP opens the service to the agents, then analyzes and aggregates the
results, and forwards the results for distributed aggregation. Aggregator mode
OAP receives data from Mixer and Receiver role OAP nodes, and performs 2nd
level aggregation. **Mixer** means both Receiver and Aggregator.
|SW_CORE_ROLE|Mixed|
+| - | - | restHost| Binding IP of RESTful services. Services include GraphQL
query and HTTP data report. |SW_CORE_REST_HOST|0.0.0.0|
+| - | - | restPort | Binding port of RESTful services. |
SW_CORE_REST_PORT|12800|
+| - | - | restContextPath| Web context path of RESTful services. |
SW_CORE_REST_CONTEXT_PATH|/|
+| - | - | restMinThreads| Minimum thread number of RESTful services. |
SW_CORE_REST_JETTY_MIN_THREADS|1|
+| - | - | restMaxThreads| Maximum thread number of RESTful services. |
SW_CORE_REST_JETTY_MAX_THREADS|200|
+| - | - | restIdleTimeOut| Connector idle timeout of RESTful services (in
milliseconds). | SW_CORE_REST_JETTY_IDLE_TIMEOUT|30000|
+| - | - | restAcceptorPriorityDelta| Thread priority delta to give to acceptor
threads of RESTful services. | SW_CORE_REST_JETTY_DELTA|0|
+| - | - | restAcceptQueueSize| ServerSocketChannel Backlog of RESTful
services. | SW_CORE_REST_JETTY_QUEUE_SIZE|0|
+| - | - | httpMaxRequestHeaderSize| Maximum request header size accepted. |
SW_CORE_HTTP_MAX_REQUEST_HEADER_SIZE|8192|
+| - | - | gRPCHost| Binding IP of gRPC services, including gRPC data report
and internal communication among OAP nodes. |SW_CORE_GRPC_HOST|0.0.0.0|
+| - | - | gRPCPort| Binding port of gRPC services. | SW_CORE_GRPC_PORT|11800|
+| - | - | gRPCSslEnabled| Activates SSL for gRPC services. |
SW_CORE_GRPC_SSL_ENABLED|false|
+| - | - | gRPCSslKeyPath| File path of gRPC SSL key. |
SW_CORE_GRPC_SSL_KEY_PATH| - |
+| - | - | gRPCSslCertChainPath| File path of gRPC SSL cert chain. |
SW_CORE_GRPC_SSL_CERT_CHAIN_PATH| - |
+| - | - | gRPCSslTrustedCAPath| File path of gRPC trusted CA. |
SW_CORE_GRPC_SSL_TRUSTED_CA_PATH| - |
+| - | - | downsampling| Activated level of down sampling aggregation. | |
Hour,Day|
+| - | - | persistentPeriod| Execution period of the persistent timer (in
seconds). | | 25 |
+| - | - | enableDataKeeperExecutor| Controller of TTL scheduler. Once
disabled, TTL wouldn't work. |SW_CORE_ENABLE_DATA_KEEPER_EXECUTOR|true|
+| - | - | dataKeeperExecutePeriod| Execution period of TTL scheduler (in
minutes). Execution doesn't mean deleting data. The storage provider (e.g.
ElasticSearch storage) could override
this.|SW_CORE_DATA_KEEPER_EXECUTE_PERIOD|5|
+| - | - | recordDataTTL| The lifecycle of record data (in days). Record data
includes traces, top N sample records, and logs. Minimum value is 2.
|SW_CORE_RECORD_DATA_TTL|3|
+| - | - | metricsDataTTL| The lifecycle of metrics data (in days), including
metadata. We recommend setting metricsDataTTL >= recordDataTTL. Minimum value
is 2. | SW_CORE_METRICS_DATA_TTL|7|
+| - | - | l1FlushPeriod| The period of L1 aggregation flush to L2 aggregation
(in milliseconds). | SW_CORE_L1_AGGREGATION_FLUSH_PERIOD | 500 |
+| - | - | storageSessionTimeout| The threshold of session time (in
milliseconds). Default value is 70000. | SW_CORE_STORAGE_SESSION_TIMEOUT |
70000 |
+| - | - | enableDatabaseSession| Cache metrics data for 1 minute to reduce
database queries, and if the OAP cluster changes within that minute.
|SW_CORE_ENABLE_DATABASE_SESSION|true|
+| - | - | topNReportPeriod|The execution period (in minutes) of top N sampler,
which saves sampled data into the storage. |SW_CORE_TOPN_REPORT_PERIOD|10|
+| - | - | activeExtraModelColumns|Appends entity names (e.g. service names)
into metrics storage entities. |SW_CORE_ACTIVE_EXTRA_MODEL_COLUMNS|false|
+| - | - | serviceNameMaxLength| Maximum length limit of service names.
|SW_SERVICE_NAME_MAX_LENGTH|70|
+| - | - | instanceNameMaxLength| Maximum length limit of service instance
names. The maximum length of service + instance names should be less than
200.|SW_INSTANCE_NAME_MAX_LENGTH|70|
+| - | - | endpointNameMaxLength| Maximum length limit of endpoint names. The
maximum length of service + endpoint names should be less than
240.|SW_ENDPOINT_NAME_MAX_LENGTH|150|
+| - | - | searchableTracesTags | Defines a set of span tag keys which are
searchable through GraphQL. Multiple values are separated by commas. |
SW_SEARCHABLE_TAG_KEYS |
http.method,status_code,db.type,db.instance,mq.queue,mq.topic,mq.broker|
+| - | - | searchableLogsTags | Defines a set of log tag keys which are
searchable through GraphQL. Multiple values are separated by commas. |
SW_SEARCHABLE_LOGS_TAG_KEYS | level |
+| - | - | searchableAlarmTags | Defines a set of alarm tag keys which are
searchable through GraphQL. Multiple values are separated by commas. |
SW_SEARCHABLE_ALARM_TAG_KEYS | level |
+| - | - | gRPCThreadPoolSize| Pool size of gRPC server. |
SW_CORE_GRPC_THREAD_POOL_SIZE | CPU core * 4|
+| - | - | gRPCThreadPoolQueueSize| Queue size of gRPC server. |
SW_CORE_GRPC_POOL_QUEUE_SIZE | 10000|
| - | - | maxConcurrentCallsPerConnection | The maximum number of concurrent
calls permitted for each incoming connection. Defaults to no limit. |
SW_CORE_GRPC_MAX_CONCURRENT_CALL | - |
-| - | - | maxMessageSize | Sets the maximum message size allowed to be
received on the server. Empty means 4 MiB | SW_CORE_GRPC_MAX_MESSAGE_SIZE |
4M(based on Netty) |
-| - | - | remoteTimeout |Timeout for cluster internal communication, in
seconds.| - |20|
-| - | - | maxSizeOfNetworkAddressAlias|Max size of network address detected in
the be monitored system.| - | 1_000_000|
-| - | - | maxPageSizeOfQueryProfileSnapshot|The max size in every OAP query
for snapshot analysis| - | 500 |
-| - | - | maxSizeOfAnalyzeProfileSnapshot|The max number of snapshots analyzed
by OAP| - | 12000 |
-| - | - | prepareThreads|The number of threads used to prepare metrics data to
the storage.| SW_CORE_PREPARE_THREADS | 2 |
-| - | - | enableEndpointNameGroupingByOpenapi |Turn it on then automatically
grouping endpoint by the given OpenAPI definitions.|
SW_CORE_ENABLE_ENDPOINT_NAME_GROUPING_BY_OPAENAPI | true |
-|cluster|standalone| - | standalone is not suitable for one node running, no
available configuration.| - | - |
-| - | zookeeper|nameSpace|The namespace, represented by root path, isolates
the configurations in the zookeeper.|SW_NAMESPACE| `/`, root path|
-| - | - | hostPort|hosts and ports of Zookeeper
Cluster|SW_CLUSTER_ZK_HOST_PORT| localhost:2181|
-| - | - | baseSleepTimeMs|The period of Zookeeper client between two retries.
Unit is ms.|SW_CLUSTER_ZK_SLEEP_TIME|1000|
-| - | - | maxRetries| The max retry time of
re-trying.|SW_CLUSTER_ZK_MAX_RETRIES|3|
-| - | - | enableACL| Open ACL by using `schema` and
`expression`|SW_ZK_ENABLE_ACL| false|
-| - | - | schema | schema for the authorization|SW_ZK_SCHEMA|digest|
-| - | - | expression | expression for the
authorization|SW_ZK_EXPRESSION|skywalking:skywalking|
-| - | - | internalComHost| The hostname registered in the Zookeeper for the
internal communication of OAP cluster.| - | -|
-| - | - | internalComPort| The port registered in the Zookeeper for the
internal communication of OAP cluster.| - | -1|
-| - | kubernetes| namespace| Namespace SkyWalking deployed in the
k8s|SW_CLUSTER_K8S_NAMESPACE|default|
-| - | - | labelSelector| Labels used for filtering the OAP deployment in the
k8s|SW_CLUSTER_K8S_LABEL| app=collector,release=skywalking|
+| - | - | maxMessageSize | Sets the maximum message size allowed to be
received on the server. Empty means 4 MiB. | SW_CORE_GRPC_MAX_MESSAGE_SIZE |
4M(based on Netty) |
+| - | - | remoteTimeout | Timeout for cluster internal communication (in
seconds). | - |20|
+| - | - | maxSizeOfNetworkAddressAlias| The maximum size of network address
detected in the system being monitored. | - | 1_000_000|
+| - | - | maxPageSizeOfQueryProfileSnapshot| The maximum size for snapshot
analysis in an OAP query. | - | 500 |
+| - | - | maxSizeOfAnalyzeProfileSnapshot| The maximum number of snapshots
analyzed by the OAP. | - | 12000 |
+| - | - | prepareThreads| The number of threads used to prepare metrics data
to the storage. | SW_CORE_PREPARE_THREADS | 2 |
+| - | - | enableEndpointNameGroupingByOpenapi | Automatically groups endpoints
by the given OpenAPI definitions. |
SW_CORE_ENABLE_ENDPOINT_NAME_GROUPING_BY_OPAENAPI | true |
+|cluster|standalone| - | Standalone is not suitable for running on a single
node running. No configuration available. | - | - |
+| - | zookeeper|nameSpace| The namespace, represented by root path, isolates
the configurations in Zookeeper.|SW_NAMESPACE| `/`, root path|
+| - | - | hostPort| Hosts and ports of Zookeeper Cluster.
|SW_CLUSTER_ZK_HOST_PORT| localhost:2181|
+| - | - | baseSleepTimeMs| The period of Zookeeper client between two retries
(in milliseconds). |SW_CLUSTER_ZK_SLEEP_TIME|1000|
+| - | - | maxRetries| The maximum retry time. |SW_CLUSTER_ZK_MAX_RETRIES|3|
+| - | - | enableACL| Opens ACL using `schema` and `expression`.
|SW_ZK_ENABLE_ACL| false|
+| - | - | schema | Schema for the authorization. |SW_ZK_SCHEMA|digest|
+| - | - | expression | Expression for the authorization.
|SW_ZK_EXPRESSION|skywalking:skywalking|
+| - | - | internalComHost| The hostname registered in Zookeeper for the
internal communication of OAP cluster. | - | -|
+| - | - | internalComPort| The port registered in Zookeeper for the internal
communication of OAP cluster. | - | -1|
+| - | kubernetes| namespace| Namespace deployed by SkyWalking in k8s.
|SW_CLUSTER_K8S_NAMESPACE|default|
+| - | - | labelSelector| Labels used for filtering OAP deployment in k8s.
|SW_CLUSTER_K8S_LABEL| app=collector,release=skywalking|
| - | - | uidEnvName| Environment variable name for reading uid. |
SW_CLUSTER_K8S_UID|SKYWALKING_COLLECTOR_UID|
-| - | consul| serviceName| Service name used for SkyWalking cluster.
|SW_SERVICE_NAME|SkyWalking_OAP_Cluster|
-| - | - | hostPort| hosts and ports used of Consul cluster.|
SW_CLUSTER_CONSUL_HOST_PORT|localhost:8500|
-| - | - | aclToken| ALC Token of Consul. Empty string means `without ALC
token`.| SW_CLUSTER_CONSUL_ACLTOKEN | - |
-| - | - | internalComHost| The hostname registered in the Consul for the
internal communication of OAP cluster.| - | -|
-| - | - | internalComPort| The port registered in the Consul for the internal
communication of OAP cluster.| - | -1|
-| - | etcd| serviceName| Service name used for SkyWalking cluster.
|SW_CLUSTER_ETCD_SERVICE_NAME|SkyWalking_OAP_Cluster|
-| - | - | endpoints| hosts and ports used of etcd cluster.|
SW_CLUSTER_ETCD_ENDPOINTS|localhost:2379|
-| - | - | namespace | Namespace used for SkyWalking cluster.
|SW_CLUSTER_ETCD_NAMESPACE | /skywalking |
-| - | - | authentication | Whether has authentication. |
SW_CLUSTER_ETCD_AUTHENTICATION | false |
-| - | - | user | Etcd auth username | SW_CLUSTER_ETCD_USER | |
-| - | - | password | Etcd auth password | SW_CLUSTER_ETCD_PASSWORD | |
-| - | Nacos| serviceName| Service name used for SkyWalking cluster.
|SW_SERVICE_NAME|SkyWalking_OAP_Cluster|
-| - | - | hostPort| hosts and ports used of Nacos cluster.|
SW_CLUSTER_NACOS_HOST_PORT|localhost:8848|
-| - | - | namespace| Namespace used by SkyWalking node coordination.|
SW_CLUSTER_NACOS_NAMESPACE|public|
-| - | - | internalComHost| The hostname registered in the Nacos for the
internal communication of OAP cluster.| - | -|
-| - | - | internalComPort| The port registered in the Nacos for the internal
communication of OAP cluster.| - | -1|
-| - | - | username | Nacos Auth username | SW_CLUSTER_NACOS_USERNAME | - |
-| - | - | password | Nacos Auth password | SW_CLUSTER_NACOS_PASSWORD | - |
-| - | - | accessKey | Nacos Auth accessKey | SW_CLUSTER_NACOS_ACCESSKEY | - |
-| - | - | secretKey | Nacos Auth secretKey | SW_CLUSTER_NACOS_SECRETKEY | - |
-| storage|elasticsearch| - | ElasticSearch 6 storage implementation | - | - |
+| - | consul| serviceName| Service name for SkyWalking cluster.
|SW_SERVICE_NAME|SkyWalking_OAP_Cluster|
+| - | - | hostPort| Hosts and ports for Consul cluster.|
SW_CLUSTER_CONSUL_HOST_PORT|localhost:8500|
+| - | - | aclToken| ACL Token of Consul. Empty string means `without ALC
token`. | SW_CLUSTER_CONSUL_ACLTOKEN | - |
+| - | - | internalComHost| The hostname registered in Consul for internal
communications of the OAP cluster. | - | -|
+| - | - | internalComPort| The port registered in Consul for internal
communications of the OAP cluster. | - | -1|
+| - | etcd| serviceName| Service name for SkyWalking cluster.
|SW_CLUSTER_ETCD_SERVICE_NAME|SkyWalking_OAP_Cluster|
+| - | - | endpoints| Hosts and ports for etcd cluster. |
SW_CLUSTER_ETCD_ENDPOINTS|localhost:2379|
+| - | - | namespace | Namespace for SkyWalking cluster.
|SW_CLUSTER_ETCD_NAMESPACE | /skywalking |
+| - | - | authentication | Indicates whether there is authentication. |
SW_CLUSTER_ETCD_AUTHENTICATION | false |
+| - | - | user | Etcd auth username. | SW_CLUSTER_ETCD_USER | |
+| - | - | password | Etcd auth password. | SW_CLUSTER_ETCD_PASSWORD | |
+| - | Nacos| serviceName| Service name for SkyWalking cluster.
|SW_SERVICE_NAME|SkyWalking_OAP_Cluster|
+| - | - | hostPort| Hosts and ports for Nacos cluster.|
SW_CLUSTER_NACOS_HOST_PORT|localhost:8848|
+| - | - | namespace| Namespace used by SkyWalking node coordination. |
SW_CLUSTER_NACOS_NAMESPACE|public|
+| - | - | internalComHost| The hostname registered in Nacos for internal
communications of the OAP cluster. | - | -|
+| - | - | internalComPort| The port registered in Nacos for internal
communications of the OAP cluster. | - | -1|
+| - | - | username | Nacos Auth username. | SW_CLUSTER_NACOS_USERNAME | - |
+| - | - | password | Nacos Auth password. | SW_CLUSTER_NACOS_PASSWORD | - |
+| - | - | accessKey | Nacos Auth accessKey. | SW_CLUSTER_NACOS_ACCESSKEY | - |
+| - | - | secretKey | Nacos Auth secretKey. | SW_CLUSTER_NACOS_SECRETKEY | - |
+| storage|elasticsearch| - | ElasticSearch 6 storage implementation. | - | - |
| - | - | nameSpace | Prefix of indexes created and used by SkyWalking. |
SW_NAMESPACE | - |
| - | - | clusterNodes | ElasticSearch cluster nodes for client connection.|
SW_STORAGE_ES_CLUSTER_NODES |localhost|
| - | - | protocol | HTTP or HTTPs. | SW_STORAGE_ES_HTTP_PROTOCOL | HTTP|
-| - | - | connectTimeout | Connect timeout of ElasticSearch client. Unit is
ms. | SW_STORAGE_ES_CONNECT_TIMEOUT | 500|
-| - | - | socketTimeout | Socket timeout of ElasticSearch client. Unit is ms.
| SW_STORAGE_ES_SOCKET_TIMEOUT | 30000|
-| - | - | user| User name of ElasticSearch cluster| SW_ES_USER | - |
-| - | - | password | Password of ElasticSearch cluster | SW_ES_PASSWORD | - |
-| - | - | trustStorePath | Trust JKS file path. Only work when user name and
password opened | SW_STORAGE_ES_SSL_JKS_PATH | - |
-| - | - | trustStorePass | Trust JKS file password. Only work when user name
and password opened | SW_STORAGE_ES_SSL_JKS_PASS | - |
-| - | - | secretsManagementFile| Secrets management file in the properties
format includes the username, password, which are managed by 3rd party tool.
Provide the capability to update them in the
runtime.|SW_ES_SECRETS_MANAGEMENT_FILE | - |
-| - | - | dayStep| Represent the number of days in the one minute/hour/day
index.| SW_STORAGE_DAY_STEP | 1|
-| - | - | indexShardsNumber | Shard number of new indexes |
SW_STORAGE_ES_INDEX_SHARDS_NUMBER | 1 |
-| - | - | indexReplicasNumber | Replicas number of new indexes |
SW_STORAGE_ES_INDEX_REPLICAS_NUMBER | 0 |
-| - | - | superDatasetDayStep | Represent the number of days in the super size
dataset record index, the default value is the same as dayStep when the value
is less than 0.|SW_SUPERDATASET_STORAGE_DAY_STEP|-1 |
-| - | - | superDatasetIndexShardsFactor | Super data set has been defined in
the codes, such as trace segments. This factor provides more shards for the
super data set, shards number = indexShardsNumber *
superDatasetIndexShardsFactor. Also, this factor effects Zipkin and Jaeger
traces.|SW_STORAGE_ES_SUPER_DATASET_INDEX_SHARDS_FACTOR|5 |
-| - | - | superDatasetIndexReplicasNumber | Represent the replicas number in
the super size dataset record
index.|SW_STORAGE_ES_SUPER_DATASET_INDEX_REPLICAS_NUMBER|0 |
+| - | - | connectTimeout | Connect timeout of ElasticSearch client (in
milliseconds). | SW_STORAGE_ES_CONNECT_TIMEOUT | 500|
+| - | - | socketTimeout | Socket timeout of ElasticSearch client (in
milliseconds). | SW_STORAGE_ES_SOCKET_TIMEOUT | 30000|
+| - | - | user| Username of ElasticSearch cluster. | SW_ES_USER | - |
+| - | - | password | Password of ElasticSearch cluster. | SW_ES_PASSWORD | - |
+| - | - | trustStorePath | Trust JKS file path. Only works when username and
password are enabled. | SW_STORAGE_ES_SSL_JKS_PATH | - |
+| - | - | trustStorePass | Trust JKS file password. Only works when username
and password are enabled. | SW_STORAGE_ES_SSL_JKS_PASS | - |
+| - | - | secretsManagementFile| Secrets management file in the properties
format, including username and password, which are managed by a 3rd party tool.
Capable of being updated them at runtime. |SW_ES_SECRETS_MANAGEMENT_FILE | - |
+| - | - | dayStep| Represents the number of days in the one-minute/hour/day
index. | SW_STORAGE_DAY_STEP | 1|
+| - | - | indexShardsNumber | Shard number of new indexes. |
SW_STORAGE_ES_INDEX_SHARDS_NUMBER | 1 |
+| - | - | indexReplicasNumber | Replicas number of new indexes. |
SW_STORAGE_ES_INDEX_REPLICAS_NUMBER | 0 |
+| - | - | superDatasetDayStep | Represents the number of days in the super
size dataset record index. Default value is the same as dayStep when the value
is less than 0. |SW_SUPERDATASET_STORAGE_DAY_STEP|-1 |
+| - | - | superDatasetIndexShardsFactor | Super dataset is defined in the code
(e.g. trace segments). This factor provides more shards for the super dataset:
shards number = indexShardsNumber * superDatasetIndexShardsFactor. This factor
also affects Zipkin and Jaeger traces.
|SW_STORAGE_ES_SUPER_DATASET_INDEX_SHARDS_FACTOR|5 |
+| - | - | superDatasetIndexReplicasNumber | Represents the replicas number in
the super size dataset record index.
|SW_STORAGE_ES_SUPER_DATASET_INDEX_REPLICAS_NUMBER|0 |
| - | - | indexTemplateOrder| The order of index template. |
SW_STORAGE_ES_INDEX_TEMPLATE_ORDER| 0|
| - | - | bulkActions| Async bulk size of the record data batch execution. |
SW_STORAGE_ES_BULK_ACTIONS| 5000|
-| - | - | flushInterval| Period of flush, no matter `bulkActions` reached or
not. Unit is second. INT(flushInterval * 2/3) would be used for index refresh
period.| SW_STORAGE_ES_FLUSH_INTERVAL | 15 (index refresh period = 10)|
+| - | - | flushInterval| Period of flush (in seconds). Does not matter whether
`bulkActions` is reached or not. INT(flushInterval * 2/3) is used for index
refresh period. | SW_STORAGE_ES_FLUSH_INTERVAL | 15 (index refresh period = 10)|
| - | - | concurrentRequests| The number of concurrent requests allowed to be
executed. | SW_STORAGE_ES_CONCURRENT_REQUESTS| 2 |
-| - | - | resultWindowMaxSize | The max size of dataset when OAP loading
cache, such as network alias. | SW_STORAGE_ES_QUERY_MAX_WINDOW_SIZE | 10000|
-| - | - | metadataQueryMaxSize | The max size of metadata per query. |
SW_STORAGE_ES_QUERY_MAX_SIZE | 5000 |
-| - | - | segmentQueryMaxSize | The max size of trace segments per query. |
SW_STORAGE_ES_QUERY_SEGMENT_SIZE | 200|
-| - | - | profileTaskQueryMaxSize | The max size of profile task per query. |
SW_STORAGE_ES_QUERY_PROFILE_TASK_SIZE | 200|
-| - | - | advanced | All settings of ElasticSearch index creation. The value
should be in JSON format | SW_STORAGE_ES_ADVANCED | - |
-| - |elasticsearch7| - | ElasticSearch 7 storage implementation | - | - |
+| - | - | resultWindowMaxSize | The maximum size of dataset when the OAP loads
cache, such as network aliases. | SW_STORAGE_ES_QUERY_MAX_WINDOW_SIZE | 10000|
+| - | - | metadataQueryMaxSize | The maximum size of metadata per query. |
SW_STORAGE_ES_QUERY_MAX_SIZE | 5000 |
+| - | - | segmentQueryMaxSize | The maximum size of trace segments per query.
| SW_STORAGE_ES_QUERY_SEGMENT_SIZE | 200|
+| - | - | profileTaskQueryMaxSize | The maximum size of profile task per
query. | SW_STORAGE_ES_QUERY_PROFILE_TASK_SIZE | 200|
+| - | - | advanced | All settings of ElasticSearch index creation. The value
should be in JSON format. | SW_STORAGE_ES_ADVANCED | - |
+| - |elasticsearch7| - | ElasticSearch 7 storage implementation. | - | - |
| - | - | nameSpace | Prefix of indexes created and used by SkyWalking. |
SW_NAMESPACE | - |
| - | - | clusterNodes | ElasticSearch cluster nodes for client connection.|
SW_STORAGE_ES_CLUSTER_NODES |localhost|
| - | - | protocol | HTTP or HTTPs. | SW_STORAGE_ES_HTTP_PROTOCOL | HTTP|
-| - | - | connectTimeout | Connect timeout of ElasticSearch client. Unit is
ms. | SW_STORAGE_ES_CONNECT_TIMEOUT | 500|
-| - | - | socketTimeout | Socket timeout of ElasticSearch client. Unit is ms.
| SW_STORAGE_ES_SOCKET_TIMEOUT | 30000|
-| - | - | user| User name of ElasticSearch cluster| SW_ES_USER | - |
-| - | - | password | Password of ElasticSearch cluster | SW_ES_PASSWORD | - |
-| - | - | trustStorePath | Trust JKS file path. Only work when user name and
password opened | SW_STORAGE_ES_SSL_JKS_PATH | - |
-| - | - | trustStorePass | Trust JKS file password. Only work when user name
and password opened | SW_STORAGE_ES_SSL_JKS_PASS | - |
-| - | - | secretsManagementFile| Secrets management file in the properties
format includes the username, password, which are managed by 3rd party tool.
Provide the capability to update them in the
runtime.|SW_ES_SECRETS_MANAGEMENT_FILE | - |
-| - | - | dayStep| Represent the number of days in the one minute/hour/day
index.| SW_STORAGE_DAY_STEP | 1|
-| - | - | indexShardsNumber | Shard number of new indexes |
SW_STORAGE_ES_INDEX_SHARDS_NUMBER | 1 |
-| - | - | indexReplicasNumber | Replicas number of new indexes |
SW_STORAGE_ES_INDEX_REPLICAS_NUMBER | 0 |
-| - | - | superDatasetDayStep | Represent the number of days in the super size
dataset record index, the default value is the same as dayStep when the value
is less than 0.|SW_SUPERDATASET_STORAGE_DAY_STEP|-1 |
-| - | - | superDatasetIndexShardsFactor | Super data set has been defined in
the codes, such as trace segments. This factor provides more shards for the
super data set, shards number = indexShardsNumber *
superDatasetIndexShardsFactor. Also, this factor effects Zipkin and Jaeger
traces.|SW_STORAGE_ES_SUPER_DATASET_INDEX_SHARDS_FACTOR|5 |
-| - | - | superDatasetIndexReplicasNumber | Represent the replicas number in
the super size dataset record
index.|SW_STORAGE_ES_SUPER_DATASET_INDEX_REPLICAS_NUMBER|0 |
+| - | - | connectTimeout | Connect timeout of ElasticSearch client (in
milliseconds). | SW_STORAGE_ES_CONNECT_TIMEOUT | 500|
+| - | - | socketTimeout | Socket timeout of ElasticSearch client (in
milliseconds). | SW_STORAGE_ES_SOCKET_TIMEOUT | 30000|
+| - | - | user| Username of ElasticSearch cluster.| SW_ES_USER | - |
+| - | - | password | Password of ElasticSearch cluster. | SW_ES_PASSWORD | - |
+| - | - | trustStorePath | Trust JKS file path. Only works when username and
password are enabled. | SW_STORAGE_ES_SSL_JKS_PATH | - |
+| - | - | trustStorePass | Trust JKS file password. Only works when username
and password are enabled. | SW_STORAGE_ES_SSL_JKS_PASS | - |
+| - | - | secretsManagementFile| Secrets management file in the properties
format, including username and password, which are managed by a 3rd party tool.
Capable of being updated at runtime. |SW_ES_SECRETS_MANAGEMENT_FILE | - |
+| - | - | dayStep| Represents the number of days in the one-minute/hour/day
index. | SW_STORAGE_DAY_STEP | 1|
+| - | - | indexShardsNumber | Shard number of new indexes. |
SW_STORAGE_ES_INDEX_SHARDS_NUMBER | 1 |
+| - | - | indexReplicasNumber | Replicas number of new indexes. |
SW_STORAGE_ES_INDEX_REPLICAS_NUMBER | 0 |
+| - | - | superDatasetDayStep | Represents the number of days in the super
size dataset record index. Default value is the same as dayStep when the value
is less than 0. |SW_SUPERDATASET_STORAGE_DAY_STEP|-1 |
+| - | - | superDatasetIndexShardsFactor | Super dataset is defined in the code
(e.g. trace segments). This factor provides more shards for the super dataset:
shards number = indexShardsNumber * superDatasetIndexShardsFactor. This factor
also affects Zipkin and Jaeger traces.
|SW_STORAGE_ES_SUPER_DATASET_INDEX_SHARDS_FACTOR|5 |
+| - | - | superDatasetIndexReplicasNumber | Represents the replicas number in
the super size dataset record index.
|SW_STORAGE_ES_SUPER_DATASET_INDEX_REPLICAS_NUMBER|0 |
| - | - | indexTemplateOrder| The order of index template. |
SW_STORAGE_ES_INDEX_TEMPLATE_ORDER| 0|
| - | - | bulkActions| Async bulk size of data batch execution. |
SW_STORAGE_ES_BULK_ACTIONS| 5000|
-| - | - | flushInterval| Period of flush, no matter `bulkActions` reached or
not. Unit is second. INT(flushInterval * 2/3) would be used for index refresh
period.| SW_STORAGE_ES_FLUSH_INTERVAL | 15 (index refresh period = 10)|
+| - | - | flushInterval| Period of flush (in seconds). Does not matter whether
`bulkActions` is reached or not. INT(flushInterval * 2/3) is used for index
refresh period. | SW_STORAGE_ES_FLUSH_INTERVAL | 15 (index refresh period = 10)|
| - | - | concurrentRequests| The number of concurrent requests allowed to be
executed. | SW_STORAGE_ES_CONCURRENT_REQUESTS| 2 |
-| - | - | resultWindowMaxSize | The max size of dataset when OAP loading
cache, such as network alias. | SW_STORAGE_ES_QUERY_MAX_WINDOW_SIZE | 10000|
-| - | - | metadataQueryMaxSize | The max size of metadata per query. |
SW_STORAGE_ES_QUERY_MAX_SIZE | 5000 |
-| - | - | segmentQueryMaxSize | The max size of trace segments per query. |
SW_STORAGE_ES_QUERY_SEGMENT_SIZE | 200|
-| - | - | profileTaskQueryMaxSize | The max size of profile task per query. |
SW_STORAGE_ES_QUERY_PROFILE_TASK_SIZE | 200|
-| - | - | advanced | All settings of ElasticSearch index creation. The value
should be in JSON format | SW_STORAGE_ES_ADVANCED | - |
-| - |h2| - | H2 storage is designed for demonstration and running in short
term(1-2 hours) only | - | - |
+| - | - | resultWindowMaxSize | The maximum size of dataset when the OAP loads
cache, such as network aliases. | SW_STORAGE_ES_QUERY_MAX_WINDOW_SIZE | 10000|
+| - | - | metadataQueryMaxSize | The maximum size of metadata per query. |
SW_STORAGE_ES_QUERY_MAX_SIZE | 5000 |
+| - | - | segmentQueryMaxSize | The maximum size of trace segments per query.
| SW_STORAGE_ES_QUERY_SEGMENT_SIZE | 200|
+| - | - | profileTaskQueryMaxSize | The maximum size of profile task per
query. | SW_STORAGE_ES_QUERY_PROFILE_TASK_SIZE | 200|
+| - | - | advanced | All settings of ElasticSearch index creation. The value
should be in JSON format. | SW_STORAGE_ES_ADVANCED | - |
+| - |h2| - | H2 storage is designed for demonstration and running in short
term (i.e. 1-2 hours) only. | - | - |
| - | - | driver | H2 JDBC driver. | SW_STORAGE_H2_DRIVER |
org.h2.jdbcx.JdbcDataSource|
-| - | - | url | H2 connection URL. Default is H2 memory mode |
SW_STORAGE_H2_URL | jdbc:h2:mem:skywalking-oap-db |
-| - | - | user | User name of H2 database. | SW_STORAGE_H2_USER | sa |
+| - | - | url | H2 connection URL. Defaults to H2 memory mode. |
SW_STORAGE_H2_URL | jdbc:h2:mem:skywalking-oap-db |
+| - | - | user | Username of H2 database. | SW_STORAGE_H2_USER | sa |
| - | - | password | Password of H2 database. | - | - |
-| - | - | metadataQueryMaxSize | The max size of metadata per query. |
SW_STORAGE_H2_QUERY_MAX_SIZE | 5000 |
-| - | - | maxSizeOfArrayColumn | Some entities, such as trace segment, include
the logic column with multiple values. In the H2, we use multiple physical
columns to host the values, such as, Change column_a with values [1,2,3,4,5] to
`column_a_0 = 1, column_a_1 = 2, column_a_2 = 3 , column_a_3 = 4, column_a_4 =
5` | SW_STORAGE_MAX_SIZE_OF_ARRAY_COLUMN | 20 |
-| - | - | numOfSearchableValuesPerTag | In a trace segment, it includes
multiple spans with multiple tags. Different spans could have same tag keys,
such as multiple HTTP exit spans all have their own `http.method` tag. This
configuration set the limitation of max num of values for the same tag key. |
SW_STORAGE_NUM_OF_SEARCHABLE_VALUES_PER_TAG | 2 |
-| - |mysql| - | MySQL Storage. The MySQL JDBC Driver is not in the dist,
please copy it into oap-lib folder manually | - | - |
-| - | - | properties | Hikari connection pool configurations | - | Listed in
the `application.yaml`. |
-| - | - | metadataQueryMaxSize | The max size of metadata per query. |
SW_STORAGE_MYSQL_QUERY_MAX_SIZE | 5000 |
-| - | - | maxSizeOfArrayColumn | Some entities, such as trace segment, include
the logic column with multiple values. In the MySQL, we use multiple physical
columns to host the values, such as, Change column_a with values [1,2,3,4,5] to
`column_a_0 = 1, column_a_1 = 2, column_a_2 = 3 , column_a_3 = 4, column_a_4 =
5` | SW_STORAGE_MAX_SIZE_OF_ARRAY_COLUMN | 20 |
-| - | - | numOfSearchableValuesPerTag | In a trace segment, it includes
multiple spans with multiple tags. Different spans could have same tag keys,
such as multiple HTTP exit spans all have their own `http.method` tag. This
configuration set the limitation of max num of values for the same tag key. |
SW_STORAGE_NUM_OF_SEARCHABLE_VALUES_PER_TAG | 2 |
+| - | - | metadataQueryMaxSize | The maximum size of metadata per query. |
SW_STORAGE_H2_QUERY_MAX_SIZE | 5000 |
+| - | - | maxSizeOfArrayColumn | Some entities (e.g. trace segments) include
the logic column with multiple values. In H2, we use multiple physical columns
to host the values: e.g. change column_a with values [1,2,3,4,5] to `column_a_0
= 1, column_a_1 = 2, column_a_2 = 3 , column_a_3 = 4, column_a_4 = 5`. |
SW_STORAGE_MAX_SIZE_OF_ARRAY_COLUMN | 20 |
+| - | - | numOfSearchableValuesPerTag | In a trace segment, this includes
multiple spans with multiple tags. Different spans may have the same tag key,
e.g. multiple HTTP exit spans all have their own `http.method` tags. This
configuration sets the limit on the maximum number of values for the same tag
key. | SW_STORAGE_NUM_OF_SEARCHABLE_VALUES_PER_TAG | 2 |
+| - |mysql| - | MySQL Storage. The MySQL JDBC Driver is not in the dist.
Please copy it into the oap-lib folder manually. | - | - |
+| - | - | properties | Hikari connection pool configurations. | - | Listed in
the `application.yaml`. |
+| - | - | metadataQueryMaxSize | The maximum size of metadata per query. |
SW_STORAGE_MYSQL_QUERY_MAX_SIZE | 5000 |
+| - | - | maxSizeOfArrayColumn | Some entities (e.g. trace segments) include
the logic column with multiple values. In MySQL, we use multiple physical
columns to host the values, e.g. change column_a with values [1,2,3,4,5] to
`column_a_0 = 1, column_a_1 = 2, column_a_2 = 3 , column_a_3 = 4, column_a_4 =
5`. | SW_STORAGE_MAX_SIZE_OF_ARRAY_COLUMN | 20 |
+| - | - | numOfSearchableValuesPerTag | In a trace segment, this includes
multiple spans with multiple tags. Different spans may have same tag key, e.g.
multiple HTTP exit spans all have their own `http.method` tags. This
configuration sets the limit on the maximum number of values for the same tag
key. | SW_STORAGE_NUM_OF_SEARCHABLE_VALUES_PER_TAG | 2 |
| - |postgresql| - | PostgreSQL storage. | - | - |
-| - | - | properties | Hikari connection pool configurations | - | Listed in
the `application.yaml`. |
-| - | - | metadataQueryMaxSize | The max size of metadata per query. |
SW_STORAGE_MYSQL_QUERY_MAX_SIZE | 5000 |
-| - | - | maxSizeOfArrayColumn | Some entities, such as trace segment, include
the logic column with multiple values. In the PostgreSQL, we use multiple
physical columns to host the values, such as, Change column_a with values
[1,2,3,4,5] to `column_a_0 = 1, column_a_1 = 2, column_a_2 = 3 , column_a_3 =
4, column_a_4 = 5` | SW_STORAGE_MAX_SIZE_OF_ARRAY_COLUMN | 20 |
-| - | - | numOfSearchableValuesPerTag | In a trace segment, it includes
multiple spans with multiple tags. Different spans could have same tag keys,
such as multiple HTTP exit spans all have their own `http.method` tag. This
configuration set the limitation of max num of values for the same tag key. |
SW_STORAGE_NUM_OF_SEARCHABLE_VALUES_PER_TAG | 2 |
+| - | - | properties | Hikari connection pool configurations. | - | Listed in
the `application.yaml`. |
+| - | - | metadataQueryMaxSize | The maximum size of metadata per query. |
SW_STORAGE_MYSQL_QUERY_MAX_SIZE | 5000 |
+| - | - | maxSizeOfArrayColumn | Some entities (e.g. trace segments) include
the logic column with multiple values. In PostgreSQL, we use multiple physical
columns to host the values, e.g. change column_a with values [1,2,3,4,5] to
`column_a_0 = 1, column_a_1 = 2, column_a_2 = 3 , column_a_3 = 4, column_a_4 =
5` | SW_STORAGE_MAX_SIZE_OF_ARRAY_COLUMN | 20 |
+| - | - | numOfSearchableValuesPerTag | In a trace segment, this includes
multiple spans with multiple tags. Different spans may have same tag key, e.g.
multiple HTTP exit spans all have their own `http.method` tags. This
configuration sets the limit on the maximum number of values for the same tag
key. | SW_STORAGE_NUM_OF_SEARCHABLE_VALUES_PER_TAG | 2 |
| - |influxdb| - | InfluxDB storage. |- | - |
| - | - | url| InfluxDB connection URL. | SW_STORAGE_INFLUXDB_URL |
http://localhost:8086|
| - | - | user | User name of InfluxDB. | SW_STORAGE_INFLUXDB_USER | root|
| - | - | password | Password of InfluxDB. | SW_STORAGE_INFLUXDB_PASSWORD | -|
| - | - | database | Database of InfluxDB. | SW_STORAGE_INFLUXDB_DATABASE |
skywalking |
| - | - | actions | The number of actions to collect. |
SW_STORAGE_INFLUXDB_ACTIONS | 1000 |
-| - | - | duration | The time to wait at most (milliseconds). |
SW_STORAGE_INFLUXDB_DURATION | 1000|
-| - | - | batchEnabled | If true, write points with batch api. |
SW_STORAGE_INFLUXDB_BATCH_ENABLED | true|
-| - | - | fetchTaskLogMaxSize | The max number of fetch task log in a request.
| SW_STORAGE_INFLUXDB_FETCH_TASK_LOG_MAX_SIZE | 5000|
-| - | - | connectionResponseFormat | The response format of connection to
influxDB, cannot be anything but MSGPACK or JSON. |
SW_STORAGE_INFLUXDB_CONNECTION_RESPONSE_FORMAT | MSGPACK |
+| - | - | duration | The maximum waiting time (in milliseconds). |
SW_STORAGE_INFLUXDB_DURATION | 1000|
+| - | - | batchEnabled | If true, write points with batch API. |
SW_STORAGE_INFLUXDB_BATCH_ENABLED | true|
+| - | - | fetchTaskLogMaxSize | The maximum number of fetch task log in a
request. | SW_STORAGE_INFLUXDB_FETCH_TASK_LOG_MAX_SIZE | 5000|
+| - | - | connectionResponseFormat | The response format of connection to
influxDB. It can only be MSGPACK or JSON. |
SW_STORAGE_INFLUXDB_CONNECTION_RESPONSE_FORMAT | MSGPACK |
| agent-analyzer | default | Agent Analyzer. | SW_AGENT_ANALYZER | default |
-| - | -| sampleRate|Sampling rate for receiving trace. The precision is
1/10000. 10000 means 100% sample in default.|SW_TRACE_SAMPLE_RATE|10000|
-| - | - |slowDBAccessThreshold|The slow database access thresholds. Unit
ms.|SW_SLOW_DB_THRESHOLD|default:200,mongodb:100|
-| - | - |forceSampleErrorSegment|When sampling mechanism activated, this
config would make the error status segment sampled, ignoring the sampling
rate.|SW_FORCE_SAMPLE_ERROR_SEGMENT|true|
-| - | - |segmentStatusAnalysisStrategy|Determine the final segment status from
the status of spans. Available values are `FROM_SPAN_STATUS` ,
`FROM_ENTRY_SPAN` and `FROM_FIRST_SPAN`. `FROM_SPAN_STATUS` represents the
segment status would be error if any span is in error status. `FROM_ENTRY_SPAN`
means the segment status would be determined by the status of entry spans only.
`FROM_FIRST_SPAN` means the segment status would be determined by the status of
the first span only.|SW_SEGMENT_STA [...]
-| - | - |noUpstreamRealAddressAgents|Exit spans with the component in the list
would not generate the client-side instance relation metrics. As some tracing
plugins can't collect the real peer ip address, such as Nginx-LUA and Envoy.
|SW_NO_UPSTREAM_REAL_ADDRESS|6000,9000|
-| - | - |slowTraceSegmentThreshold|Setting this threshold about the latency
would make the slow trace segments sampled if they cost more time, even the
sampling mechanism activated. The default value is `-1`, which means would not
sample slow traces. Unit, millisecond. |SW_SLOW_TRACE_SEGMENT_THRESHOLD|-1|
-| - | - |meterAnalyzerActiveFiles|Which files could be meter analyzed, files
split by ","|SW_METER_ANALYZER_ACTIVE_FILES||
-| receiver-sharing-server|default| Sharing server provides new gRPC and
restful servers for data collection. Ana make the servers in the core module
working for internal communication only.| - | - |
-| - | - | restHost| Binding IP of restful service. Services include GraphQL
query and HTTP data report| SW_RECEIVER_SHARING_REST_HOST | - |
-| - | - | restPort | Binding port of restful service |
SW_RECEIVER_SHARING_REST_PORT | - |
-| - | - | restContextPath| Web context path of restful service|
SW_RECEIVER_SHARING_REST_CONTEXT_PATH | - |
-| - | - | restMinThreads| Min threads number of restful service|
SW_RECEIVER_SHARING_JETTY_MIN_THREADS|1|
-| - | - | restMaxThreads| Max threads number of restful service|
SW_RECEIVER_SHARING_JETTY_MAX_THREADS|200|
-| - | - | restIdleTimeOut| Connector idle timeout in milliseconds of restful
service| SW_RECEIVER_SHARING_JETTY_IDLE_TIMEOUT|30000|
-| - | - | restAcceptorPriorityDelta| Thread priority delta to give to acceptor
threads of restful service| SW_RECEIVER_SHARING_JETTY_DELTA|0|
-| - | - | restAcceptQueueSize| ServerSocketChannel backlog of restful
service| SW_RECEIVER_SHARING_JETTY_QUEUE_SIZE|0|
-| - | - | httpMaxRequestHeaderSize| Maximum request header size accepted|
SW_RECEIVER_SHARING_HTTP_MAX_REQUEST_HEADER_SIZE|8192|
-| - | - | gRPCHost|Binding IP of gRPC service. Services include gRPC data
report and internal communication among OAP nodes| SW_RECEIVER_GRPC_HOST |
0.0.0.0. Not Activated |
-| - | - | gRPCPort| Binding port of gRPC service | SW_RECEIVER_GRPC_PORT | Not
Activated |
-| - | - | gRPCThreadPoolSize|Pool size of gRPC server|
SW_RECEIVER_GRPC_THREAD_POOL_SIZE | CPU core * 4|
-| - | - | gRPCThreadPoolQueueSize| The queue size of gRPC server|
SW_RECEIVER_GRPC_POOL_QUEUE_SIZE | 10000|
-| - | - | gRPCSslEnabled| Activate SSL for gRPC service |
SW_RECEIVER_GRPC_SSL_ENABLED | false |
-| - | - | gRPCSslKeyPath| The file path of gRPC SSL key|
SW_RECEIVER_GRPC_SSL_KEY_PATH | - |
-| - | - | gRPCSslCertChainPath| The file path of gRPC SSL cert chain|
SW_RECEIVER_GRPC_SSL_CERT_CHAIN_PATH | - |
+| - | -| sampleRate| Sampling rate for receiving trace. Precise to 1/10000.
10000 means a sampling rate of 100% by default.|SW_TRACE_SAMPLE_RATE|10000|
+| - | - |slowDBAccessThreshold| The slow database access threshold (in
milliseconds). |SW_SLOW_DB_THRESHOLD|default:200,mongodb:100|
+| - | - |forceSampleErrorSegment| When sampling mechanism is activated, this
config samples the error status segment and ignores the sampling rate.
|SW_FORCE_SAMPLE_ERROR_SEGMENT|true|
+| - | - |segmentStatusAnalysisStrategy| Determines the final segment status
from span status. Available values are `FROM_SPAN_STATUS` , `FROM_ENTRY_SPAN`,
and `FROM_FIRST_SPAN`. `FROM_SPAN_STATUS` indicates that the segment status
would be error if any span has an error status. `FROM_ENTRY_SPAN` means that
the segment status would only be determined by the status of entry spans.
`FROM_FIRST_SPAN` means that the segment status would only be determined by the
status of the first span. |SW_ [...]
+| - | - |noUpstreamRealAddressAgents| Exit spans with the component in the
list would not generate client-side instance relation metrics, since some
tracing plugins (e.g. Nginx-LUA and Envoy) can't collect the real peer IP
address. |SW_NO_UPSTREAM_REAL_ADDRESS|6000,9000|
+| - | - |slowTraceSegmentThreshold| Setting this threshold on latency (in
milliseconds) would cause the slow trace segments to be sampled if they use up
more time, even if the sampling mechanism is activated. The default value is
`-1`, which means that slow traces would not be sampled.
|SW_SLOW_TRACE_SEGMENT_THRESHOLD|-1|
+| - | - |meterAnalyzerActiveFiles| Indicates which files could be instrumented
and analyzed. Multiple files are split by ",". |SW_METER_ANALYZER_ACTIVE_FILES||
+| receiver-sharing-server|default| Sharing server provides new gRPC and
restful servers for data collection. Ana designates that servers in the core
module are to be used for internal communication only. | - | - |
+| - | - | restHost| Binding IP of RESTful services. Services include GraphQL
query and HTTP data report. | SW_RECEIVER_SHARING_REST_HOST | - |
+| - | - | restPort | Binding port of RESTful services. |
SW_RECEIVER_SHARING_REST_PORT | - |
+| - | - | restContextPath| Web context path of RESTful services. |
SW_RECEIVER_SHARING_REST_CONTEXT_PATH | - |
+| - | - | restMinThreads| Minimum thread number of RESTful services. |
SW_RECEIVER_SHARING_JETTY_MIN_THREADS|1|
+| - | - | restMaxThreads| Maximum thread number of RESTful services. |
SW_RECEIVER_SHARING_JETTY_MAX_THREADS|200|
+| - | - | restIdleTimeOut| Connector idle timeout of RESTful services (in
milliseconds). | SW_RECEIVER_SHARING_JETTY_IDLE_TIMEOUT|30000|
+| - | - | restAcceptorPriorityDelta| Thread priority delta to give to acceptor
threads of RESTful services. | SW_RECEIVER_SHARING_JETTY_DELTA|0|
+| - | - | restAcceptQueueSize| ServerSocketChannel backlog of RESTful
services. | SW_RECEIVER_SHARING_JETTY_QUEUE_SIZE|0|
+| - | - | httpMaxRequestHeaderSize| Maximum request header size accepted. |
SW_RECEIVER_SHARING_HTTP_MAX_REQUEST_HEADER_SIZE|8192|
+| - | - | gRPCHost| Binding IP of gRPC services. Services include gRPC data
report and internal communication among OAP nodes. | SW_RECEIVER_GRPC_HOST |
0.0.0.0. Not Activated |
+| - | - | gRPCPort| Binding port of gRPC services. | SW_RECEIVER_GRPC_PORT |
Not Activated |
+| - | - | gRPCThreadPoolSize| Pool size of gRPC server. |
SW_RECEIVER_GRPC_THREAD_POOL_SIZE | CPU core * 4|
+| - | - | gRPCThreadPoolQueueSize| Queue size of gRPC server. |
SW_RECEIVER_GRPC_POOL_QUEUE_SIZE | 10000|
+| - | - | gRPCSslEnabled| Activates SSL for gRPC services. |
SW_RECEIVER_GRPC_SSL_ENABLED | false |
+| - | - | gRPCSslKeyPath| File path of gRPC SSL key. |
SW_RECEIVER_GRPC_SSL_KEY_PATH | - |
+| - | - | gRPCSslCertChainPath| File path of gRPC SSL cert chain. |
SW_RECEIVER_GRPC_SSL_CERT_CHAIN_PATH | - |
| - | - | maxConcurrentCallsPerConnection | The maximum number of concurrent
calls permitted for each incoming connection. Defaults to no limit. |
SW_RECEIVER_GRPC_MAX_CONCURRENT_CALL | - |
-| - | - | authentication | The token text for the authentication. Work for
gRPC connection only. Once this is set, the client is required to use the same
token. | SW_AUTHENTICATION | - |
+| - | - | authentication | The token text for authentication. Works for gRPC
connection only. Once this is set, the client is required to use the same
token. | SW_AUTHENTICATION | - |
| log-analyzer | default | Log Analyzer. | SW_LOG_ANALYZER | default |
| - | - | lalFiles | The LAL configuration file names (without file extension)
to be activated. Read [LAL](../../concepts-and-designs/lal.md) for more
details. | SW_LOG_LAL_FILES | default |
| - | - | malFiles | The MAL configuration file names (without file extension)
to be activated. Read [LAL](../../concepts-and-designs/lal.md) for more
details. | SW_LOG_MAL_FILES | "" |
| event-analyzer | default | Event Analyzer. | SW_EVENT_ANALYZER | default |
-| receiver-register|default| Read [receiver doc](backend-receivers.md) for
more details | - | - |
-| receiver-trace|default| Read [receiver doc](backend-receivers.md) for more
details | - | - |
-| receiver-jvm| default| Read [receiver doc](backend-receivers.md) for more
details | - | - |
-| receiver-clr| default| Read [receiver doc](backend-receivers.md) for more
details | - | - |
-| receiver-profile| default| Read [receiver doc](backend-receivers.md) for
more details | - | - |
-| receiver-zabbix| default| Read [receiver doc](backend-zabbix.md) for more
details | - | - |
-| - | - | port| Exported tcp port, Zabbix agent could connect and transport
data| SW_RECEIVER_ZABBIX_PORT | 10051 |
-| - | - | host| Bind to host| SW_RECEIVER_ZABBIX_HOST | 0.0.0.0 |
-| - | - | activeFiles| Enable config when receive agent request|
SW_RECEIVER_ZABBIX_ACTIVE_FILES | agent |
-| service-mesh| default| Read [receiver doc](backend-receivers.md) for more
details | - | - |
-| envoy-metric| default| Read [receiver doc](backend-receivers.md) for more
details | - | - |
-| - | - | acceptMetricsService | Open Envoy Metrics Service analysis |
SW_ENVOY_METRIC_SERVICE | true|
-| - | - | alsHTTPAnalysis | Open Envoy HTTP Access Log Service analysis. Value
= `k8s-mesh` means open the analysis | SW_ENVOY_METRIC_ALS_HTTP_ANALYSIS | - |
-| - | - | alsTCPAnalysis | Open Envoy TCP Access Log Service analysis. Value =
`k8s-mesh` means open the analysis | SW_ENVOY_METRIC_ALS_TCP_ANALYSIS | - |
-| - | - | k8sServiceNameRule | `k8sServiceNameRule` allows you to customize
the service name in ALS via Kubernetes metadata, the available variables are
`pod`, `service`, e.g., you can use
`${service.metadata.name}-${pod.metadata.labels.version}` to append the version
number to the service name. Be careful, when using environment variables to
pass this configuration, use single quotes(`''`) to avoid it being evaluated by
the shell. | - |
-| receiver-otel | default | Read [receiver doc](backend-receivers.md) for more
details | - | - |
-| - | - | enabledHandlers|Enabled handlers for otel|
SW_OTEL_RECEIVER_ENABLED_HANDLERS | - |
-| - | - | enabledOcRules|Enabled metric rules for OC handler |
SW_OTEL_RECEIVER_ENABLED_OC_RULES | - |
-| receiver_zipkin |default| Read [receiver doc](backend-receivers.md) | - | - |
-| - | - | restHost| Binding IP of restful service.
|SW_RECEIVER_ZIPKIN_HOST|0.0.0.0|
-| - | - | restPort | Binding port of restful service |
SW_RECEIVER_ZIPKIN_PORT|9411|
-| - | - | restContextPath| Web context path of restful service|
SW_RECEIVER_ZIPKIN_CONTEXT_PATH|/|
-| receiver_jaeger | default| Read [receiver doc](backend-receivers.md) | - | -
|
-| - | - | gRPCHost|Binding IP of gRPC service. Services include gRPC data
report and internal communication among OAP nodes| SW_RECEIVER_JAEGER_HOST | - |
-| - | - | gRPCPort| Binding port of gRPC service | SW_RECEIVER_JAEGER_PORT | -
|
-| - | - | gRPCThreadPoolSize|Pool size of gRPC server| - | CPU core * 4|
-| - | - | gRPCThreadPoolQueueSize| The queue size of gRPC server| - | 10000|
+| receiver-register|default| Read [receiver doc](backend-receivers.md) for
more details. | - | - |
+| receiver-trace|default| Read [receiver doc](backend-receivers.md) for more
details. | - | - |
+| receiver-jvm| default| Read [receiver doc](backend-receivers.md) for more
details. | - | - |
+| receiver-clr| default| Read [receiver doc](backend-receivers.md) for more
details. | - | - |
+| receiver-profile| default| Read [receiver doc](backend-receivers.md) for
more details. | - | - |
+| receiver-zabbix| default| Read [receiver doc](backend-zabbix.md) for more
details. | - | - |
+| - | - | port| Exported TCP port. Zabbix agent could connect and transport
data. | SW_RECEIVER_ZABBIX_PORT | 10051 |
+| - | - | host| Binds to host. | SW_RECEIVER_ZABBIX_HOST | 0.0.0.0 |
+| - | - | activeFiles| Enables config when agent request is received. |
SW_RECEIVER_ZABBIX_ACTIVE_FILES | agent |
+| service-mesh| default| Read [receiver doc](backend-receivers.md) for more
details. | - | - |
+| envoy-metric| default| Read [receiver doc](backend-receivers.md) for more
details. | - | - |
+| - | - | acceptMetricsService | Starts Envoy Metrics Service analysis. |
SW_ENVOY_METRIC_SERVICE | true|
+| - | - | alsHTTPAnalysis | Starts Envoy HTTP Access Log Service analysis.
Value = `k8s-mesh` means starting the analysis. |
SW_ENVOY_METRIC_ALS_HTTP_ANALYSIS | - |
+| - | - | alsTCPAnalysis | Starts Envoy TCP Access Log Service analysis. Value
= `k8s-mesh` means starting the analysis. | SW_ENVOY_METRIC_ALS_TCP_ANALYSIS |
- |
+| - | - | k8sServiceNameRule | `k8sServiceNameRule` allows you to customize
the service name in ALS via Kubernetes metadata. The available variables are
`pod` and `service`. E.g. you can use
`${service.metadata.name}-${pod.metadata.labels.version}` to append the version
number to the service name. Note that when using environment variables to pass
this configuration, use single quotes(`''`) to avoid being evaluated by the
shell. | - |
+| receiver-otel | default | Read [receiver doc](backend-receivers.md) for more
details. | - | - |
+| - | - | enabledHandlers| Enabled handlers for otel. |
SW_OTEL_RECEIVER_ENABLED_HANDLERS | - |
+| - | - | enabledOcRules| Enabled metric rules for OC handler. |
SW_OTEL_RECEIVER_ENABLED_OC_RULES | - |
+| receiver_zipkin |default| Read [receiver doc](backend-receivers.md). | - | -
|
+| - | - | restHost| Binding IP of RESTful services.
|SW_RECEIVER_ZIPKIN_HOST|0.0.0.0|
+| - | - | restPort | Binding port of RESTful services. |
SW_RECEIVER_ZIPKIN_PORT|9411|
+| - | - | restContextPath| Web context path of RESTful services. |
SW_RECEIVER_ZIPKIN_CONTEXT_PATH|/|
+| receiver_jaeger | default| Read [receiver doc](backend-receivers.md). | - |
- |
+| - | - | gRPCHost|Binding IP of gRPC services. Services include gRPC data
report and internal communication among OAP nodes. | SW_RECEIVER_JAEGER_HOST |
- |
+| - | - | gRPCPort| Binding port of gRPC services. | SW_RECEIVER_JAEGER_PORT |
- |
+| - | - | gRPCThreadPoolSize| Pool size of gRPC server. | - | CPU core * 4|
+| - | - | gRPCThreadPoolQueueSize| Queue size of gRPC server. | - | 10000|
| - | - | maxConcurrentCallsPerConnection | The maximum number of concurrent
calls permitted for each incoming connection. Defaults to no limit. | - | - |
-| - | - | maxMessageSize | Sets the maximum message size allowed to be
received on the server. Empty means 4 MiB | - | 4M(based on Netty) |
-| prometheus-fetcher | default | Read [fetcher doc](backend-fetcher.md) for
more details | - | - |
-| - | - | enabledRules | Enable rules. | SW_PROMETHEUS_FETCHER_ENABLED_RULES |
self |
+| - | - | maxMessageSize | Sets the maximum message size allowed to be
received on the server. Empty means 4 MiB. | - | 4M(based on Netty) |
+| prometheus-fetcher | default | Read [fetcher doc](backend-fetcher.md) for
more details. | - | - |
+| - | - | enabledRules | Enabled rules. | SW_PROMETHEUS_FETCHER_ENABLED_RULES
| self |
| - | - | maxConvertWorker | The maximize meter convert worker. |
SW_PROMETHEUS_FETCHER_NUM_CONVERT_WORKER | -1(by default, half the number of
CPU core(s)) |
-| kafka-fetcher | default | Read [fetcher doc](backend-fetcher.md) for more
details | - | - |
+| kafka-fetcher | default | Read [fetcher doc](backend-fetcher.md) for more
details. | - | - |
| - | - | bootstrapServers | A list of host/port pairs to use for establishing
the initial connection to the Kafka cluster. | SW_KAFKA_FETCHER_SERVERS |
localhost:9092 |
-| - | - | namespace | namespace aims to isolate multi OAP cluster when using
the same Kafka cluster.if you set a namespace for Kafka fetcher, OAP will add a
prefix to topic name. you should also set namespace in `agent.config`, the
property named| SW_NAMESPACE | - |
-| - | - | groupId | A unique string that identifies the consumer group this
consumer belongs to.| - | skywalking-consumer |
-| - | - | consumePartitions | Which PartitionId(s) of the topics assign to the
OAP server. If more than one, is separated by commas. |
SW_KAFKA_FETCHER_CONSUME_PARTITIONS | - |
-| - | - | isSharding | it was true when OAP Server in cluster. |
SW_KAFKA_FETCHER_IS_SHARDING | false |
-| - | - | createTopicIfNotExist | If true, create the Kafka topic when it does
not exist. | - | true |
+| - | - | namespace | Namespace aims to isolate multi OAP cluster when using
the same Kafka cluster. If you set a namespace for Kafka fetcher, OAP will add
a prefix to topic name. You should also set namespace in `agent.config`. The
property is named `plugin.kafka.namespace`. | SW_NAMESPACE | - |
+| - | - | groupId | A unique string that identifies the consumer group to
which this consumer belongs.| - | skywalking-consumer |
+| - | - | consumePartitions | Indicates which PartitionId(s) of the topics
is/are assigned to the OAP server. Separated by commas if multiple. |
SW_KAFKA_FETCHER_CONSUME_PARTITIONS | - |
+| - | - | isSharding | True when OAP Server is in cluster. |
SW_KAFKA_FETCHER_IS_SHARDING | false |
+| - | - | createTopicIfNotExist | If true, this creates Kafka topic (if it
does not already exist). | - | true |
| - | - | partitions | The number of partitions for the topic being created. |
SW_KAFKA_FETCHER_PARTITIONS | 3 |
-| - | - | enableNativeProtoLog | To enable to fetch and handle native proto
log data. | SW_KAFKA_FETCHER_ENABLE_NATIVE_PROTO_LOG | false |
-| - | - | enableNativeJsonLog | To enable to fetch and handle native json log
data. | SW_KAFKA_FETCHER_ENABLE_NATIVE_JSON_LOG | false |
+| - | - | enableNativeProtoLog | Enables fetching and handling native proto
log data. | SW_KAFKA_FETCHER_ENABLE_NATIVE_PROTO_LOG | false |
+| - | - | enableNativeJsonLog | Enables fetching and handling native json log
data. | SW_KAFKA_FETCHER_ENABLE_NATIVE_JSON_LOG | false |
| - | - | replicationFactor | The replication factor for each partition in the
topic being created. | SW_KAFKA_FETCHER_PARTITIONS_FACTOR | 2 |
-| - | - | kafkaHandlerThreadPoolSize | Pool size of kafka message handler
executor. | SW_KAFKA_HANDLER_THREAD_POOL_SIZE | CPU core * 2 |
-| - | - | kafkaHandlerThreadPoolQueueSize | The queue size of kafka message
handler executor. | SW_KAFKA_HANDLER_THREAD_POOL_QUEUE_SIZE | 10000 |
-| - | - | topicNameOfMeters | Specifying Kafka topic name for Meter system
data. | - | skywalking-meters |
-| - | - | topicNameOfMetrics | Specifying Kafka topic name for JVM Metrics
data. | - | skywalking-metrics |
-| - | - | topicNameOfProfiling | Specifying Kafka topic name for Profiling
data. | - | skywalking-profilings |
-| - | - | topicNameOfTracingSegments | Specifying Kafka topic name for Tracing
data. | - | skywalking-segments |
-| - | - | topicNameOfManagements | Specifying Kafka topic name for service
instance reporting and registering. | - | skywalking-managements |
-| - | - | topicNameOfLogs | Specifying Kafka topic name for native proto log
data. | - | skywalking-logs |
-| - | - | topicNameOfJsonLogs | Specifying Kafka topic name for native json
log data. | - | skywalking-logs-json |
-| receiver-browser | default | Read [receiver doc](backend-receivers.md) for
more details | - | - | - |
-| - | - | sampleRate | Sampling rate for receiving trace. The precision is
1/10000. 10000 means 100% sample in default. | SW_RECEIVER_BROWSER_SAMPLE_RATE
| 10000 |
-| query | graphql | - | GraphQL query implementation | - |
+| - | - | kafkaHandlerThreadPoolSize | Pool size of Kafka message handler
executor. | SW_KAFKA_HANDLER_THREAD_POOL_SIZE | CPU core * 2 |
+| - | - | kafkaHandlerThreadPoolQueueSize | Queue size of Kafka message
handler executor. | SW_KAFKA_HANDLER_THREAD_POOL_QUEUE_SIZE | 10000 |
+| - | - | topicNameOfMeters | Kafka topic name for meter system data. | - |
skywalking-meters |
+| - | - | topicNameOfMetrics | Kafka topic name for JVM metrics data. | - |
skywalking-metrics |
+| - | - | topicNameOfProfiling | Kafka topic name for profiling data. | - |
skywalking-profilings |
+| - | - | topicNameOfTracingSegments | Kafka topic name for tracing data. | -
| skywalking-segments |
+| - | - | topicNameOfManagements | Kafka topic name for service instance
reporting and registration. | - | skywalking-managements |
+| - | - | topicNameOfLogs | Kafka topic name for native proto log data. | - |
skywalking-logs |
+| - | - | topicNameOfJsonLogs | Kafka topic name for native json log data. | -
| skywalking-logs-json |
+| receiver-browser | default | Read [receiver doc](backend-receivers.md) for
more details. | - | - | - |
+| - | - | sampleRate | Sampling rate for receiving trace. Precise to 1/10000.
10000 means sampling rate of 100% by default. | SW_RECEIVER_BROWSER_SAMPLE_RATE
| 10000 |
+| query | graphql | - | GraphQL query implementation. | - |
| - | - | path | Root path of GraphQL query and mutation. |
SW_QUERY_GRAPHQL_PATH | /graphql|
| alarm | default | - | Read [alarm doc](backend-alarm.md) for more details. |
- |
| telemetry | - | - | Read [telemetry doc](backend-telemetry.md) for more
details. | - |
-| - | none| - | No op implementation | - |
-| - | prometheus| host | Binding host for Prometheus server fetching data|
SW_TELEMETRY_PROMETHEUS_HOST|0.0.0.0|
-| - | - | port| Binding port for Prometheus server fetching
data|SW_TELEMETRY_PROMETHEUS_PORT|1234|
+| - | none| - | No op implementation. | - |
+| - | prometheus| host | Binding host for Prometheus server fetching data. |
SW_TELEMETRY_PROMETHEUS_HOST|0.0.0.0|
+| - | - | port| Binding port for Prometheus server fetching data.
|SW_TELEMETRY_PROMETHEUS_PORT|1234|
| configuration | - | - | Read [dynamic configuration doc](dynamic-config.md)
for more details. | - |
-| - | grpc| host | DCS server binding hostname | SW_DCS_SERVER_HOST | - |
-| - | - | port | DCS server binding port | SW_DCS_SERVER_PORT | 80 |
-| - | - | clusterName | Cluster name when reading latest configuration from
DSC server. | SW_DCS_CLUSTER_NAME | SkyWalking|
-| - | - | period | The period of OAP reading data from DSC server. Unit is
second. | SW_DCS_PERIOD | 20 |
-| - | apollo| apolloMeta| `apollo.meta` in Apollo | SW_CONFIG_APOLLO |
http://106.12.25.204:8080 |
-| - | - | apolloCluster | `apollo.cluster` in Apollo |
SW_CONFIG_APOLLO_CLUSTER | default|
-| - | - | apolloEnv | `env` in Apollo | SW_CONFIG_APOLLO_ENV | - |
-| - | - | appId | `app.id` in Apollo | SW_CONFIG_APOLLO_APP_ID | skywalking |
-| - | - | period | The period of data sync. Unit is second. |
SW_CONFIG_APOLLO_PERIOD | 60 |
-| - | zookeeper|nameSpace|The namespace, represented by root path, isolates
the configurations in the zookeeper.|SW_CONFIG_ZK_NAMESPACE| `/`, root path|
-| - | - | hostPort|hosts and ports of Zookeeper
Cluster|SW_CONFIG_ZK_HOST_PORT| localhost:2181|
-| - | - | baseSleepTimeMs|The period of Zookeeper client between two retries.
Unit is ms.|SW_CONFIG_ZK_BASE_SLEEP_TIME_MS|1000|
-| - | - | maxRetries| The max retry time of
re-trying.|SW_CONFIG_ZK_MAX_RETRIES|3|
-| - | - | period | The period of data sync. Unit is second. |
SW_CONFIG_ZK_PERIOD | 60 |
-| - | etcd| endpoints | hosts and ports used of etcd cluster(If there are
multiple, separate them with commas). | SW_CONFIG_ETCD_ENDPOINTS |
localhost:2379 |
-| - | - | namespace | Namespace used for SkyWalking cluster.
|SW_CONFIG_ETCD_NAMESPACE | /skywalking |
-| - | - | authentication | Whether has authentication. |
SW_CONFIG_ETCD_AUTHENTICATION | false |
-| - | - | user | Etcd auth username | SW_CONFIG_ETCD_USER | |
-| - | - | password | Etcd auth password | SW_CONFIG_ETCD_PASSWORD | |
-| - | - | period | The period of data sync. Unit is second. |
SW_CONFIG_ZK_PERIOD | 60
-| - | consul | hostPort| hosts and ports used of Consul cluster.|
SW_CONFIG_CONSUL_HOST_AND_PORTS|localhost:8500|
-| - | - | aclToken| ALC Token of Consul. Empty string means `without ALC
token`.| SW_CONFIG_CONSUL_ACL_TOKEN | - |
-| - | - | period | The period of data sync. Unit is second. |
SW_CONFIG_CONSUL_PERIOD | 60 |
+| - | grpc| host | DCS server binding hostname. | SW_DCS_SERVER_HOST | - |
+| - | - | port | DCS server binding port. | SW_DCS_SERVER_PORT | 80 |
+| - | - | clusterName | Cluster name when reading the latest configuration
from DSC server. | SW_DCS_CLUSTER_NAME | SkyWalking|
+| - | - | period | The period of reading data from DSC server by the OAP (in
seconds). | SW_DCS_PERIOD | 20 |
+| - | apollo| apolloMeta| `apollo.meta` in Apollo. | SW_CONFIG_APOLLO |
http://106.12.25.204:8080 |
+| - | - | apolloCluster | `apollo.cluster` in Apollo. |
SW_CONFIG_APOLLO_CLUSTER | default|
+| - | - | apolloEnv | `env` in Apollo. | SW_CONFIG_APOLLO_ENV | - |
+| - | - | appId | `app.id` in Apollo. | SW_CONFIG_APOLLO_APP_ID | skywalking |
+| - | - | period | The period of data sync (in seconds). |
SW_CONFIG_APOLLO_PERIOD | 60 |
+| - | zookeeper|nameSpace| The namespace (represented by root path) that
isolates the configurations in the Zookeeper. |SW_CONFIG_ZK_NAMESPACE| `/`,
root path|
+| - | - | hostPort| Hosts and ports of Zookeeper Cluster.
|SW_CONFIG_ZK_HOST_PORT| localhost:2181|
+| - | - | baseSleepTimeMs|The period of Zookeeper client between two retries
(in milliseconds). |SW_CONFIG_ZK_BASE_SLEEP_TIME_MS|1000|
+| - | - | maxRetries| The maximum retry time. |SW_CONFIG_ZK_MAX_RETRIES|3|
+| - | - | period | The period of data sync (in seconds). | SW_CONFIG_ZK_PERIOD
| 60 |
+| - | etcd| endpoints | Hosts and ports for etcd cluster (separated by commas
if multiple). | SW_CONFIG_ETCD_ENDPOINTS | localhost:2379 |
+| - | - | namespace | Namespace for SkyWalking cluster.
|SW_CONFIG_ETCD_NAMESPACE | /skywalking |
+| - | - | authentication | Indicates whether there is authentication. |
SW_CONFIG_ETCD_AUTHENTICATION | false |
+| - | - | user | Etcd auth username. | SW_CONFIG_ETCD_USER | |
+| - | - | password | Etcd auth password. | SW_CONFIG_ETCD_PASSWORD | |
+| - | - | period | The period of data sync (in seconds). | SW_CONFIG_ZK_PERIOD
| 60
+| - | consul | hostPort| Hosts and ports for Consul cluster.|
SW_CONFIG_CONSUL_HOST_AND_PORTS|localhost:8500|
+| - | - | aclToken| ACL Token of Consul. Empty string means `without ACL
token`.| SW_CONFIG_CONSUL_ACL_TOKEN | - |
+| - | - | period | The period of data sync (in seconds). |
SW_CONFIG_CONSUL_PERIOD | 60 |
| - | k8s-configmap | namespace | Deployment namespace of the config map.
|SW_CLUSTER_K8S_NAMESPACE|default|
-| - | - | labelSelector| Labels used for locating configmap.
|SW_CLUSTER_K8S_LABEL|app=collector,release=skywalking|
-| - | - | period | The period of data sync. Unit is second. |
SW_CONFIG_ZK_PERIOD | 60 |
-| - | nacos | serverAddr | Nacos Server Host | SW_CONFIG_NACOS_SERVER_ADDR |
127.0.0.1|
-| - | - | port | Nacos Server Port | SW_CONFIG_NACOS_SERVER_PORT | 8848 |
-| - | - | group | Nacos Configuration namespace |
SW_CONFIG_NACOS_SERVER_NAMESPACE | - |
-| - | - | period | The period of data sync. Unit is second. |
SW_CONFIG_CONFIG_NACOS_PERIOD | 60 |
-| - | - | username | Nacos Auth username | SW_CONFIG_NACOS_USERNAME | - |
-| - | - | password | Nacos Auth password | SW_CONFIG_NACOS_PASSWORD | - |
-| - | - | accessKey | Nacos Auth accessKey | SW_CONFIG_NACOS_ACCESSKEY | - |
-| - | - | secretKey | Nacos Auth secretKey | SW_CONFIG_NACOS_SECRETKEY | - |
-| exporter | grpc | targetHost | The host of target grpc server for receiving
export data. | SW_EXPORTER_GRPC_HOST | 127.0.0.1 |
-| - | - | targetPort | The port of target grpc server for receiving export
data. | SW_EXPORTER_GRPC_PORT | 9870 |
-| health-checker | default | checkIntervalSeconds | The period of check OAP
internal health status. Unit is second. | SW_HEALTH_CHECKER_INTERVAL_SECONDS |
5 |
-| configuration-discovery | default | disableMessageDigest | If true, agent
receives the latest configuration every time even without change. In default,
OAP uses SHA512 message digest mechanism to detect changes of configuration. |
SW_DISABLE_MESSAGE_DIGEST | false
-| receiver-event|default| Read [receiver doc](backend-receivers.md) for more
details | - | - |
+| - | - | labelSelector| Labels for locating configmap.
|SW_CLUSTER_K8S_LABEL|app=collector,release=skywalking|
+| - | - | period | The period of data sync (in seconds). | SW_CONFIG_ZK_PERIOD
| 60 |
+| - | nacos | serverAddr | Nacos Server Host. | SW_CONFIG_NACOS_SERVER_ADDR |
127.0.0.1|
+| - | - | port | Nacos Server Port. | SW_CONFIG_NACOS_SERVER_PORT | 8848 |
+| - | - | group | Nacos Configuration namespace. |
SW_CONFIG_NACOS_SERVER_NAMESPACE | - |
+| - | - | period | The period of data sync (in seconds). |
SW_CONFIG_CONFIG_NACOS_PERIOD | 60 |
+| - | - | username | Nacos Auth username. | SW_CONFIG_NACOS_USERNAME | - |
+| - | - | password | Nacos Auth password. | SW_CONFIG_NACOS_PASSWORD | - |
+| - | - | accessKey | Nacos Auth accessKey. | SW_CONFIG_NACOS_ACCESSKEY | - |
+| - | - | secretKey | Nacos Auth secretKey. | SW_CONFIG_NACOS_SECRETKEY | - |
+| exporter | grpc | targetHost | The host of target gRPC server for receiving
export data. | SW_EXPORTER_GRPC_HOST | 127.0.0.1 |
+| - | - | targetPort | The port of target gRPC server for receiving export
data. | SW_EXPORTER_GRPC_PORT | 9870 |
+| health-checker | default | checkIntervalSeconds | The period of checking OAP
internal health status (in seconds). | SW_HEALTH_CHECKER_INTERVAL_SECONDS | 5 |
+| configuration-discovery | default | disableMessageDigest | If true, agent
receives the latest configuration every time, even without making any changes.
By default, OAP uses the SHA512 message digest mechanism to detect changes in
configuration. | SW_DISABLE_MESSAGE_DIGEST | false
+| receiver-event|default| Read [receiver doc](backend-receivers.md) for more
details. | - | - |
-## Notice
-¹ System Environment Variable name could be declared and changed in the
application.yml. The names listed here,
-are just provided in the default `application.yml` file.
+## Note
+¹ System Environment Variable name could be declared and changed in
`application.yml`. The names listed here are simply provided in the default
`application.yml` file.
