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 d874c211f6 Clean up OpenCensus related codes and docs (#10755)
d874c211f6 is described below
commit d874c211f68b83ff9fa603c7f59cb6e0056418ca
Author: kezhenxu94 <ke...@apache.org>
AuthorDate: Thu May 4 11:13:17 2023 +0800
Clean up OpenCensus related codes and docs (#10755)
---
.licenserc.yaml | 1 -
LICENSE | 1 -
README.md | 2 +-
docs/en/api/meter.md | 2 +-
docs/en/changes/changes.md | 3 +-
docs/en/concepts-and-designs/mal.md | 2 +-
docs/en/concepts-and-designs/overview.md | 2 +-
docs/en/concepts-and-designs/project-goals.md | 2 +-
docs/en/concepts-and-designs/scope-definitions.md | 469 ++++++++--------
docs/en/setup/backend/configuration-vocabulary.md | 624 ++++++++++-----------
docs/en/setup/backend/opentelemetry-receiver.md | 37 +-
docs/en/setup/istio/README.md | 78 ++-
.../receiver/otel/OtelMetricReceiverProvider.java | 10 +-
.../server/receiver/otel/oc/OCMetricHandler.java | 209 -------
.../opencensus/proto/agent/common/v1/common.proto | 99 ----
.../proto/agent/metrics/v1/metrics_service.proto | 56 --
.../proto/agent/trace/v1/trace_service.proto | 85 ---
.../opencensus/proto/metrics/v1/metrics.proto | 301 ----------
.../opencensus/proto/resource/v1/resource.proto | 33 --
.../proto/opencensus/proto/stats/v1/stats.proto | 136 -----
.../proto/opencensus/proto/trace/v1/trace.proto | 420 --------------
.../opencensus/proto/trace/v1/trace_config.proto | 79 ---
.../src/main/resources/application.yml | 2 +-
.../otel-collector-config.yaml | 12 -
.../otel-collector-config.yaml | 12 -
.../postgres-exporter/otel-collector-config.yaml | 12 -
.../redis-exporter/otel-collector-config.yaml | 12 -
test/e2e-v2/cases/so11y/otel-collector-config.yaml | 12 -
.../otel-collector-config.yaml | 21 +-
.../otel-collector-config.yaml | 22 +-
30 files changed, 615 insertions(+), 2141 deletions(-)
diff --git a/.licenserc.yaml b/.licenserc.yaml
index f91763696f..33936fe4bd 100644
--- a/.licenserc.yaml
+++ b/.licenserc.yaml
@@ -63,7 +63,6 @@ header:
- '**/src/main/proto/prometheus/client_model/metrics.proto'
- '**/src/main/proto/protoc-gen-swagger/**'
- '**/src/main/proto/validate/validate.proto'
- - '**/src/main/proto/opencensus/**'
- '**/src/main/proto/opentelemetry/**'
- 'oap-server/server-starter/src/main/resources/version.properties'
- '**/mockito-extensions/**'
diff --git a/LICENSE b/LICENSE
index 1429067582..dc8c998781 100644
--- a/LICENSE
+++ b/LICENSE
@@ -217,7 +217,6 @@ The text of each license is the standard Apache 2.0 license.
proto files from cncf/udpa: https://github.com/cncf/udpa Apache 2.0
proto files from envoyproxy/data-plane-api: https://github.com/envoyproxy/data-plane-api Apache 2.0
- proto files from opencensus: https://github.com/census-instrumentation/opencensus-proto/tree/master/gen-go Apache 2.0
proto files from prometheus/client_model: https://github.com/prometheus/client_model Apache 2.0
proto files from opentelemetry: https://github.com/open-telemetry/opentelemetry-proto/tree/main/opentelemetry/proto Apache 2.0
proto files from opentelemetry: https://github.com/open-telemetry/opentelemetry-proto/tree/v0.7.0 Apache 2.0
diff --git a/README.md b/README.md
index 809b797720..c40b530e9e 100644
--- a/README.md
+++ b/README.md
@@ -30,7 +30,7 @@ in Cloud Native architecture.
* Native APM Database
* BanyanDB, an observability database, created in 2022, aims to ingest, analyze and store telemetry/observability data.
* Consistent Metrics Aggregation
- * SkyWalking native meter format and widely known metrics format(OpenCensus, OTLP, Telegraf, Zabbix, e.g.) are processed through the same script pipeline.
+ * SkyWalking native meter format and widely known metrics format(OpenTelemetry, Telegraf, Zabbix, e.g.) are processed through the same script pipeline.
* Log Management Pipeline
* Support log formatting, extract metrics, various sampling policies through script pipeline in high performance.
* Alerting and Telemetry Pipelines
diff --git a/docs/en/api/meter.md b/docs/en/api/meter.md
index e6f7f44c7e..0a306ab98c 100644
--- a/docs/en/api/meter.md
+++ b/docs/en/api/meter.md
@@ -1,5 +1,5 @@
# Meter APIs
-SkyWalking has a native metrics format, and supports widely used metric formats, such as Prometheus, OpenCensus, OpenTelemetry, and Zabbix.
+SkyWalking has a native metrics format, and supports widely used metric formats, such as Prometheus, OpenTelemetry, and Zabbix.
```protobuf
syntax = "proto3";
diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md
index 8b9b7f0fa9..f917a97cba 100644
--- a/docs/en/changes/changes.md
+++ b/docs/en/changes/changes.md
@@ -37,7 +37,8 @@
* Support Elasticsearch Monitoring.
* Fix PromQL HTTP API `/api/v1/series` response missing `service` label when matching metric.
* Support ServerSide TopN for BanyanDB.
-* Add component ID for Jersey
+* Add component ID for Jersey.
+* Remove OpenCensus support, the related codes and docs as [it's sunsetting](https://opentelemetry.io/blog/2023/sunsetting-opencensus/).
#### UI
* Revert: cpm5d function. This feature is cancelled from backend.
diff --git a/docs/en/concepts-and-designs/mal.md b/docs/en/concepts-and-designs/mal.md
index f2e8ee5013..e8a04067b1 100644
--- a/docs/en/concepts-and-designs/mal.md
+++ b/docs/en/concepts-and-designs/mal.md
@@ -2,7 +2,7 @@
The meter system provides a functional analysis language called MAL (Meter Analysis Language) that lets users analyze and
aggregate meter data in the OAP streaming system. The result of an expression can either be ingested by the agent analyzer,
-or the OC/Prometheus analyzer.
+or the OpenTelemetry/Prometheus analyzer.
## Language data type
diff --git a/docs/en/concepts-and-designs/overview.md b/docs/en/concepts-and-designs/overview.md
index bb9a976f9b..03da50ff64 100644
--- a/docs/en/concepts-and-designs/overview.md
+++ b/docs/en/concepts-and-designs/overview.md
@@ -31,7 +31,7 @@ Kubernetes(k8s layer). All detected instances belong to a layer to represent the
the service would have one or multiple layer definitions according to its instances.
In addition, you can integrate
-1. Other distributed tracing using SkyWalking native agents and SDKs with Zipkin, Jaeger and OpenCensus.
+1. Other distributed tracing using SkyWalking native agents and SDKs with Zipkin and Jaeger.
1. Other metrics systems, such as Prometheus, Sleuth(Micrometer), OpenTelemetry.
diff --git a/docs/en/concepts-and-designs/project-goals.md b/docs/en/concepts-and-designs/project-goals.md
index 5402f5e958..51baa5f550 100644
--- a/docs/en/concepts-and-designs/project-goals.md
+++ b/docs/en/concepts-and-designs/project-goals.md
@@ -27,7 +27,7 @@ and also don't fit every scenario. So, we provide a lot of features for being pl
SkyWalking should run well in all of these cases.
- **Interoperability**. The observability landscape is so vast that it is virtually impossible for SkyWalking to support all systems, even with the support of its community.
-Currently, it supports interoperability with other OSS systems, especially probes, such as Zipkin, Jaeger, OpenTracing, and OpenCensus.
+Currently, it supports interoperability with other OSS systems, especially probes, such as Zipkin, Jaeger, and OpenTelemetry.
It is very important to end users that SkyWalking has the ability to accept and read these data formats, since the users are not required to switch their libraries.
diff --git a/docs/en/concepts-and-designs/scope-definitions.md b/docs/en/concepts-and-designs/scope-definitions.md
index 290c0b133d..388e4129f2 100644
--- a/docs/en/concepts-and-designs/scope-definitions.md
+++ b/docs/en/concepts-and-designs/scope-definitions.md
@@ -1,71 +1,72 @@
# Scopes and Fields
+
Using the Aggregation Function, the requests will be grouped by time and **Group Key(s)** in each scope.
### SCOPE `Service`
This calculates the metrics data from each request of the service.
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The name of the service. | | string |
-| layer | Layer represents an abstract framework in the computer science, such as operation system(OS_LINUX layer), Kubernetes(k8s layer) | | enum |
-| serviceInstanceName | The name of the service instance ID. | | string |
-| endpointName | The name of the endpoint, such as a full path of HTTP URI. | | string |
-| latency | The time taken by each request. | | int |
-| status | Indicates the success or failure of the request. | | bool(true for success) |
-| httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302| | int |
-| rpcStatusCode | The string value of the rpc response code. | | string |
-| type | The type of each request. Such as: Database, HTTP, RPC, gRPC. | | enum |
-| tags | The labels of each request. Each value is made up by `TagKey:TagValue` in the segment. | | `List<String>` |
-| tag | The key-value pair of span tags in the segment. | | `Map<String, String>` |
-| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string|
+| Name | Remarks | Group Key | Type |
+|---------------------------|---------------------------------------------------------------------------------------------------------------------------------|-----------|------------------------|
+| name | The name of the service. | | string |
+| layer | Layer represents an abstract framework in the computer science, such as operation system(OS_LINUX layer), Kubernetes(k8s layer) | | enum |
+| serviceInstanceName | The name of the service instance ID. | | string |
+| endpointName | The name of the endpoint, such as a full path of HTTP URI. | | string |
+| latency | The time taken by each request. | | int |
+| status | Indicates the success or failure of the request. | | bool(true for success) |
+| httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302 | | int |
+| rpcStatusCode | The string value of the rpc response code. | | string |
+| type | The type of each request. Such as: Database, HTTP, RPC, gRPC. | | enum |
+| tags | The labels of each request. Each value is made up by `TagKey:TagValue` in the segment. | | `List<String>` |
+| tag | The key-value pair of span tags in the segment. | | `Map<String, String>` |
+| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string |
### SCOPE `TCPService`
This calculates the metrics data from each request of the TCP service.
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The name of the service. | | string |
-| layer | Layer represents an abstract framework in the computer science, such as operation system(OS_LINUX layer), Kubernetes(k8s layer) | | enum |
-| serviceInstanceName | The name of the service instance ID. | | string |
-| tags | The labels of each request. Each value is made up by `TagKey:TagValue` in the segment. | | `List<String>` |
-| tag | The key-value pair of span tags in the segment. | | `Map<String, String>` |
-| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string|
-| receivedBytes | The received bytes of the TCP traffic. | | long |
-| sentBytes | The sent bytes of the TCP traffic. | | long |
+| Name | Remarks | Group Key | Type |
+|---------------------------|---------------------------------------------------------------------------------------------------------------------------------|-----------|-----------------------|
+| name | The name of the service. | | string |
+| layer | Layer represents an abstract framework in the computer science, such as operation system(OS_LINUX layer), Kubernetes(k8s layer) | | enum |
+| serviceInstanceName | The name of the service instance ID. | | string |
+| tags | The labels of each request. Each value is made up by `TagKey:TagValue` in the segment. | | `List<String>` |
+| tag | The key-value pair of span tags in the segment. | | `Map<String, String>` |
+| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string |
+| receivedBytes | The received bytes of the TCP traffic. | | long |
+| sentBytes | The sent bytes of the TCP traffic. | | long |
### SCOPE `ServiceInstance`
This calculates the metrics data from each request of the service instance.
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string|
-| serviceName | The name of the service. | | string |
-| endpointName | The name of the endpoint, such as a full path of the HTTP URI. | | string|
-| latency | The time taken by each request. | | int |
-| status | Indicates the success or failure of the request. | | bool(true for success) |
-| httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302| | int |
-| rpcStatusCode | The string value of the rpc response code. | | string |
-| type | The type of each request, such as Database, HTTP, RPC, or gRPC. | | enum |
-| tags | The labels of each request. Each value is made up by `TagKey:TagValue` in the segment. | | `List<String>` |
-| tag | The key-value pair of span tags in the segment. | | `Map<String, String>` |
-| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string|
+| Name | Remarks | Group Key | Type |
+|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|------------------------|
+| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string |
+| serviceName | The name of the service. | | string |
+| endpointName | The name of the endpoint, such as a full path of the HTTP URI. | | string |
+| latency | The time taken by each request. | | int |
+| status | Indicates the success or failure of the request. | | bool(true for success) |
+| httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302 | | int |
+| rpcStatusCode | The string value of the rpc response code. | | string |
+| type | The type of each request, such as Database, HTTP, RPC, or gRPC. | | enum |
+| tags | The labels of each request. Each value is made up by `TagKey:TagValue` in the segment. | | `List<String>` |
+| tag | The key-value pair of span tags in the segment. | | `Map<String, String>` |
+| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string |
### SCOPE `TCPServiceInstance`
This calculates the metrics data from each request of the service instance.
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string|
-| serviceName | The name of the service. | | string |
-| tags | The labels of each request. Each value is made up by `TagKey:TagValue` in the segment. | | `List<String>` |
-| tag | The key-value pair of span tags in the segment. | | `Map<String, String>` |
-| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string|
-| receivedBytes | The received bytes of the TCP traffic. | | long |
-| sentBytes | The sent bytes of the TCP traffic. | | long |
+| Name | Remarks | Group Key | Type |
+|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-----------------------|
+| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string |
+| serviceName | The name of the service. | | string |
+| tags | The labels of each request. Each value is made up by `TagKey:TagValue` in the segment. | | `List<String>` |
+| tag | The key-value pair of span tags in the segment. | | `Map<String, String>` |
+| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string |
+| receivedBytes | The received bytes of the TCP traffic. | | long |
+| sentBytes | The sent bytes of the TCP traffic. | | long |
#### Secondary scopes of `ServiceInstance`
@@ -73,88 +74,88 @@ This calculates the metrics data if the service instance is a JVM and collects t
1. SCOPE `ServiceInstanceJVMCPU`
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string|
-| serviceName | The name of the service. | | string |
-| usePercent | The percentage of CPU time spent.| | double|
+| Name | Remarks | Group Key | Type |
+|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|--------|
+| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string |
+| serviceName | The name of the service. | | string |
+| usePercent | The percentage of CPU time spent. | | double |
2. SCOPE `ServiceInstanceJVMMemory`
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string|
-| serviceName | The name of the service. | | string |
-| heapStatus | Indicates whether the metric has a heap property or not. | | bool |
-| init | See the JVM documentation. | | long |
-| max | See the JVM documentation. | | long |
-| used | See the JVM documentation. | | long |
-| committed | See the JVM documentation. | | long |
+| Name | Remarks | Group Key | Type |
+|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|--------|
+| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string |
+| serviceName | The name of the service. | | string |
+| heapStatus | Indicates whether the metric has a heap property or not. | | bool |
+| init | See the JVM documentation. | | long |
+| max | See the JVM documentation. | | long |
+| used | See the JVM documentation. | | long |
+| committed | See the JVM documentation. | | long |
3. SCOPE `ServiceInstanceJVMMemoryPool`
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string|
-| serviceName | The name of the service. | | string |
-| poolType | The type may be CODE_CACHE_USAGE, NEWGEN_USAGE, OLDGEN_USAGE, SURVIVOR_USAGE, PERMGEN_USAGE, or METASPACE_USAGE based on different versions of JVM. | | enum |
-| init | See the JVM documentation. | | long |
-| max | See the JVM documentation. | | long |
-| used | See the JVM documentation. | | long |
-| committed | See the JVM documentation. | | long |
+| Name | Remarks | Group Key | Type |
+|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|--------|
+| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string |
+| serviceName | The name of the service. | | string |
+| poolType | The type may be CODE_CACHE_USAGE, NEWGEN_USAGE, OLDGEN_USAGE, SURVIVOR_USAGE, PERMGEN_USAGE, or METASPACE_USAGE based on different versions of JVM. | | enum |
+| init | See the JVM documentation. | | long |
+| max | See the JVM documentation. | | long |
+| used | See the JVM documentation. | | long |
+| committed | See the JVM documentation. | | long |
4. SCOPE `ServiceInstanceJVMGC`
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string|
-| serviceName | The name of the service. | | string |
-| phase | Includes both NEW and OLD. | | Enum |
-| time | The time spent in GC. | | long |
-| count | The count in GC operations. | | long |
+| Name | Remarks | Group Key | Type |
+|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|--------|
+| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string |
+| serviceName | The name of the service. | | string |
+| phase | Includes both NEW and OLD. | | Enum |
+| time | The time spent in GC. | | long |
+| count | The count in GC operations. | | long |
5. SCOPE `ServiceInstanceJVMThread`
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string|
-| serviceName | The name of the service. | | string |
-| liveCount | The current number of live threads. | | long |
-| daemonCount | The current number of daemon threads. | | long |
-| peakCount | The current number of peak threads. | | long |
-| runnableStateThreadCount | The current number of threads in runnable state. | | long |
-| blockedStateThreadCount | The current number of threads in blocked state. | | long |
-| waitingStateThreadCount | The current number of threads in waiting state. | | long |
-| timedWaitingStateThreadCount | The current number of threads in time-waiting state. | | long |
+| Name | Remarks | Group Key | Type |
+|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|--------|
+| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string |
+| serviceName | The name of the service. | | string |
+| liveCount | The current number of live threads. | | long |
+| daemonCount | The current number of daemon threads. | | long |
+| peakCount | The current number of peak threads. | | long |
+| runnableStateThreadCount | The current number of threads in runnable state. | | long |
+| blockedStateThreadCount | The current number of threads in blocked state. | | long |
+| waitingStateThreadCount | The current number of threads in waiting state. | | long |
+| timedWaitingStateThreadCount | The current number of threads in time-waiting state. | | long |
6. SCOPE `ServiceInstanceJVMClass`
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string|
-| serviceName | The name of the service. | | string |
-| loadedClassCount | The number of classes that are currently loaded in the JVM. | | long |
-| totalUnloadedClassCount | The total number of classes unloaded since the JVM has started execution. | | long |
-| totalLoadedClassCount | The total number of classes that have been loaded since the JVM has started execution. | | long |
+| Name | Remarks | Group Key | Type |
+|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|--------|
+| name | The name of the service instance, such as `ip:port@Service Name`. **Note**: Currently, the native agent uses `uuid@ipv4` as the instance name, which does not assist in setting up a filter in aggregation. | | string |
+| serviceName | The name of the service. | | string |
+| loadedClassCount | The number of classes that are currently loaded in the JVM. | | long |
+| totalUnloadedClassCount | The total number of classes unloaded since the JVM has started execution. | | long |
+| totalLoadedClassCount | The total number of classes that have been loaded since the JVM has started execution. | | long |
### SCOPE `Endpoint`
This calculates the metrics data from each request of the endpoint in the service.
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The name of the endpoint, such as a full path of the HTTP URI. | | string |
-| serviceName | The name of the service. | | string |
-| serviceNodeType | The type of node to which the Service or Network address belongs, such as Normal, Database, MQ, or Cache. | | enum |
-| serviceInstanceName | The name of the service instance ID. | | string |
-| latency | The time taken by each request. | | int |
-| status | Indicates the success or failure of the request.| | bool(true for success) |
-| httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302| | int |
-| rpcStatusCode | The string value of the rpc response code. | | string |
-| type | The type of each request, such as Database, HTTP, RPC, or gRPC. | | enum |
-| tags | The labels of each request. Each value is made up by `TagKey:TagValue` in the segment. | | `List<String>` |
-| tag | The key-value pair of span tags in the segment. | | `Map<String, String>` |
-| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string|
+| Name | Remarks | Group Key | Type |
+|---------------------------|-----------------------------------------------------------------------------------------------------------|-----------|------------------------|
+| name | The name of the endpoint, such as a full path of the HTTP URI. | | string |
+| serviceName | The name of the service. | | string |
+| serviceNodeType | The type of node to which the Service or Network address belongs, such as Normal, Database, MQ, or Cache. | | enum |
+| serviceInstanceName | The name of the service instance ID. | | string |
+| latency | The time taken by each request. | | int |
+| status | Indicates the success or failure of the request. | | bool(true for success) |
+| httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302 | | int |
+| rpcStatusCode | The string value of the rpc response code. | | string |
+| type | The type of each request, such as Database, HTTP, RPC, or gRPC. | | enum |
+| tags | The labels of each request. Each value is made up by `TagKey:TagValue` in the segment. | | `List<String>` |
+| tag | The key-value pair of span tags in the segment. | | `Map<String, String>` |
+| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string |
### SCOPE `ServiceRelation`
@@ -224,196 +225,192 @@ This calculates the metrics data from each request between service instances.
| rpcStatusCode | The string value of the rpc response code. | | string |
| type | The type of each request, such as Database, HTTP, RPC, or gRPC. | | enum |
| detectPoint | Where the relation is detected. The value may be client, server, or proxy. | yes | enum |
-| tlsMode | The TLS mode between source and destination service instances, such as `service_instance_relation_mtls_cpm = from(ServiceInstanceRelation.*).filter(tlsMode == "mTLS").cpm()` || string | |
+| tlsMode | The TLS mode between source and destination service instances, such as `service_instance_relation_mtls_cpm = from(ServiceInstanceRelation.*).filter(tlsMode == "mTLS").cpm()` | | string |
| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string |
### SCOPE `TCPServiceInstanceRelation`
This calculates the metrics data from each request between service instances.
-| Name | Remarks | Group Key | Type |
-|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|------------------------|
-| sourceServiceName | The name of the source service. | | string |
-| sourceServiceInstanceName | The name of the source service instance. | | string |
-| sourceServiceLayer | The layer of the source service. | | enum |
-| destServiceName | The name of the destination service. | | |
-| destServiceInstanceName | The name of the destination service instance. | | string |
-| destServiceLayer | The layer of the destination service. | | enum |
-| componentId | The ID of the component used in this call. | yes | string |
-| detectPoint | Where the relation is detected. The value may be client, server, or proxy. | yes | enum |
-| tlsMode | The TLS mode between source and destination service instances, such as `service_instance_relation_mtls_cpm = from(ServiceInstanceRelation.*).filter(tlsMode == "mTLS").cpm()` || string | |
-| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string |
-| receivedBytes | The received bytes of the TCP traffic. | | long |
-| sentBytes | The sent bytes of the TCP traffic. | | long |
+| Name | Remarks | Group Key | Type |
+|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|--------|
+| sourceServiceName | The name of the source service. | | string |
+| sourceServiceInstanceName | The name of the source service instance. | | string |
+| sourceServiceLayer | The layer of the source service. | | enum |
+| destServiceName | The name of the destination service. | | |
+| destServiceInstanceName | The name of the destination service instance. | | string |
+| destServiceLayer | The layer of the destination service. | | enum |
+| componentId | The ID of the component used in this call. | yes | string |
+| detectPoint | Where the relation is detected. The value may be client, server, or proxy. | yes | enum |
+| tlsMode | The TLS mode between source and destination service instances, such as `service_instance_relation_mtls_cpm = from(ServiceInstanceRelation.*).filter(tlsMode == "mTLS").cpm()` | | string |
+| sideCar.internalErrorCode | The sidecar/gateway proxy internal error code. The value is based on the implementation. | | string |
+| receivedBytes | The received bytes of the TCP traffic. | | long |
+| sentBytes | The sent bytes of the TCP traffic. | | long |
### SCOPE `EndpointRelation`
This calculates the metrics data of the dependency between endpoints.
This relation is hard to detect, and it depends on the tracing library to propagate the previous endpoint.
-Therefore, the `EndpointRelation` scope aggregation comes into effect only in services under tracing by SkyWalking native agents,
-including auto instrument agents (like Java and .NET), OpenCensus SkyWalking exporter implementation, or other tracing context propagation in SkyWalking specification.
-
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| endpoint | The parent endpoint in the dependency.| | string|
-| serviceName | The name of the service. | | string |
-| serviceNodeType | The type of node to which the Service or Network address belongs, such as Normal, Database, MQ, or Cache. | | enum |
-| childEndpoint| The endpoint used by the parent endpoint in row(1). | | string |
-| childServiceName | The endpoint used by the parent service in row(1). | | string |
-| childServiceNodeType | The type of node to which the Service or Network address belongs, such as Normal, Database, MQ, or Cache. | | string |
-| childServiceInstanceName | The endpoint used by the parent service instance in row(1). | | string |
-| rpcLatency | The latency of the RPC between the parent endpoint and childEndpoint, excluding the latency caused by the parent endpoint itself.
-| componentId | The ID of the component used in this call. | yes | string
-| status | Indicates the success or failure of the request.| | bool(true for success) |
-| httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302| | int |
-| rpcStatusCode | The string value of the rpc response code. | | string |
-| type | The type of each request, such as Database, HTTP, RPC, or gRPC. | | enum |
-| detectPoint | Indicates where the relation is detected. The value may be client, server, or proxy. | yes | enum|
-
+Therefore, the `EndpointRelation` scope aggregation comes into effect only in services under tracing by SkyWalking
+native agents,
+including auto instrument agents (like Java and .NET), or other tracing context propagation in SkyWalking specification.
+
+| Name | Remarks | Group Key | Type |
+|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------|-----------|------------------------|
+| endpoint | The parent endpoint in the dependency. | | string |
+| serviceName | The name of the service. | | string |
+| serviceNodeType | The type of node to which the Service or Network address belongs, such as Normal, Database, MQ, or Cache. | | enum |
+| childEndpoint | The endpoint used by the parent endpoint in row(1). | | string |
+| childServiceName | The endpoint used by the parent service in row(1). | | string |
+| childServiceNodeType | The type of node to which the Service or Network address belongs, such as Normal, Database, MQ, or Cache. | | string |
+| childServiceInstanceName | The endpoint used by the parent service instance in row(1). | | string |
+| rpcLatency | The latency of the RPC between the parent endpoint and childEndpoint, excluding the latency caused by the parent endpoint itself.
+| componentId | The ID of the component used in this call. | yes | string
+| status | Indicates the success or failure of the request. | | bool(true for success) |
+| httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302 | | int |
+| rpcStatusCode | The string value of the rpc response code. | | string |
+| type | The type of each request, such as Database, HTTP, RPC, or gRPC. | | enum |
+| detectPoint | Indicates where the relation is detected. The value may be client, server, or proxy. | yes | enum |
### SCOPE `BrowserAppTraffic`
This calculates the metrics data from each request of the browser application (browser only).
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The browser application name of each request. | | string |
-| count | The number of request, which is fixed at 1. | | int |
-| trafficCategory | The traffic category. The value may be NORMAL, FIRST_ERROR, or ERROR. | | enum |
-| errorCategory | The error category. The value may be AJAX, RESOURCE, VUE, PROMISE, or UNKNOWN. | | enum |
+| Name | Remarks | Group Key | Type |
+|-----------------|--------------------------------------------------------------------------------|-----------|--------|
+| name | The browser application name of each request. | | string |
+| count | The number of request, which is fixed at 1. | | int |
+| trafficCategory | The traffic category. The value may be NORMAL, FIRST_ERROR, or ERROR. | | enum |
+| errorCategory | The error category. The value may be AJAX, RESOURCE, VUE, PROMISE, or UNKNOWN. | | enum |
### SCOPE `BrowserAppSingleVersionTraffic`
This calculates the metrics data from each request of a single version in the browser application (browser only).
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The single version name of each request. | | string |
-| serviceName | The name of the browser application. | | string |
-| count | The number of request, which is fixed at 1. | | int |
-| trafficCategory | The traffic category. The value may be NORMAL, FIRST_ERROR, or ERROR. | | enum |
-| errorCategory | The error category. The value may be AJAX, RESOURCE, VUE, PROMISE, or UNKNOWN. | | enum |
+| Name | Remarks | Group Key | Type |
+|-----------------|--------------------------------------------------------------------------------|-----------|--------|
+| name | The single version name of each request. | | string |
+| serviceName | The name of the browser application. | | string |
+| count | The number of request, which is fixed at 1. | | int |
+| trafficCategory | The traffic category. The value may be NORMAL, FIRST_ERROR, or ERROR. | | enum |
+| errorCategory | The error category. The value may be AJAX, RESOURCE, VUE, PROMISE, or UNKNOWN. | | enum |
### SCOPE `BrowserAppPageTraffic`
This calculates the metrics data from each request of the page in the browser application (browser only).
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The page name of each request. | | string |
-| serviceName | The name of the browser application. | | string |
-| count | The number of request, which is fixed at 1. | | int |
-| trafficCategory | The traffic category. The value may be NORMAL, FIRST_ERROR, or ERROR. | | enum |
-| errorCategory | The error category. The value may be AJAX, RESOURCE, VUE, PROMISE, or UNKNOWN. | | enum |
-
+| Name | Remarks | Group Key | Type |
+|-----------------|--------------------------------------------------------------------------------|-----------|--------|
+| name | The page name of each request. | | string |
+| serviceName | The name of the browser application. | | string |
+| count | The number of request, which is fixed at 1. | | int |
+| trafficCategory | The traffic category. The value may be NORMAL, FIRST_ERROR, or ERROR. | | enum |
+| errorCategory | The error category. The value may be AJAX, RESOURCE, VUE, PROMISE, or UNKNOWN. | | enum |
### SCOPE `BrowserAppPagePerf`
This calculates the metrics data from each request of the page in the browser application (browser only).
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The page name of each request. | | string |
-| serviceName | The name of the browser application. | | string |
-| redirectTime | The time taken to redirect. | | int(in ms) |
-| dnsTime | The DNS query time. | | int(in ms) |
-| ttfbTime | Time to first byte. | | int(in ms) |
-| tcpTime | TCP connection time. | | int(in ms) |
-| transTime | Content transfer time. | | int(in ms) |
-| domAnalysisTime | Dom parsing time. | | int(in ms) |
-| fptTime | First paint time or blank screen time. | | int(in ms) |
-| domReadyTime | Dom ready time. | | int(in ms) |
-| loadPageTime | Page full load time. | | int(in ms) |
-| resTime | Synchronous load resources in the page. | | int(in ms) |
-| sslTime | Only valid for HTTPS. | | int(in ms) |
-| ttlTime | Time to interact. | | int(in ms) |
-| firstPackTime | First pack time. | | int(in ms) |
-| fmpTime | First Meaningful Paint. | | int(in ms) |
+| Name | Remarks | Group Key | Type |
+|-----------------|-----------------------------------------|-----------|------------|
+| name | The page name of each request. | | string |
+| serviceName | The name of the browser application. | | string |
+| redirectTime | The time taken to redirect. | | int(in ms) |
+| dnsTime | The DNS query time. | | int(in ms) |
+| ttfbTime | Time to first byte. | | int(in ms) |
+| tcpTime | TCP connection time. | | int(in ms) |
+| transTime | Content transfer time. | | int(in ms) |
+| domAnalysisTime | Dom parsing time. | | int(in ms) |
+| fptTime | First paint time or blank screen time. | | int(in ms) |
+| domReadyTime | Dom ready time. | | int(in ms) |
+| loadPageTime | Page full load time. | | int(in ms) |
+| resTime | Synchronous load resources in the page. | | int(in ms) |
+| sslTime | Only valid for HTTPS. | | int(in ms) |
+| ttlTime | Time to interact. | | int(in ms) |
+| firstPackTime | First pack time. | | int(in ms) |
+| fmpTime | First Meaningful Paint. | | int(in ms) |
### SCOPE `Event`
This calculates the metrics data from [events](event.md).
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The name of the event. | | string |
-| service | The service name to which the event belongs to. | | string |
-| serviceInstance | The service instance to which the event belongs to, if any. | | string|
-| endpoint | The service endpoint to which the event belongs to, if any. | | string|
-| type | The type of the event, `Normal` or `Error`. | | string|
-| message | The message of the event. | | string |
-| parameters | The parameters in the `message`, see [parameters](event.md#parameters). | | string |
-
+| Name | Remarks | Group Key | Type |
+|-----------------|-------------------------------------------------------------------------|-----------|--------|
+| name | The name of the event. | | string |
+| service | The service name to which the event belongs to. | | string |
+| serviceInstance | The service instance to which the event belongs to, if any. | | string |
+| endpoint | The service endpoint to which the event belongs to, if any. | | string |
+| type | The type of the event, `Normal` or `Error`. | | string |
+| message | The message of the event. | | string |
+| parameters | The parameters in the `message`, see [parameters](event.md#parameters). | | string |
### SCOPE `DatabaseAccess`
This calculates the metrics data from each request of database.
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The service name of virtual database service. | | string |
-| databaseTypeId | The ID of the component used in this call. | | int |
-| latency | The time taken by each request. | | int(in ms)|
-| status | Indicates the success or failure of the request.| | boolean |
+| Name | Remarks | Group Key | Type |
+|----------------|--------------------------------------------------|-----------|------------|
+| name | The service name of virtual database service. | | string |
+| databaseTypeId | The ID of the component used in this call. | | int |
+| latency | The time taken by each request. | | int(in ms) |
+| status | Indicates the success or failure of the request. | | boolean |
### SCOPE `DatabaseSlowStatement`
This calculates the metrics data from slow request of database.
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| databaseServiceId | The service id of virtual cache service. | | string |
-| statement | The sql statement . | | string |
-| latency | The time taken by each request. | | int(in ms)|
-| traceId | The traceId of this slow statement| | string|
-
+| Name | Remarks | Group Key | Type |
+|-------------------|------------------------------------------|-----------|------------|
+| databaseServiceId | The service id of virtual cache service. | | string |
+| statement | The sql statement . | | string |
+| latency | The time taken by each request. | | int(in ms) |
+| traceId | The traceId of this slow statement | | string |
### SCOPE `CacheAccess`
This calculates the metrics data from each request of cache system.
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The service name of virtual cache service. | | string |
-| cacheTypeId | The ID of the component used in this call. | | int |
-| latency | The time taken by each request. | | int(in ms)|
-| status | Indicates the success or failure of the request.| | boolean |
-| operation | Indicates this access is used for `write` or `read` | | string |
-
+| Name | Remarks | Group Key | Type |
+|-------------|-----------------------------------------------------|-----------|------------|
+| name | The service name of virtual cache service. | | string |
+| cacheTypeId | The ID of the component used in this call. | | int |
+| latency | The time taken by each request. | | int(in ms) |
+| status | Indicates the success or failure of the request. | | boolean |
+| operation | Indicates this access is used for `write` or `read` | | string |
### SCOPE `CacheSlowAccess`
This calculates the metrics data from slow request of cache system , which is used for `write` or `read` operation.
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| cacheServiceId | The service id of virtual cache service. | | string |
-| command | The cache command . | | string |
-| key | The cache command key. | | string|
-| latency | The time taken by each request. | | int(in ms)|
-| traceId | The traceId of this slow access| | string|
-| status | Indicates the success or failure of the request.| | boolean |
-| operation | Indicates this access is used for `write` or `read` | | string |
+| Name | Remarks | Group Key | Type |
+|----------------|-----------------------------------------------------|-----------|------------|
+| cacheServiceId | The service id of virtual cache service. | | string |
+| command | The cache command . | | string |
+| key | The cache command key. | | string |
+| latency | The time taken by each request. | | int(in ms) |
+| traceId | The traceId of this slow access | | string |
+| status | Indicates the success or failure of the request. | | boolean |
+| operation | Indicates this access is used for `write` or `read` | | string |
### SCOPE `MQAccess`
This calculates the service dimensional metrics data from each request of MQ system on consume/produce side
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| name | The service name , usually it's MQ address(es) | |string|
-| transmissionLatency | The latency from produce side to consume side . | | int(in ms)|
-| status | Indicates the success or failure of the request.| | boolean |
-| operation | Indicates this access is on `Produce` or `Consume` side | | enum |
+| Name | Remarks | Group Key | Type |
+|---------------------|---------------------------------------------------------|-----------|------------|
+| name | The service name , usually it's MQ address(es) | | string |
+| transmissionLatency | The latency from produce side to consume side . | | int(in ms) |
+| status | Indicates the success or failure of the request. | | boolean |
+| operation | Indicates this access is on `Produce` or `Consume` side | | enum |
### SCOPE `MQEndpointAccess`
-This calculates the endpoint dimensional metrics data from each request of MQ system on consume/produce side
+This calculates the endpoint dimensional metrics data from each request of MQ system on consume/produce side
-| Name | Remarks | Group Key | Type |
-|---|---|---|---|
-| serviceName | The service name that this endpoint belongs to. | | string |
-| endpoint | The endpoint name , usually it's combined by `queue`,`topic` | | string |
-| transmissionLatency | The latency from produce side to consume side . | | int(in ms)|
-| status | Indicates the success or failure of the request.| | boolean |
-| operation | Indicates this access is on `Produce` or `Consume` side | | enum |
+| Name | Remarks | Group Key | Type |
+|---------------------|--------------------------------------------------------------|-----------|------------|
+| serviceName | The service name that this endpoint belongs to. | | string |
+| endpoint | The endpoint name , usually it's combined by `queue`,`topic` | | string |
+| transmissionLatency | The latency from produce side to consume side . | | int(in ms) |
+| status | Indicates the success or failure of the request. | | boolean |
+| operation | Indicates this access is on `Produce` or `Consume` side | | enum |
diff --git a/docs/en/setup/backend/configuration-vocabulary.md b/docs/en/setup/backend/configuration-vocabulary.md
index 9584ae482d..0e32d1936d 100644
--- a/docs/en/setup/backend/configuration-vocabulary.md
+++ b/docs/en/setup/backend/configuration-vocabulary.md
@@ -2,320 +2,320 @@
The Configuration Vocabulary lists all available configurations provided by `application.yml`.
-| Module | Provider | Settings | Value(s) and Explanation [...]
-|-------------------------|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| 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 perf [...]
-| - | - | restHost | Binding IP of RESTful services. Services include GraphQL query and HTTP data report. [...]
-| - | - | restPort | Binding port of RESTful services. [...]
-| - | - | restContextPath | Web context path of RESTful services. [...]
-| - | - | restMaxThreads | Maximum thread number of RESTful services. [...]
-| - | - | restIdleTimeOut | Connector idle timeout of RESTful services (in milliseconds). [...]
-| - | - | restAcceptQueueSize | ServerSocketChannel Backlog of RESTful services. [...]
-| - | - | httpMaxRequestHeaderSize | Maximum request header size accepted. [...]
-| - | - | gRPCHost | Binding IP of gRPC services, including gRPC data report and internal communication among OAP nodes. [...]
-| - | - | gRPCPort | Binding port of gRPC services. [...]
-| - | - | gRPCSslEnabled | Activates SSL for gRPC services. [...]
-| - | - | gRPCSslKeyPath | File path of gRPC SSL key. [...]
-| - | - | gRPCSslCertChainPath | File path of gRPC SSL cert chain. [...]
-| - | - | gRPCSslTrustedCAPath | File path of gRPC trusted CA. [...]
-| - | - | downsampling | Activated level of down sampling aggregation. [...]
-| - | - | enableDataKeeperExecutor | Controller of TTL scheduler. Once disabled, TTL wouldn't work. [...]
-| - | - | dataKeeperExecutePeriod | Execution period of TTL scheduler (in minutes). Execution doesn't mean deleting data. The storage provider (e.g. ElasticSearch storage) could override this. [...]
-| - | - | recordDataTTL | The lifecycle of record data (in days). Record data includes traces, top N sample records, and logs. Minimum value is 2. [...]
-| - | - | metricsDataTTL | The lifecycle of metrics data (in days), including metadata. We recommend setting metricsDataTTL >= recordDataTTL. Minimum value is 2. [...]
-| - | - | l1FlushPeriod | The period of L1 aggregation flush to L2 aggregation (in milliseconds). [...]
-| - | - | storageSessionTimeout | The threshold of session time (in milliseconds). Default value is 70000. [...]
-| - | - | persistentPeriod | The period of doing data persistence. Unit is second.Default value is 25s [...]
-| - | - | topNReportPeriod | The execution period (in minutes) of top N sampler, which saves sampled data into the storage. [...]
-| - | - | activeExtraModelColumns | Appends entity names (e.g. service names) into metrics storage entities. [...]
-| - | - | serviceNameMaxLength | Maximum length limit of service names. [...]
-| - | - | instanceNameMaxLength | Maximum length limit of service instance names. The maximum length of service + instance names should be less than 200. [...]
-| - | - | endpointNameMaxLength | Maximum length limit of endpoint names. The maximum length of service + endpoint names should be less than 240. [...]
-| - | - | searchableTracesTags | Defines a set of span tag keys which are searchable through GraphQL. Multiple values are separated by commas. The max length of key=value should be less than 256 or will be dropped. [...]
-| - | - | searchableLogsTags | Defines a set of log tag keys which are searchable through GraphQL. Multiple values are separated by commas. The max length of key=value should be less than 256 or will be dropped. [...]
-| - | - | searchableAlarmTags | Defines a set of alarm tag keys which are searchable through GraphQL. Multiple values are separated by commas. The max length of key=value should be less than 256 or will be dropped. [...]
-| - | - | autocompleteTagKeysQueryMaxSize | The max size of tags keys for autocomplete select. [...]
-| - | - | autocompleteTagValuesQueryMaxSize | The max size of tags values for autocomplete select. [...]
-| - | - | gRPCThreadPoolSize | Pool size of gRPC server. [...]
-| - | - | gRPCThreadPoolQueueSize | Queue size of gRPC server. [...]
-| - | - | 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. [...]
-| - | - | remoteTimeout | Timeout for cluster internal communication (in seconds). [...]
-| - | - | maxSizeOfNetworkAddressAlias | The maximum size of network address detected in the system being monitored. [...]
-| - | - | maxPageSizeOfQueryProfileSnapshot | The maximum size for snapshot analysis in an OAP query. [...]
-| - | - | maxSizeOfAnalyzeProfileSnapshot | The maximum number of snapshots analyzed by the OAP. [...]
-| - | - | prepareThreads | The number of threads used to prepare metrics data to the storage. [...]
-| - | - | enableEndpointNameGroupingByOpenapi | Automatically groups endpoints by the given OpenAPI definitions. [...]
-| - | - | maxDurationOfQueryEBPFProfilingData | The maximum duration(in second) of query the eBPF profiling data from database. [...]
-| - | - | maxThreadCountOfQueryEBPFProfilingData | The maximum thread count of query the eBPF profiling data from database. [...]
-| 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. [...]
-| - | - | hostPort | Hosts and ports of Zookeeper Cluster. [...]
-| - | - | baseSleepTimeMs | The period of Zookeeper client between two retries (in milliseconds). [...]
-| - | - | maxRetries | The maximum retry time. [...]
-| - | - | enableACL | Opens ACL using `schema` and `expression`. [...]
-| - | - | schema | Schema for the authorization. [...]
-| - | - | expression | Expression for the authorization. [...]
-| - | - | 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. [...]
-| - | kubernetes | namespace | Namespace deployed by SkyWalking in k8s. [...]
-| - | - | labelSelector | Labels used for filtering OAP deployment in k8s. [...]
-| - | - | uidEnvName | Environment variable name for reading uid. [...]
-| - | consul | serviceName | Service name for SkyWalking cluster. [...]
-| - | - | hostPort | Hosts and ports for Consul cluster. [...]
-| - | - | aclToken | ACL Token of Consul. Empty string means `without ALC token`. [...]
-| - | - | 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. [...]
-| - | etcd | serviceName | Service name for SkyWalking cluster. [...]
-| - | - | endpoints | Hosts and ports for etcd cluster. [...]
-| - | - | namespace | Namespace for SkyWalking cluster. [...]
-| - | - | authentication | Indicates whether there is authentication. [...]
-| - | - | user | Etcd auth username. [...]
-| - | - | password | Etcd auth password. [...]
-| - | - | internalComHost | The hostname registered in etcd for internal communications of the OAP cluster. [...]
-| - | - | internalComPort | The port registered in etcd for internal communications of the OAP cluster. [...]
-| - | Nacos | serviceName | Service name for SkyWalking cluster. [...]
-| - | - | hostPort | Hosts and ports for Nacos cluster. [...]
-| - | - | namespace | Namespace used by SkyWalking node coordination. [...]
-| - | - | 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. [...]
-| - | - | username | Nacos Auth username. [...]
-| - | - | password | Nacos Auth password. [...]
-| - | - | accessKey | Nacos Auth accessKey. [...]
-| - | - | secretKey | Nacos Auth secretKey. [...]
-| storage | elasticsearch | - | ElasticSearch (and OpenSearch) storage implementation. [...]
-| - | - | namespace | Prefix of indexes created and used by SkyWalking. [...]
-| - | - | clusterNodes | ElasticSearch cluster nodes for client connection. [...]
-| - | - | protocol | HTTP or HTTPs. [...]
-| - | - | connectTimeout | Connect timeout of ElasticSearch client (in milliseconds). [...]
-| - | - | socketTimeout | Socket timeout of ElasticSearch client (in milliseconds). [...]
-| - | - | responseTimeout | Response timeout of ElasticSearch client (in milliseconds), `0` disables the timeout. [...]
-| - | - | numHttpClientThread | The number of threads for the underlying HTTP client to perform socket I/O. If the value is <= 0, the number of available processors will be used. [...]
-| - | - | user | Username of ElasticSearch cluster. [...]
-| - | - | password | Password of ElasticSearch cluster. [...]
-| - | - | trustStorePath | Trust JKS file path. Only works when username and password are enabled. [...]
-| - | - | trustStorePass | Trust JKS file password. Only works when username and password are enabled. [...]
-| - | - | 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. [...]
-| - | - | dayStep | Represents the number of days in the one-minute/hour/day index. [...]
-| - | - | indexShardsNumber | Shard number of new indexes. [...]
-| - | - | indexReplicasNumber | Replicas number of new indexes. [...]
-| - | - | specificIndexSettings | Specify the settings for each index individually. If configured, this setting has the highest priority and overrides the generic settings. [...]
-| - | - | 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. [...]
-| - | - | 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. [...]
-| - | - | superDatasetIndexReplicasNumber | Represents the replicas number in the super size dataset record index. [...]
-| - | - | indexTemplateOrder | The order of index template. [...]
-| - | - | bulkActions | Async bulk size of the record data batch execution. [...]
-| - | - | batchOfBytes | A threshold to control the max body size of ElasticSearch Bulk flush. [...]
-| - | - | flushInterval | Period of flush (in seconds). Does not matter whether `bulkActions` is reached or not. [...]
-| - | - | concurrentRequests | The number of concurrent requests allowed to be executed. [...]
-| - | - | resultWindowMaxSize | The maximum size of dataset when the OAP loads cache, such as network aliases. [...]
-| - | - | metadataQueryMaxSize | The maximum size of metadata per query. [...]
-| - | - | scrollingBatchSize | The batch size of metadata per iteration when `metadataQueryMaxSize` or `resultWindowMaxSize` is too large to be retrieved in a single query. [...]
-| - | - | segmentQueryMaxSize | The maximum size of trace segments per query. [...]
-| - | - | profileTaskQueryMaxSize | The maximum size of profile task per query. [...]
-| - | - | profileDataQueryScrollBatchSize | The batch size of query profiling data. [...]
-| - | - | advanced | All settings of ElasticSearch index creation. The value should be in JSON format. [...]
-| - | - | logicSharding | Shard metrics and records indices into multi-physical indices, one index template per metric/meter aggregation function or record. [...]
-| - | h2 | - | H2 storage is designed for demonstration and running in short term (i.e. 1-2 hours) only. [...]
-| - | - | url | H2 connection URL. Defaults to H2 memory mode. [...]
-| - | - | user | Username of H2 database. [...]
-| - | - | password | Password of H2 database. [...]
-| - | - | metadataQueryMaxSize | The maximum size of metadata per query. [...]
-| - | - | maxSizeOfBatchSql | The maximum size of batch size of SQL execution [...]
-| - | - | asyncBatchPersistentPoolSize | async flush data into database thread size [...]
-| - | 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. [...]
-| - | - | metadataQueryMaxSize | The maximum size of metadata per query. [...]
-| - | - | maxSizeOfBatchSql | The maximum size of batch size of SQL execution [...]
-| - | - | asyncBatchPersistentPoolSize | async flush data into database thread size [...]
-| - | postgresql | - | PostgreSQL storage. [...]
-| - | - | properties | Hikari connection pool configurations. [...]
-| - | - | metadataQueryMaxSize | The maximum size of metadata per query. [...]
-| - | - | maxSizeOfBatchSql | The maximum size of batch size of SQL execution [...]
-| - | - | asyncBatchPersistentPoolSize | async flush data into database thread size [...]
-| - | banyandb | - | BanyanDB storage. [...]
-| - | - | host | Host of the BanyanDB. [...]
-| - | - | port | Port of the BanyanDB. [...]
-| - | - | maxBulkSize | The maximum size of write entities in a single batch write call. [...]
-| - | - | flushInterval | Period of flush interval. In the timeunit of seconds. [...]
-| - | - | metricsShardsNumber | Shards Number for measure/metrics. [...]
-| - | - | recordShardsNumber | Shards Number for a normal record. [...]
-| - | - | superDatasetShardsFactor | Shards Factor for a super dataset record, i.e. Shard number of a super dataset is recordShardsNumber*superDatasetShardsFactor. [...]
-| - | - | concurrentWriteThreads | Concurrent consumer threads for batch writing. [...]
-| - | - | profileTaskQueryMaxSize | Max size of ProfileTask to be fetched. [...]
-| agent-analyzer | default | Agent Analyzer. | SW_AGENT_ANALYZER [...]
-| - | - | traceSamplingPolicySettingsFile | The sampling policy including `sampling rate` and `the threshold of trace segment latency` can be configured by the `traceSamplingPolicySettingsFile` file. [...]
-| - | - | slowDBAccessThreshold | The slow database access threshold (in milliseconds). [...]
-| - | - | forceSampleErrorSegment | When sampling mechanism is activated, this config samples the error status segment and ignores the sampling rate. [...]
-| - | - | 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 segme [...]
-| - | - | 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. [...]
-| - | - | meterAnalyzerActiveFiles | Indicates which files could be instrumented and analyzed. Multiple files are split by ",". [...]
+| Module | Provider | Settings | Value(s) and Explanation [...]
+|-------------------------|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
+| 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 perf [...]
+| - | - | restHost | Binding IP of RESTful services. Services include GraphQL query and HTTP data report. [...]
+| - | - | restPort | Binding port of RESTful services. [...]
+| - | - | restContextPath | Web context path of RESTful services. [...]
+| - | - | restMaxThreads | Maximum thread number of RESTful services. [...]
+| - | - | restIdleTimeOut | Connector idle timeout of RESTful services (in milliseconds). [...]
+| - | - | restAcceptQueueSize | ServerSocketChannel Backlog of RESTful services. [...]
+| - | - | httpMaxRequestHeaderSize | Maximum request header size accepted. [...]
+| - | - | gRPCHost | Binding IP of gRPC services, including gRPC data report and internal communication among OAP nodes. [...]
+| - | - | gRPCPort | Binding port of gRPC services. [...]
+| - | - | gRPCSslEnabled | Activates SSL for gRPC services. [...]
+| - | - | gRPCSslKeyPath | File path of gRPC SSL key. [...]
+| - | - | gRPCSslCertChainPath | File path of gRPC SSL cert chain. [...]
+| - | - | gRPCSslTrustedCAPath | File path of gRPC trusted CA. [...]
+| - | - | downsampling | Activated level of down sampling aggregation. [...]
+| - | - | enableDataKeeperExecutor | Controller of TTL scheduler. Once disabled, TTL wouldn't work. [...]
+| - | - | dataKeeperExecutePeriod | Execution period of TTL scheduler (in minutes). Execution doesn't mean deleting data. The storage provider (e.g. ElasticSearch storage) could override this. [...]
+| - | - | recordDataTTL | The lifecycle of record data (in days). Record data includes traces, top N sample records, and logs. Minimum value is 2. [...]
+| - | - | metricsDataTTL | The lifecycle of metrics data (in days), including metadata. We recommend setting metricsDataTTL >= recordDataTTL. Minimum value is 2. [...]
+| - | - | l1FlushPeriod | The period of L1 aggregation flush to L2 aggregation (in milliseconds). [...]
+| - | - | storageSessionTimeout | The threshold of session time (in milliseconds). Default value is 70000. [...]
+| - | - | persistentPeriod | The period of doing data persistence. Unit is second.Default value is 25s [...]
+| - | - | topNReportPeriod | The execution period (in minutes) of top N sampler, which saves sampled data into the storage. [...]
+| - | - | activeExtraModelColumns | Appends entity names (e.g. service names) into metrics storage entities. [...]
+| - | - | serviceNameMaxLength | Maximum length limit of service names. [...]
+| - | - | instanceNameMaxLength | Maximum length limit of service instance names. The maximum length of service + instance names should be less than 200. [...]
+| - | - | endpointNameMaxLength | Maximum length limit of endpoint names. The maximum length of service + endpoint names should be less than 240. [...]
+| - | - | searchableTracesTags | Defines a set of span tag keys which are searchable through GraphQL. Multiple values are separated by commas. The max length of key=value should be less than 256 or will be dropped. [...]
+| - | - | searchableLogsTags | Defines a set of log tag keys which are searchable through GraphQL. Multiple values are separated by commas. The max length of key=value should be less than 256 or will be dropped. [...]
+| - | - | searchableAlarmTags | Defines a set of alarm tag keys which are searchable through GraphQL. Multiple values are separated by commas. The max length of key=value should be less than 256 or will be dropped. [...]
+| - | - | autocompleteTagKeysQueryMaxSize | The max size of tags keys for autocomplete select. [...]
+| - | - | autocompleteTagValuesQueryMaxSize | The max size of tags values for autocomplete select. [...]
+| - | - | gRPCThreadPoolSize | Pool size of gRPC server. [...]
+| - | - | gRPCThreadPoolQueueSize | Queue size of gRPC server. [...]
+| - | - | 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. [...]
+| - | - | remoteTimeout | Timeout for cluster internal communication (in seconds). [...]
+| - | - | maxSizeOfNetworkAddressAlias | The maximum size of network address detected in the system being monitored. [...]
+| - | - | maxPageSizeOfQueryProfileSnapshot | The maximum size for snapshot analysis in an OAP query. [...]
+| - | - | maxSizeOfAnalyzeProfileSnapshot | The maximum number of snapshots analyzed by the OAP. [...]
+| - | - | prepareThreads | The number of threads used to prepare metrics data to the storage. [...]
+| - | - | enableEndpointNameGroupingByOpenapi | Automatically groups endpoints by the given OpenAPI definitions. [...]
+| - | - | maxDurationOfQueryEBPFProfilingData | The maximum duration(in second) of query the eBPF profiling data from database. [...]
+| - | - | maxThreadCountOfQueryEBPFProfilingData | The maximum thread count of query the eBPF profiling data from database. [...]
+| 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. [...]
+| - | - | hostPort | Hosts and ports of Zookeeper Cluster. [...]
+| - | - | baseSleepTimeMs | The period of Zookeeper client between two retries (in milliseconds). [...]
+| - | - | maxRetries | The maximum retry time. [...]
+| - | - | enableACL | Opens ACL using `schema` and `expression`. [...]
+| - | - | schema | Schema for the authorization. [...]
+| - | - | expression | Expression for the authorization. [...]
+| - | - | 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. [...]
+| - | kubernetes | namespace | Namespace deployed by SkyWalking in k8s. [...]
+| - | - | labelSelector | Labels used for filtering OAP deployment in k8s. [...]
+| - | - | uidEnvName | Environment variable name for reading uid. [...]
+| - | consul | serviceName | Service name for SkyWalking cluster. [...]
+| - | - | hostPort | Hosts and ports for Consul cluster. [...]
+| - | - | aclToken | ACL Token of Consul. Empty string means `without ALC token`. [...]
+| - | - | 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. [...]
+| - | etcd | serviceName | Service name for SkyWalking cluster. [...]
+| - | - | endpoints | Hosts and ports for etcd cluster. [...]
+| - | - | namespace | Namespace for SkyWalking cluster. [...]
+| - | - | authentication | Indicates whether there is authentication. [...]
+| - | - | user | Etcd auth username. [...]
+| - | - | password | Etcd auth password. [...]
+| - | - | internalComHost | The hostname registered in etcd for internal communications of the OAP cluster. [...]
+| - | - | internalComPort | The port registered in etcd for internal communications of the OAP cluster. [...]
+| - | Nacos | serviceName | Service name for SkyWalking cluster. [...]
+| - | - | hostPort | Hosts and ports for Nacos cluster. [...]
+| - | - | namespace | Namespace used by SkyWalking node coordination. [...]
+| - | - | 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. [...]
+| - | - | username | Nacos Auth username. [...]
+| - | - | password | Nacos Auth password. [...]
+| - | - | accessKey | Nacos Auth accessKey. [...]
+| - | - | secretKey | Nacos Auth secretKey. [...]
+| storage | elasticsearch | - | ElasticSearch (and OpenSearch) storage implementation. [...]
+| - | - | namespace | Prefix of indexes created and used by SkyWalking. [...]
+| - | - | clusterNodes | ElasticSearch cluster nodes for client connection. [...]
+| - | - | protocol | HTTP or HTTPs. [...]
+| - | - | connectTimeout | Connect timeout of ElasticSearch client (in milliseconds). [...]
+| - | - | socketTimeout | Socket timeout of ElasticSearch client (in milliseconds). [...]
+| - | - | responseTimeout | Response timeout of ElasticSearch client (in milliseconds), `0` disables the timeout. [...]
+| - | - | numHttpClientThread | The number of threads for the underlying HTTP client to perform socket I/O. If the value is <= 0, the number of available processors will be used. [...]
+| - | - | user | Username of ElasticSearch cluster. [...]
+| - | - | password | Password of ElasticSearch cluster. [...]
+| - | - | trustStorePath | Trust JKS file path. Only works when username and password are enabled. [...]
+| - | - | trustStorePass | Trust JKS file password. Only works when username and password are enabled. [...]
+| - | - | 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. [...]
+| - | - | dayStep | Represents the number of days in the one-minute/hour/day index. [...]
+| - | - | indexShardsNumber | Shard number of new indexes. [...]
+| - | - | indexReplicasNumber | Replicas number of new indexes. [...]
+| - | - | specificIndexSettings | Specify the settings for each index individually. If configured, this setting has the highest priority and overrides the generic settings. [...]
+| - | - | 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. [...]
+| - | - | 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. [...]
+| - | - | superDatasetIndexReplicasNumber | Represents the replicas number in the super size dataset record index. [...]
+| - | - | indexTemplateOrder | The order of index template. [...]
+| - | - | bulkActions | Async bulk size of the record data batch execution. [...]
+| - | - | batchOfBytes | A threshold to control the max body size of ElasticSearch Bulk flush. [...]
+| - | - | flushInterval | Period of flush (in seconds). Does not matter whether `bulkActions` is reached or not. [...]
+| - | - | concurrentRequests | The number of concurrent requests allowed to be executed. [...]
+| - | - | resultWindowMaxSize | The maximum size of dataset when the OAP loads cache, such as network aliases. [...]
+| - | - | metadataQueryMaxSize | The maximum size of metadata per query. [...]
+| - | - | scrollingBatchSize | The batch size of metadata per iteration when `metadataQueryMaxSize` or `resultWindowMaxSize` is too large to be retrieved in a single query. [...]
+| - | - | segmentQueryMaxSize | The maximum size of trace segments per query. [...]
+| - | - | profileTaskQueryMaxSize | The maximum size of profile task per query. [...]
+| - | - | profileDataQueryScrollBatchSize | The batch size of query profiling data. [...]
+| - | - | advanced | All settings of ElasticSearch index creation. The value should be in JSON format. [...]
+| - | - | logicSharding | Shard metrics and records indices into multi-physical indices, one index template per metric/meter aggregation function or record. [...]
+| - | h2 | - | H2 storage is designed for demonstration and running in short term (i.e. 1-2 hours) only. [...]
+| - | - | url | H2 connection URL. Defaults to H2 memory mode. [...]
+| - | - | user | Username of H2 database. [...]
+| - | - | password | Password of H2 database. [...]
+| - | - | metadataQueryMaxSize | The maximum size of metadata per query. [...]
+| - | - | maxSizeOfBatchSql | The maximum size of batch size of SQL execution [...]
+| - | - | asyncBatchPersistentPoolSize | async flush data into database thread size [...]
+| - | 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. [...]
+| - | - | metadataQueryMaxSize | The maximum size of metadata per query. [...]
+| - | - | maxSizeOfBatchSql | The maximum size of batch size of SQL execution [...]
+| - | - | asyncBatchPersistentPoolSize | async flush data into database thread size [...]
+| - | postgresql | - | PostgreSQL storage. [...]
+| - | - | properties | Hikari connection pool configurations. [...]
+| - | - | metadataQueryMaxSize | The maximum size of metadata per query. [...]
+| - | - | maxSizeOfBatchSql | The maximum size of batch size of SQL execution [...]
+| - | - | asyncBatchPersistentPoolSize | async flush data into database thread size [...]
+| - | banyandb | - | BanyanDB storage. [...]
+| - | - | host | Host of the BanyanDB. [...]
+| - | - | port | Port of the BanyanDB. [...]
+| - | - | maxBulkSize | The maximum size of write entities in a single batch write call. [...]
+| - | - | flushInterval | Period of flush interval. In the timeunit of seconds. [...]
+| - | - | metricsShardsNumber | Shards Number for measure/metrics. [...]
+| - | - | recordShardsNumber | Shards Number for a normal record. [...]
+| - | - | superDatasetShardsFactor | Shards Factor for a super dataset record, i.e. Shard number of a super dataset is recordShardsNumber*superDatasetShardsFactor. [...]
+| - | - | concurrentWriteThreads | Concurrent consumer threads for batch writing. [...]
+| - | - | profileTaskQueryMaxSize | Max size of ProfileTask to be fetched. [...]
+| agent-analyzer | default | Agent Analyzer. | SW_AGENT_ANALYZER [...]
+| - | - | traceSamplingPolicySettingsFile | The sampling policy including `sampling rate` and `the threshold of trace segment latency` can be configured by the `traceSamplingPolicySettingsFile` file. [...]
+| - | - | slowDBAccessThreshold | The slow database access threshold (in milliseconds). [...]
+| - | - | forceSampleErrorSegment | When sampling mechanism is activated, this config samples the error status segment and ignores the sampling rate. [...]
+| - | - | 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 segme [...]
+| - | - | 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. [...]
+| - | - | meterAnalyzerActiveFiles | Indicates which files could be instrumented and analyzed. Multiple files are split by ",". [...]
| - | - | slowCacheWriteThreshold | The threshold of slow command which is used for writing operation (in milliseconds). [...]
| - | - | slowCacheReadThreshold | The threshold of slow command which is used for reading (getting) operation (in milliseconds). [...]
-| 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. [...]
-| - | - | restPort | Binding port of RESTful services. [...]
-| - | - | restContextPath | Web context path of RESTful services. [...]
-| - | - | restMaxThreads | Maximum thread number of RESTful services. [...]
-| - | - | restIdleTimeOut | Connector idle timeout of RESTful services (in milliseconds). [...]
-| - | - | restAcceptQueueSize | ServerSocketChannel backlog of RESTful services. [...]
-| - | - | httpMaxRequestHeaderSize | Maximum request header size accepted. [...]
-| - | - | gRPCHost | Binding IP of gRPC services. Services include gRPC data report and internal communication among OAP nodes. [...]
-| - | - | gRPCPort | Binding port of gRPC services. [...]
-| - | - | gRPCThreadPoolSize | Pool size of gRPC server. [...]
-| - | - | gRPCThreadPoolQueueSize | Queue size of gRPC server. [...]
-| - | - | gRPCSslEnabled | Activates SSL for gRPC services. [...]
-| - | - | gRPCSslKeyPath | File path of gRPC SSL key. [...]
-| - | - | gRPCSslCertChainPath | File path of gRPC SSL cert chain. [...]
-| - | - | maxConcurrentCallsPerConnection | The maximum number of concurrent calls permitted for each incoming connection. Defaults to no limit. [...]
-| - | - | authentication | The token text for authentication. Works for gRPC connection only. Once this is set, the client is required to use the same token. [...]
-| log-analyzer | default | Log Analyzer. | SW_LOG_ANALYZER [...]
-| - | - | lalFiles | The LAL configuration file names (without file extension) to be activated. Read [LAL](../../concepts-and-designs/lal.md) for more details. [...]
-| - | - | malFiles | The MAL configuration file names (without file extension) to be activated. Read [LAL](../../concepts-and-designs/lal.md) for more details. [...]
-| event-analyzer | default | Event Analyzer. | SW_EVENT_ANALYZER [...]
-| receiver-register | default | gRPC and HTTPRestful services that provide service, service instance and endpoint register. | - [...]
-| receiver-trace | default | gRPC and HTTPRestful services that accept SkyWalking format traces. | - [...]
-| receiver-jvm | default | gRPC services that accept JVM metrics data. | - [...]
-| receiver-clr | default | gRPC services that accept .Net CLR metrics data. | - [...]
-| receiver-profile | default | gRPC services that accept profile task status and snapshot reporter. | - [...]
-| receiver-zabbix | default | TCP receiver accepts Zabbix format metrics. | - [...]
-| - | - | port | Exported TCP port. Zabbix agent could connect and transport data. [...]
-| - | - | host | Binds to host. [...]
-| - | - | activeFiles | Enables config when agent request is received. [...]
-| service-mesh | default | gRPC services that accept data from inbound mesh probes. | - [...]
-| envoy-metric | default | Envoy `metrics_service` and `ALS(access log service)` are supported by this receiver. The OAL script supports all GAUGE type metrics. | - [...]
-| - | - | acceptMetricsService | Starts Envoy Metrics Service analysis. [...]
-| - | - | alsHTTPAnalysis | Starts Envoy HTTP Access Log Service analysis. Value = `k8s-mesh` means starting the analysis. [...]
-| - | - | alsTCPAnalysis | Starts Envoy TCP Access Log Service analysis. Value = `k8s-mesh` means starting the 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 [...]
-| receiver-otel | default | A receiver for analyzing metrics data from OpenTelemetry. | - [...]
-| - | - | enabledHandlers | Enabled handlers for otel. [...]
-| - | - | enabledOtelRules | Enabled metric rules for OC handler. [...]
-| receiver-zipkin | default | A receiver for Zipkin traces. | - [...]
-| - | - | sampleRate | The sample rate precision is 1/10000, should be between 0 and 10000 [...]
-| - | - | searchableTracesTags | Defines a set of span tag keys which are searchable. Multiple values are separated by commas. The max length of key=value should be less than 256 or will be dropped. [...]
-| - | - | enableHttpCollector | Enable Http Collector. [...]
-| - | - | restHost | Binding IP of RESTful services. [...]
-| - | - | restPort | Binding port of RESTful services. [...]
-| - | - | restContextPath | Web context path of RESTful services. [...]
-| - | - | restMaxThreads | Maximum thread number of RESTful services. [...]
-| - | - | restIdleTimeOut | Connector idle timeout of RESTful services (in milliseconds). [...]
-| - | - | restAcceptQueueSize | Maximum request header size accepted. [...]
-| - | - | enableKafkaCollector | Enable Kafka Collector. [...]
-| - | - | kafkaBootstrapServers | Kafka ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG. [...]
-| - | - | kafkaGroupId | Kafka ConsumerConfig.GROUP_ID_CONFIG. [...]
-| - | - | kafkaTopic | Kafka Topics. [...]
-| - | - | kafkaConsumerConfig | Kafka consumer config, JSON format as Properties. If it contains the same key with above, would override. [...]
-| - | - | kafkaConsumers | The number of consumers to create. [...]
-| - | - | kafkaHandlerThreadPoolSize | Pool size of Kafka message handler executor. [...]
-| - | - | kafkaHandlerThreadPoolQueueSize | Queue size of Kafka message handler executor. [...]
-| kafka-fetcher | default | Read SkyWalking's native metrics/logs/traces through Kafka server. | - [...]
-| - | - | bootstrapServers | A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. [...]
-| - | - | 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`. [...]
-| - | - | groupId | A unique string that identifies the consumer group to which this consumer belongs. [...]
-| - | - | createTopicIfNotExist | If true, this creates Kafka topic (if it does not already exist). [...]
-| - | - | partitions | The number of partitions for the topic being created. [...]
-| - | - | consumers | The number of consumers to create. [...]
-| - | - | enableNativeProtoLog | Enables fetching and handling native proto log data. [...]
-| - | - | enableNativeJsonLog | Enables fetching and handling native json log data. [...]
-| - | - | replicationFactor | The replication factor for each partition in the topic being created. [...]
-| - | - | kafkaHandlerThreadPoolSize | Pool size of Kafka message handler executor. [...]
-| - | - | kafkaHandlerThreadPoolQueueSize | Queue size of Kafka message handler executor. [...]
-| - | - | topicNameOfMeters | Kafka topic name for meter system data. [...]
-| - | - | topicNameOfMetrics | Kafka topic name for JVM metrics data. [...]
-| - | - | topicNameOfProfiling | Kafka topic name for profiling data. [...]
-| - | - | topicNameOfTracingSegments | Kafka topic name for tracing data. [...]
-| - | - | topicNameOfManagements | Kafka topic name for service instance reporting and registration. [...]
-| - | - | topicNameOfLogs | Kafka topic name for native proto log data. [...]
-| - | - | topicNameOfJsonLogs | Kafka topic name for native json log data. [...]
-| receiver-browser | default | gRPC services that accept browser performance data and error log. | - [...]
-| - | - | sampleRate | Sampling rate for receiving trace. Precise to 1/10000. 10000 means sampling rate of 100% by default. [...]
-| query | graphql | - | GraphQL query implementation. [...]
-| - | - | enableLogTestTool | Enable the log testing API to test the LAL. **NOTE**: This API evaluates untrusted code on the OAP server. A malicious script can do significant damage (steal keys and secrets, remove files and directories, install malware, etc). As such, please enable this API only when you c [...]
-| - | - | maxQueryComplexity | Maximum complexity allowed for the GraphQL query that can be used to abort a query if the total number of data fields queried exceeds the defined threshold. [...]
-| - | - | enableUpdateUITemplate | Allow user add，disable and update UI template. [...]
-| - | - | enableOnDemandPodLog | Ondemand Pod log: fetch the Pod logs on users' demand, the logs are fetched and displayed in real time, and are not persisted in any kind. This is helpful when users want to do some experiments and monitor the logs and see what's happing inside the service. Note: if you print [...]
-| query-zipkin | default | - | This module is for Zipkin query API and support zipkin-lens UI [...]
-| - | - | restHost | Binding IP of RESTful services. [...]
-| - | - | restPort | Binding port of RESTful services. [...]
-| - | - | restContextPath | Web context path of RESTful services. [...]
-| - | - | restMaxThreads | Maximum thread number of RESTful services. [...]
-| - | - | restIdleTimeOut | Connector idle timeout of RESTful services (in milliseconds). [...]
-| - | - | restAcceptQueueSize | Maximum request header size accepted. [...]
-| - | - | lookback | Default look back for traces and autocompleteTags, 1 day in millis | SW_QUERY_ZIPKIN_LOOKBACK | 86400000 [...]
-| - | - | namesMaxAge | The Cache-Control max-age (seconds) for serviceNames, remoteServiceNames and spanNames [...]
-| - | - | uiQueryLimit | Default traces query max size [...]
-| - | - | uiDefaultLookback | Default look back on the UI for search traces, 15 minutes in millis [...]
-| promql | default | - | This module is for PromQL API. [...]
-| - | - | restHost | Binding IP of RESTful services. [...]
-| - | - | restPort | Binding port of RESTful services. [...]
-| - | - | restContextPath | Web context path of RESTful services. [...]
-| - | - | restMaxThreads | Maximum thread number of RESTful services. [...]
-| - | - | restIdleTimeOut | Connector idle timeout of RESTful services (in milliseconds). [...]
-| - | - | restAcceptQueueSize | Maximum request header size accepted. [...]
-| 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. [...]
-| - | - | port | Binding port for Prometheus server fetching data. [...]
-| configuration | - | - | Read [dynamic configuration doc](dynamic-config.md) for more details. [...]
-| - | grpc | host | DCS server binding hostname. [...]
-| - | - | port | DCS server binding port. [...]
-| - | - | clusterName | Cluster name when reading the latest configuration from DSC server. [...]
-| - | - | period | The period of reading data from DSC server by the OAP (in seconds). [...]
-| - | apollo | apolloMeta | `apollo.meta` in Apollo. [...]
-| - | - | apolloCluster | `apollo.cluster` in Apollo. [...]
-| - | - | apolloEnv | `env` in Apollo. [...]
-| - | - | appId | `app.id` in Apollo. [...]
-| - | - | period | The period of data sync (in seconds). [...]
-| - | zookeeper | namespace | The namespace (represented by root path) that isolates the configurations in the Zookeeper. [...]
-| - | - | hostPort | Hosts and ports of Zookeeper Cluster. [...]
-| - | - | baseSleepTimeMs | The period of Zookeeper client between two retries (in milliseconds). [...]
-| - | - | maxRetries | The maximum retry time. [...]
-| - | - | period | The period of data sync (in seconds). [...]
-| - | etcd | endpoints | Hosts and ports for etcd cluster (separated by commas if multiple). [...]
-| - | - | namespace | Namespace for SkyWalking cluster. [...]
-| - | - | authentication | Indicates whether there is authentication. [...]
-| - | - | user | Etcd auth username. [...]
-| - | - | password | Etcd auth password. [...]
-| - | - | period | The period of data sync (in seconds). [...]
-| - | consul | hostPort | Hosts and ports for Consul cluster. [...]
-| - | - | aclToken | ACL Token of Consul. Empty string means `without ACL token`. [...]
-| - | - | period | The period of data sync (in seconds). [...]
-| - | k8s-configmap | namespace | Deployment namespace of the config map. [...]
-| - | - | labelSelector | Labels for locating configmap. [...]
-| - | - | period | The period of data sync (in seconds). [...]
-| - | nacos | serverAddr | Nacos Server Host. [...]
-| - | - | port | Nacos Server Port. [...]
-| - | - | group | Nacos Configuration namespace. [...]
-| - | - | period | The period of data sync (in seconds). [...]
-| - | - | username | Nacos Auth username. [...]
-| - | - | password | Nacos Auth password. [...]
-| - | - | accessKey | Nacos Auth accessKey. [...]
-| - | - | secretKey | Nacos Auth secretKey. [...]
-| exporter | default | enableGRPCMetrics | Enable gRPC metrics exporter. [...]
-| - | - | gRPCTargetHost | The host of target gRPC server for receiving export data [...]
-| - | - | gRPCTargetPort | The port of target gRPC server for receiving export data. [...]
-| - | - | enableKafkaTrace | Enable Kafka trace exporter. [...]
-| - | - | enableKafkaLog | Enable Kafka log exporter. [...]
-| - | - | kafkaBootstrapServers | A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. [...]
-| - | - | kafkaProducerConfig | Kafka producer config, JSON format as Properties. [...]
-| - | - | kafkaTopicTrace | Kafka topic name for trace. [...]
-| - | - | kafkaTopicLog | Kafka topic name for log. [...]
-| health-checker | default | checkIntervalSeconds | The period of checking OAP internal health status (in seconds). [...]
-| 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. [...]
-| receiver-event | default | gRPC services that handle events data. | - [...]
-| aws-firehose-receiver | default | host | Binding IP of HTTP server [...]
-| - | - | port | Binding port of HTTP server [...]
-| - | - | contextPath | Context path of HTTP server [...]
-| - | - | maxThreads | Max Thtread number of HTTP server [...]
-| - | - | idleTimeOut | Idle timeout of a connection for keep-alive. [...]
-| - | - | acceptQueueSize | Maximum allowed number of open connections [...]
-| - | - | maxRequestHeaderSize | Maximum length of all headers in an HTTP/1 response [...]
-| - | - | firehoseAccessKey | The AccessKey of AWS firhose [...]
-| - | - | enableTLS | Indicate if enable HTTPS for the server [...]
-| - | - | tlsKeyPath | TLS key path [...]
-| - | - | tlsCertChainPath | TLS certificate chain path [...]
+| 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. [...]
+| - | - | restPort | Binding port of RESTful services. [...]
+| - | - | restContextPath | Web context path of RESTful services. [...]
+| - | - | restMaxThreads | Maximum thread number of RESTful services. [...]
+| - | - | restIdleTimeOut | Connector idle timeout of RESTful services (in milliseconds). [...]
+| - | - | restAcceptQueueSize | ServerSocketChannel backlog of RESTful services. [...]
+| - | - | httpMaxRequestHeaderSize | Maximum request header size accepted. [...]
+| - | - | gRPCHost | Binding IP of gRPC services. Services include gRPC data report and internal communication among OAP nodes. [...]
+| - | - | gRPCPort | Binding port of gRPC services. [...]
+| - | - | gRPCThreadPoolSize | Pool size of gRPC server. [...]
+| - | - | gRPCThreadPoolQueueSize | Queue size of gRPC server. [...]
+| - | - | gRPCSslEnabled | Activates SSL for gRPC services. [...]
+| - | - | gRPCSslKeyPath | File path of gRPC SSL key. [...]
+| - | - | gRPCSslCertChainPath | File path of gRPC SSL cert chain. [...]
+| - | - | maxConcurrentCallsPerConnection | The maximum number of concurrent calls permitted for each incoming connection. Defaults to no limit. [...]
+| - | - | authentication | The token text for authentication. Works for gRPC connection only. Once this is set, the client is required to use the same token. [...]
+| log-analyzer | default | Log Analyzer. | SW_LOG_ANALYZER [...]
+| - | - | lalFiles | The LAL configuration file names (without file extension) to be activated. Read [LAL](../../concepts-and-designs/lal.md) for more details. [...]
+| - | - | malFiles | The MAL configuration file names (without file extension) to be activated. Read [LAL](../../concepts-and-designs/lal.md) for more details. [...]
+| event-analyzer | default | Event Analyzer. | SW_EVENT_ANALYZER [...]
+| receiver-register | default | gRPC and HTTPRestful services that provide service, service instance and endpoint register. | - [...]
+| receiver-trace | default | gRPC and HTTPRestful services that accept SkyWalking format traces. | - [...]
+| receiver-jvm | default | gRPC services that accept JVM metrics data. | - [...]
+| receiver-clr | default | gRPC services that accept .Net CLR metrics data. | - [...]
+| receiver-profile | default | gRPC services that accept profile task status and snapshot reporter. | - [...]
+| receiver-zabbix | default | TCP receiver accepts Zabbix format metrics. | - [...]
+| - | - | port | Exported TCP port. Zabbix agent could connect and transport data. [...]
+| - | - | host | Binds to host. [...]
+| - | - | activeFiles | Enables config when agent request is received. [...]
+| service-mesh | default | gRPC services that accept data from inbound mesh probes. | - [...]
+| envoy-metric | default | Envoy `metrics_service` and `ALS(access log service)` are supported by this receiver. The OAL script supports all GAUGE type metrics. | - [...]
+| - | - | acceptMetricsService | Starts Envoy Metrics Service analysis. [...]
+| - | - | alsHTTPAnalysis | Starts Envoy HTTP Access Log Service analysis. Value = `k8s-mesh` means starting the analysis. [...]
+| - | - | alsTCPAnalysis | Starts Envoy TCP Access Log Service analysis. Value = `k8s-mesh` means starting the 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 [...]
+| receiver-otel | default | A receiver for analyzing metrics data from OpenTelemetry. | - [...]
+| - | - | enabledHandlers | Enabled handlers for otel. [...]
+| - | - | enabledOtelRules | Enabled metric rules for OTLP handler. [...]
+| receiver-zipkin | default | A receiver for Zipkin traces. | - [...]
+| - | - | sampleRate | The sample rate precision is 1/10000, should be between 0 and 10000 [...]
+| - | - | searchableTracesTags | Defines a set of span tag keys which are searchable. Multiple values are separated by commas. The max length of key=value should be less than 256 or will be dropped. [...]
+| - | - | enableHttpCollector | Enable Http Collector. [...]
+| - | - | restHost | Binding IP of RESTful services. [...]
+| - | - | restPort | Binding port of RESTful services. [...]
+| - | - | restContextPath | Web context path of RESTful services. [...]
+| - | - | restMaxThreads | Maximum thread number of RESTful services. [...]
+| - | - | restIdleTimeOut | Connector idle timeout of RESTful services (in milliseconds). [...]
+| - | - | restAcceptQueueSize | Maximum request header size accepted. [...]
+| - | - | enableKafkaCollector | Enable Kafka Collector. [...]
+| - | - | kafkaBootstrapServers | Kafka ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG. [...]
+| - | - | kafkaGroupId | Kafka ConsumerConfig.GROUP_ID_CONFIG. [...]
+| - | - | kafkaTopic | Kafka Topics. [...]
+| - | - | kafkaConsumerConfig | Kafka consumer config, JSON format as Properties. If it contains the same key with above, would override. [...]
+| - | - | kafkaConsumers | The number of consumers to create. [...]
+| - | - | kafkaHandlerThreadPoolSize | Pool size of Kafka message handler executor. [...]
+| - | - | kafkaHandlerThreadPoolQueueSize | Queue size of Kafka message handler executor. [...]
+| kafka-fetcher | default | Read SkyWalking's native metrics/logs/traces through Kafka server. | - [...]
+| - | - | bootstrapServers | A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. [...]
+| - | - | 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`. [...]
+| - | - | groupId | A unique string that identifies the consumer group to which this consumer belongs. [...]
+| - | - | createTopicIfNotExist | If true, this creates Kafka topic (if it does not already exist). [...]
+| - | - | partitions | The number of partitions for the topic being created. [...]
+| - | - | consumers | The number of consumers to create. [...]
+| - | - | enableNativeProtoLog | Enables fetching and handling native proto log data. [...]
+| - | - | enableNativeJsonLog | Enables fetching and handling native json log data. [...]
+| - | - | replicationFactor | The replication factor for each partition in the topic being created. [...]
+| - | - | kafkaHandlerThreadPoolSize | Pool size of Kafka message handler executor. [...]
+| - | - | kafkaHandlerThreadPoolQueueSize | Queue size of Kafka message handler executor. [...]
+| - | - | topicNameOfMeters | Kafka topic name for meter system data. [...]
+| - | - | topicNameOfMetrics | Kafka topic name for JVM metrics data. [...]
+| - | - | topicNameOfProfiling | Kafka topic name for profiling data. [...]
+| - | - | topicNameOfTracingSegments | Kafka topic name for tracing data. [...]
+| - | - | topicNameOfManagements | Kafka topic name for service instance reporting and registration. [...]
+| - | - | topicNameOfLogs | Kafka topic name for native proto log data. [...]
+| - | - | topicNameOfJsonLogs | Kafka topic name for native json log data. [...]
+| receiver-browser | default | gRPC services that accept browser performance data and error log. | - [...]
+| - | - | sampleRate | Sampling rate for receiving trace. Precise to 1/10000. 10000 means sampling rate of 100% by default. [...]
+| query | graphql | - | GraphQL query implementation. [...]
+| - | - | enableLogTestTool | Enable the log testing API to test the LAL. **NOTE**: This API evaluates untrusted code on the OAP server. A malicious script can do significant damage (steal keys and secrets, remove files and directories, install malware, etc). As such, please enable this API only when you c [...]
+| - | - | maxQueryComplexity | Maximum complexity allowed for the GraphQL query that can be used to abort a query if the total number of data fields queried exceeds the defined threshold. [...]
+| - | - | enableUpdateUITemplate | Allow user add，disable and update UI template. [...]
+| - | - | enableOnDemandPodLog | Ondemand Pod log: fetch the Pod logs on users' demand, the logs are fetched and displayed in real time, and are not persisted in any kind. This is helpful when users want to do some experiments and monitor the logs and see what's happing inside the service. Note: if you print [...]
+| query-zipkin | default | - | This module is for Zipkin query API and support zipkin-lens UI [...]
+| - | - | restHost | Binding IP of RESTful services. [...]
+| - | - | restPort | Binding port of RESTful services. [...]
+| - | - | restContextPath | Web context path of RESTful services. [...]
+| - | - | restMaxThreads | Maximum thread number of RESTful services. [...]
+| - | - | restIdleTimeOut | Connector idle timeout of RESTful services (in milliseconds). [...]
+| - | - | restAcceptQueueSize | Maximum request header size accepted. [...]
+| - | - | lookback | Default look back for traces and autocompleteTags, 1 day in millis [...]
+| - | - | namesMaxAge | The Cache-Control max-age (seconds) for serviceNames, remoteServiceNames and spanNames [...]
+| - | - | uiQueryLimit | Default traces query max size [...]
+| - | - | uiDefaultLookback | Default look back on the UI for search traces, 15 minutes in millis [...]
+| promql | default | - | This module is for PromQL API. [...]
+| - | - | restHost | Binding IP of RESTful services. [...]
+| - | - | restPort | Binding port of RESTful services. [...]
+| - | - | restContextPath | Web context path of RESTful services. [...]
+| - | - | restMaxThreads | Maximum thread number of RESTful services. [...]
+| - | - | restIdleTimeOut | Connector idle timeout of RESTful services (in milliseconds). [...]
+| - | - | restAcceptQueueSize | Maximum request header size accepted. [...]
+| 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. [...]
+| - | - | port | Binding port for Prometheus server fetching data. [...]
+| configuration | - | - | Read [dynamic configuration doc](dynamic-config.md) for more details. [...]
+| - | grpc | host | DCS server binding hostname. [...]
+| - | - | port | DCS server binding port. [...]
+| - | - | clusterName | Cluster name when reading the latest configuration from DSC server. [...]
+| - | - | period | The period of reading data from DSC server by the OAP (in seconds). [...]
+| - | apollo | apolloMeta | `apollo.meta` in Apollo. [...]
+| - | - | apolloCluster | `apollo.cluster` in Apollo. [...]
+| - | - | apolloEnv | `env` in Apollo. [...]
+| - | - | appId | `app.id` in Apollo. [...]
+| - | - | period | The period of data sync (in seconds). [...]
+| - | zookeeper | namespace | The namespace (represented by root path) that isolates the configurations in the Zookeeper. [...]
+| - | - | hostPort | Hosts and ports of Zookeeper Cluster. [...]
+| - | - | baseSleepTimeMs | The period of Zookeeper client between two retries (in milliseconds). [...]
+| - | - | maxRetries | The maximum retry time. [...]
+| - | - | period | The period of data sync (in seconds). [...]
+| - | etcd | endpoints | Hosts and ports for etcd cluster (separated by commas if multiple). [...]
+| - | - | namespace | Namespace for SkyWalking cluster. [...]
+| - | - | authentication | Indicates whether there is authentication. [...]
+| - | - | user | Etcd auth username. [...]
+| - | - | password | Etcd auth password. [...]
+| - | - | period | The period of data sync (in seconds). [...]
+| - | consul | hostPort | Hosts and ports for Consul cluster. [...]
+| - | - | aclToken | ACL Token of Consul. Empty string means `without ACL token`. [...]
+| - | - | period | The period of data sync (in seconds). [...]
+| - | k8s-configmap | namespace | Deployment namespace of the config map. [...]
+| - | - | labelSelector | Labels for locating configmap. [...]
+| - | - | period | The period of data sync (in seconds). [...]
+| - | nacos | serverAddr | Nacos Server Host. [...]
+| - | - | port | Nacos Server Port. [...]
+| - | - | group | Nacos Configuration namespace. [...]
+| - | - | period | The period of data sync (in seconds). [...]
+| - | - | username | Nacos Auth username. [...]
+| - | - | password | Nacos Auth password. [...]
+| - | - | accessKey | Nacos Auth accessKey. [...]
+| - | - | secretKey | Nacos Auth secretKey. [...]
+| exporter | default | enableGRPCMetrics | Enable gRPC metrics exporter. [...]
+| - | - | gRPCTargetHost | The host of target gRPC server for receiving export data [...]
+| - | - | gRPCTargetPort | The port of target gRPC server for receiving export data. [...]
+| - | - | enableKafkaTrace | Enable Kafka trace exporter. [...]
+| - | - | enableKafkaLog | Enable Kafka log exporter. [...]
+| - | - | kafkaBootstrapServers | A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. [...]
+| - | - | kafkaProducerConfig | Kafka producer config, JSON format as Properties. [...]
+| - | - | kafkaTopicTrace | Kafka topic name for trace. [...]
+| - | - | kafkaTopicLog | Kafka topic name for log. [...]
+| health-checker | default | checkIntervalSeconds | The period of checking OAP internal health status (in seconds). [...]
+| 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. [...]
+| receiver-event | default | gRPC services that handle events data. | - [...]
+| aws-firehose-receiver | default | host | Binding IP of HTTP server [...]
+| - | - | port | Binding port of HTTP server [...]
+| - | - | contextPath | Context path of HTTP server [...]
+| - | - | maxThreads | Max Thtread number of HTTP server [...]
+| - | - | idleTimeOut | Idle timeout of a connection for keep-alive. [...]
+| - | - | acceptQueueSize | Maximum allowed number of open connections [...]
+| - | - | maxRequestHeaderSize | Maximum length of all headers in an HTTP/1 response [...]
+| - | - | firehoseAccessKey | The AccessKey of AWS firhose [...]
+| - | - | enableTLS | Indicate if enable HTTPS for the server [...]
+| - | - | tlsKeyPath | TLS key path [...]
+| - | - | tlsCertChainPath | TLS certificate chain path [...]
## Note
diff --git a/docs/en/setup/backend/opentelemetry-receiver.md b/docs/en/setup/backend/opentelemetry-receiver.md
index fced5fbb6d..f84089acc1 100644
--- a/docs/en/setup/backend/opentelemetry-receiver.md
+++ b/docs/en/setup/backend/opentelemetry-receiver.md
@@ -5,7 +5,6 @@ If the new configuration is not well-formed, the OAP may fail to start up. The f
Supported handlers:
-* `oc`: [OpenCensus](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/a08903f05d3a544f548535c222b1c205b9f5a154/exporter/opencensusexporter/README.md) gRPC service handler.
* `otlp`: [OpenTelemetry](https://github.com/open-telemetry/opentelemetry-collector/tree/1c217b366fbdb209044d8f4c3fece079ae23bd3b/exporter/otlpexporter) gRPC service handler.
**Notice:** Set `SW_OTEL_RECEIVER=default` through system environment or change `receiver-otel/selector=${SW_OTEL_RECEIVER:default}` to activate the OpenTelemetry receiver.
@@ -13,37 +12,35 @@ Supported handlers:
The rule file should be in YAML format, defined by the scheme described in [MAL](../../concepts-and-designs/mal.md).
Note: `receiver-otel` only supports the `group`, `defaultMetricLevel`, and `metricsRules` nodes of the scheme due to its push mode.
-To activate the `oc` handler and relevant rules of `istio`:
+To activate the `otlp` handler and relevant rules of `istio`:
```yaml
receiver-otel:
- // Change selector value to default, for activating the otel receiver.
selector: ${SW_OTEL_RECEIVER:default}
default:
- enabledHandlers: ${SW_OTEL_RECEIVER_ENABLED_HANDLERS:"oc,otlp"}
+ enabledHandlers: ${SW_OTEL_RECEIVER_ENABLED_HANDLERS:"otlp"}
enabledOtelRules: ${SW_OTEL_RECEIVER_ENABLED_OTEL_RULES:"istio-controlplane"}
```
The receiver adds label with key `node_identifier_host_name` to the collected data samples,
-and its value is from `Node.identifier.host_name` defined in OpenCensus Agent Proto,
-or `net.host.name` (or `host.name` for some OTLP versions) resource attributes defined in OpenTelemetry proto,
+and its value is from `net.host.name` (or `host.name` for some OTLP versions) resource attributes defined in OpenTelemetry proto,
for identification of the metric data.
| Description | Configuration File | Data Source |
|-----------------------------------------|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
-| Metrics of Istio Control Plane | otel-rules/istio-controlplane.yaml | Istio Control Plane -> OpenTelemetry Collector -- OC/OTLP exporter --> SkyWalking OAP Server |
-| Metrics of SkyWalking OAP server itself | otel-rules/oap.yaml | SkyWalking OAP Server(SelfObservability) -> OpenTelemetry Collector -- OC/OTLP exporter --> SkyWalking OAP Server |
-| Metrics of VMs | otel-rules/vm.yaml | Prometheus node-exporter(VMs) -> OpenTelemetry Collector -- OC/OTLP exporter --> SkyWalking OAP Server |
-| Metrics of K8s cluster | otel-rules/k8s/k8s-cluster.yaml | K8s kube-state-metrics -> OpenTelemetry Collector -- OC/OTLP exporter --> SkyWalking OAP Server |
-| Metrics of K8s cluster | otel-rules/k8s/k8s-node.yaml | cAdvisor & K8s kube-state-metrics -> OpenTelemetry Collector -- OC/OTLP exporter --> SkyWalking OAP Server |
-| Metrics of K8s cluster | otel-rules/k8s/k8s-service.yaml | cAdvisor & K8s kube-state-metrics -> OpenTelemetry Collector -- OC/OTLP exporter --> SkyWalking OAP Server |
-| Metrics of MYSQL | otel-rules/mysql/mysql-instance.yaml | prometheus/mysqld_exporter -> OpenTelemetry Collector -- OC/OTLP exporter --> SkyWalking OAP Server |
-| Metrics of MYSQL | otel-rules/mysql/mysql-service.yaml | prometheus/mysqld_exporter -> OpenTelemetry Collector -- OC/OTLP exporter --> SkyWalking OAP Server |
-| Metrics of PostgreSQL | otel-rules/postgresql/postgresql-instance.yaml | postgres_exporter -> OpenTelemetry Collector -- OC/OTLP exporter --> SkyWalking OAP Server |
-| Metrics of PostgreSQL | otel-rules/postgresql/postgresql-service.yaml | postgres_exporter -> OpenTelemetry Collector -- OC/OTLP exporter --> SkyWalking OAP Server |
-| Metrics of Apache APISIX | otel-rules/apisix.yaml | apisix prometheus plugin -> OpenTelemetry Collector -- OC/OTLP exporter --> SkyWalking OAP Server |
-| Metrics of AWS Cloud EKS | otel-rules/aws-eks/eks-cluster.yaml | AWS Container Insights Receiver -> OpenTelemetry Collector -- OC/OTLP exporter --> SkyWalking OAP Server |
-| Metrics of AWS Cloud EKS | otel-rules/aws-eks/eks-service.yaml | AWS Container Insights Receiver -> OpenTelemetry Collector -- OC/OTLP exporter --> SkyWalking OAP Server |
-| Metrics of AWS Cloud EKS | otel-rules/aws-eks/eks-node.yaml | AWS Container Insights Receiver -> OpenTelemetry Collector -- OC/OTLP exporter --> SkyWalking OAP Server |
+| Metrics of Istio Control Plane | otel-rules/istio-controlplane.yaml | Istio Control Plane -> OpenTelemetry Collector -- OTLP exporter --> SkyWalking OAP Server |
+| Metrics of SkyWalking OAP server itself | otel-rules/oap.yaml | SkyWalking OAP Server(SelfObservability) -> OpenTelemetry Collector -- OTLP exporter --> SkyWalking OAP Server |
+| Metrics of VMs | otel-rules/vm.yaml | Prometheus node-exporter(VMs) -> OpenTelemetry Collector -- OTLP exporter --> SkyWalking OAP Server |
+| Metrics of K8s cluster | otel-rules/k8s/k8s-cluster.yaml | K8s kube-state-metrics -> OpenTelemetry Collector -- OTLP exporter --> SkyWalking OAP Server |
+| Metrics of K8s cluster | otel-rules/k8s/k8s-node.yaml | cAdvisor & K8s kube-state-metrics -> OpenTelemetry Collector -- OTLP exporter --> SkyWalking OAP Server |
+| Metrics of K8s cluster | otel-rules/k8s/k8s-service.yaml | cAdvisor & K8s kube-state-metrics -> OpenTelemetry Collector -- OTLP exporter --> SkyWalking OAP Server |
+| Metrics of MYSQL | otel-rules/mysql/mysql-instance.yaml | prometheus/mysqld_exporter -> OpenTelemetry Collector -- OTLP exporter --> SkyWalking OAP Server |
+| Metrics of MYSQL | otel-rules/mysql/mysql-service.yaml | prometheus/mysqld_exporter -> OpenTelemetry Collector -- OTLP exporter --> SkyWalking OAP Server |
+| Metrics of PostgreSQL | otel-rules/postgresql/postgresql-instance.yaml | postgres_exporter -> OpenTelemetry Collector -- OTLP exporter --> SkyWalking OAP Server |
+| Metrics of PostgreSQL | otel-rules/postgresql/postgresql-service.yaml | postgres_exporter -> OpenTelemetry Collector -- OTLP exporter --> SkyWalking OAP Server |
+| Metrics of Apache APISIX | otel-rules/apisix.yaml | apisix prometheus plugin -> OpenTelemetry Collector -- OTLP exporter --> SkyWalking OAP Server |
+| Metrics of AWS Cloud EKS | otel-rules/aws-eks/eks-cluster.yaml | AWS Container Insights Receiver -> OpenTelemetry Collector -- OTLP exporter --> SkyWalking OAP Server |
+| Metrics of AWS Cloud EKS | otel-rules/aws-eks/eks-service.yaml | AWS Container Insights Receiver -> OpenTelemetry Collector -- OTLP exporter --> SkyWalking OAP Server |
+| Metrics of AWS Cloud EKS | otel-rules/aws-eks/eks-node.yaml | AWS Container Insights Receiver -> OpenTelemetry Collector -- OTLP exporter --> SkyWalking OAP Server |
**Note**: You can also use OpenTelemetry exporter to transport the metrics to SkyWalking OAP directly. See [OpenTelemetry Exporter](./backend-meter.md#opentelemetry-exporter).
diff --git a/docs/en/setup/istio/README.md b/docs/en/setup/istio/README.md
index faa70807c7..e198f96e6b 100644
--- a/docs/en/setup/istio/README.md
+++ b/docs/en/setup/istio/README.md
@@ -6,56 +6,54 @@ This document provides instructions on transporting Istio's metrics to the SkyWa
Istio should be installed in a Kubernetes cluster. Simply follow the steps in [Getting Started in Istio](https://istio.io/docs/setup/getting-started/).
-## Deploying SkyWalking backend
+## Deploy SkyWalking backend
Follow the steps in [deploying backend in Kubernetes](../backend/backend-k8s.md) to install the OAP server in the Kubernetes cluster.
Refer to [OpenTelemetry receiver](../backend/opentelemetry-receiver.md) to ingest metrics.
-`otel-receiver` is disabled by default. Set env var `SW_OTEL_RECEIVER` to `default` to enable it.
-## Deploying OpenTelemetry Collector
+## Deploy OpenTelemetry Collector
OpenTelemetry Collector is the location where Istio telemetry sends metrics, which are then processed and shipped to SkyWalking
backend.
-To deploy this collector, follow the steps in [Getting Started in OpenTelemetry Collector](https://opentelemetry.io/docs/collector/getting-started/). Several components are available in the collector, and they could be combined for different use cases.
-
-For the sake of brevity, we use the Prometheus receiver to retrieve metrics from Istio control and data plane, then send them to SkyWalking by OpenCensus exporter.
-
-#### Prometheus Receiver
-Refer to [Prometheus Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/150692dbbceb3ff0df75c912e835f1feaac0be93/receiver/prometheusreceiver/README.md)
- to set up this receiver. You could find more configuration details in [Prometheus Integration of Istio](https://istio.io/latest/docs/ops/integrations/prometheus/#configuration)
- to figure out how to direct Prometheus Receiver to query Istio metrics.
-
-SkyWalking supports receiving multi-cluster metrics in a single OAP cluster. A `cluster` label should be appended to every metric
-fetched by this receiver even if there's only a single cluster needed to be collected.
-You could use `relabel` to add it, like this:
-
-```
-relabel_configs:
-- source_labels: []
- target_label: cluster
- replacement: <cluster name>
-```
-
-or you can do so through [Resource Processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/a08903f05d3a544f548535c222b1c205b9f5a154/processor/resourceprocessor/README.md):
-
-```
-processors:
- resource:
- attributes:
- - key: cluster
- value: "<cluster name>"
- action: upsert
+To deploy this collector, follow the steps in [Getting Started in OpenTelemetry Collector](https://opentelemetry.io/docs/collector/getting-started/).
+Several components are available in the collector, and they could be combined for different use cases.
+
+After installing the collector, you may configure it to scrape metrics from Istio and send them to SkyWalking backend.
+
+The job configuration to scrape metrics from Istio and send them to SkyWalking backend is as follows:
+
+```yaml
+receivers:
+ prometheus:
+ config:
+ scrape_configs:
+ - job_name: 'istiod-monitor'
+ kubernetes_sd_configs:
+ - role: endpoints
+ relabel_configs:
+ - source_labels: [ __meta_kubernetes_service_name, __meta_kubernetes_endpoint_port_name ]
+ action: keep
+ regex: istiod;http-monitoring
+ - action: labelmap
+ regex: __meta_kubernetes_service_label_(.+)
+ - source_labels: [ ]
+ target_label: cluster
+ replacement: your-cluster # replace this with your cluster name
+
+exporters:
+ otlp:
+ endpoint: oap.skywalking:11800 # replace this with the OAP gRPC service address
+ tls:
+ insecure: true
+
+service:
+ pipelines:
+ metrics:
+ receivers: [ prometheus ]
+ exporters: [ otlp,logging ]
```
-Note: If you try the sample Istio Prometheus Kubernetes configuration,
-you may experience [an issue](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/4980).
-Try to fix it using the solution described in the issue.
-
-#### OpenCensus exporter
-Follow [OpenCensus exporter configuration](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/a08903f05d3a544f548535c222b1c205b9f5a154/exporter/opencensusexporter/README.md)
-to set up a connection between OpenTelemetry Collector and OAP cluster. `endpoint` is the address of the OAP gRPC service.
-
## Observing Istio
Open Istio Dashboard in SkyWaling UI by clicking `Dashboard` -> `Istio`. You can then view charts and diagrams
diff --git a/oap-server/server-receiver-plugin/otel-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/otel/OtelMetricReceiverProvider.java b/oap-server/server-receiver-plugin/otel-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/otel/OtelMetricReceiverProvider.java
index beca26699b..e3fecb867b 100644
--- a/oap-server/server-receiver-plugin/otel-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/otel/OtelMetricReceiverProvider.java
+++ b/oap-server/server-receiver-plugin/otel-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/otel/OtelMetricReceiverProvider.java
@@ -18,17 +18,17 @@
package org.apache.skywalking.oap.server.receiver.otel;
-import java.util.ArrayList;
-import java.util.List;
import org.apache.skywalking.oap.server.library.module.ModuleDefine;
import org.apache.skywalking.oap.server.library.module.ModuleProvider;
import org.apache.skywalking.oap.server.library.module.ModuleStartException;
import org.apache.skywalking.oap.server.library.module.ServiceNotProvidedException;
-import org.apache.skywalking.oap.server.receiver.otel.oc.OCMetricHandler;
import org.apache.skywalking.oap.server.receiver.otel.otlp.OpenTelemetryMetricHandler;
import org.apache.skywalking.oap.server.receiver.otel.otlp.OpenTelemetryMetricRequestProcessor;
import org.apache.skywalking.oap.server.receiver.sharing.server.SharingServerModule;
+import java.util.ArrayList;
+import java.util.List;
+
public class OtelMetricReceiverProvider extends ModuleProvider {
public static final String NAME = "default";
@@ -75,10 +75,6 @@ public class OtelMetricReceiverProvider extends ModuleProvider {
if (enabledHandlers.contains(openTelemetryMetricHandler.type())) {
handlers.add(openTelemetryMetricHandler);
}
- final OCMetricHandler ocMetricHandler = new OCMetricHandler(getManager(), config);
- if (enabledHandlers.contains(ocMetricHandler.type())) {
- handlers.add(ocMetricHandler);
- }
this.handlers = handlers;
}
diff --git a/oap-server/server-receiver-plugin/otel-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/otel/oc/OCMetricHandler.java b/oap-server/server-receiver-plugin/otel-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/otel/oc/OCMetricHandler.java
deleted file mode 100644
index b8c4baf9aa..0000000000
--- a/oap-server/server-receiver-plugin/otel-receiver-plugin/src/main/java/org/apache/skywalking/oap/server/receiver/otel/oc/OCMetricHandler.java
+++ /dev/null
@@ -1,209 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- */
-
-package org.apache.skywalking.oap.server.receiver.otel.oc;
-
-import com.google.common.base.Splitter;
-import com.google.common.base.Strings;
-import com.google.protobuf.Timestamp;
-import io.grpc.stub.StreamObserver;
-import io.opencensus.proto.agent.common.v1.Node;
-import io.opencensus.proto.agent.metrics.v1.ExportMetricsServiceRequest;
-import io.opencensus.proto.agent.metrics.v1.ExportMetricsServiceResponse;
-import io.opencensus.proto.agent.metrics.v1.MetricsServiceGrpc;
-import io.opencensus.proto.metrics.v1.DistributionValue;
-import io.opencensus.proto.metrics.v1.LabelKey;
-import io.opencensus.proto.metrics.v1.LabelValue;
-import io.opencensus.proto.metrics.v1.SummaryValue;
-import io.opencensus.proto.resource.v1.Resource;
-import io.vavr.Function1;
-import io.vavr.Tuple;
-import java.io.IOException;
-import java.time.Instant;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import lombok.RequiredArgsConstructor;
-import org.apache.skywalking.oap.meter.analyzer.MetricConvert;
-import org.apache.skywalking.oap.meter.analyzer.prometheus.PrometheusMetricConverter;
-import org.apache.skywalking.oap.meter.analyzer.prometheus.rule.Rule;
-import org.apache.skywalking.oap.meter.analyzer.prometheus.rule.Rules;
-import org.apache.skywalking.oap.server.core.CoreModule;
-import org.apache.skywalking.oap.server.core.analysis.meter.MeterSystem;
-import org.apache.skywalking.oap.server.core.server.GRPCHandlerRegister;
-import org.apache.skywalking.oap.server.library.module.ModuleManager;
-import org.apache.skywalking.oap.server.library.module.ModuleStartException;
-import org.apache.skywalking.oap.server.library.util.StringUtil;
-import org.apache.skywalking.oap.server.library.util.prometheus.metrics.Counter;
-import org.apache.skywalking.oap.server.library.util.prometheus.metrics.Gauge;
-import org.apache.skywalking.oap.server.library.util.prometheus.metrics.Histogram;
-import org.apache.skywalking.oap.server.library.util.prometheus.metrics.Summary;
-import org.apache.skywalking.oap.server.receiver.otel.Handler;
-import org.apache.skywalking.oap.server.receiver.otel.OtelMetricReceiverConfig;
-import org.apache.skywalking.oap.server.receiver.sharing.server.SharingServerModule;
-
-import static java.util.stream.Collectors.toList;
-
-@RequiredArgsConstructor
-public class OCMetricHandler extends MetricsServiceGrpc.MetricsServiceImplBase implements Handler {
- private static final String HOST_NAME_LABEL = "node_identifier_host_name";
- private List<PrometheusMetricConverter> converters;
-
- private final ModuleManager manager;
-
- private final OtelMetricReceiverConfig config;
-
- @Override public StreamObserver<ExportMetricsServiceRequest> export(
- StreamObserver<ExportMetricsServiceResponse> responseObserver) {
- return new StreamObserver<ExportMetricsServiceRequest>() {
- private Node node;
- private Map<String, String> nodeLabels = new HashMap<>();
- private Resource resource;
-
- @Override
- public void onNext(ExportMetricsServiceRequest request) {
- if (request.hasNode()) {
- node = request.getNode();
- nodeLabels.clear();
- if (node.hasIdentifier()) {
- if (StringUtil.isNotBlank(node.getIdentifier().getHostName())) {
- nodeLabels.put(HOST_NAME_LABEL, node.getIdentifier().getHostName());
- }
- }
- final String name = node.getServiceInfo().getName();
- if (!Strings.isNullOrEmpty(name)) {
- nodeLabels.put("job_name", name);
- }
- }
- //new version of the OTEL moved the host name to the `Resources`
- if (request.hasResource() && StringUtil.isBlank(nodeLabels.get(HOST_NAME_LABEL))) {
- resource = request.getResource();
- if (StringUtil.isNotBlank(resource.getLabelsMap().get("net.host.name"))) {
- nodeLabels.put(HOST_NAME_LABEL, resource.getLabelsMap().get("net.host.name"));
- }
- }
- converters.forEach(m -> m.toMeter(request.getMetricsList().stream()
- .flatMap(metric -> metric.getTimeseriesList().stream().map(timeSeries ->
- Tuple.of(metric.getMetricDescriptor(),
- buildLabelsFromNodeInfo(
- nodeLabels, buildLabels(
- metric.getMetricDescriptor().getLabelKeysList(),
- timeSeries.getLabelValuesList()
- )
- ),
- timeSeries)))
- .flatMap(t -> t._3.getPointsList().stream().map(point -> Tuple.of(t._1, t._2, point)))
- .map(Function1.liftTry(t -> {
- switch (t._1.getType()) {
- case GAUGE_INT64:
- return new Gauge(t._1.getName(), t._2, t._3.getInt64Value(), tsToMilli(t._3.getTimestamp()));
- case GAUGE_DOUBLE:
- return new Gauge(t._1.getName(), t._2, t._3.getDoubleValue(), tsToMilli(t._3.getTimestamp()));
- case CUMULATIVE_INT64:
- return new Counter(t._1.getName(), t._2, t._3.getInt64Value(), tsToMilli(t._3.getTimestamp()));
- case CUMULATIVE_DOUBLE:
- return new Counter(t._1.getName(), t._2, t._3.getDoubleValue(), tsToMilli(t._3.getTimestamp()));
- case CUMULATIVE_DISTRIBUTION:
- return new Histogram(t._1.getName(), t._2, t._3.getDistributionValue().getCount(),
- t._3.getDistributionValue().getSum(),
- buildBuckets(t._3.getDistributionValue()), tsToMilli(t._3.getTimestamp()));
- case SUMMARY:
- return new Summary(t._1.getName(), t._2, t._3.getSummaryValue().getCount().getValue(),
- t._3.getSummaryValue().getSum().getValue(),
- buildQuantiles(t._3.getSummaryValue().getSnapshot()), tsToMilli(t._3.getTimestamp()));
- default:
- throw new UnsupportedOperationException("Unsupported OC type:" + t._1.getType());
- }
- }))
- .flatMap(tryIt -> MetricConvert.log(tryIt, "Convert OC metric to prometheus metric"))));
- }
-
- @Override public void onError(Throwable throwable) {
-
- }
-
- @Override public void onCompleted() {
- responseObserver.onCompleted();
- }
- };
- }
-
- private static Map<String, String> buildLabels(List<LabelKey> keys, List<LabelValue> values) {
- Map<String, String> result = new HashMap<>();
- for (int i = 0; i < keys.size(); i++) {
- result.put(keys.get(i).getKey(), values.get(i).getValue());
- }
- return result;
- }
-
- private static Map<String, String> buildLabelsFromNodeInfo(Map<String, String> nodeLabels,
- Map<String, String> buildLabelsResult) {
- buildLabelsResult.putAll(nodeLabels);
- return buildLabelsResult;
- }
-
- private static Map<Double, Long> buildBuckets(DistributionValue distributionValue) {
- Map<Double, Long> result = new HashMap<>();
- List<Double> bounds = distributionValue.getBucketOptions().getExplicit().getBoundsList();
- for (int i = 0; i < bounds.size(); i++) {
- result.put(bounds.get(i), distributionValue.getBuckets(i).getCount());
- }
- result.put(Double.POSITIVE_INFINITY, distributionValue.getBuckets(bounds.size()).getCount());
- return result;
- }
-
- private static Map<Double, Double> buildQuantiles(SummaryValue.Snapshot snapshot) {
- Map<Double, Double> result = new HashMap<>();
- snapshot.getPercentileValuesList().forEach(p -> result.put(p.getPercentile(), p.getValue()));
- return result;
- }
-
- private static long tsToMilli(Timestamp timestamp) {
- return timestamp.equals(Timestamp.getDefaultInstance()) ? System.currentTimeMillis() :
- Instant.ofEpochSecond(timestamp.getSeconds(), timestamp.getNanos()).toEpochMilli();
- }
-
- @Override public String type() {
- return "oc";
- }
-
- @Override
- public void active()
- throws ModuleStartException {
- final List<String> enabledRules =
- Splitter.on(",")
- .omitEmptyStrings()
- .splitToList(config.getEnabledOtelRules());
- final List<Rule> rules;
- try {
- rules = Rules.loadRules("otel-rules", enabledRules);
- } catch (IOException e) {
- throw new ModuleStartException("Failed to load otel rules.", e);
- }
- if (rules.isEmpty()) {
- return;
- }
- GRPCHandlerRegister grpcHandlerRegister = manager.find(SharingServerModule.NAME)
- .provider()
- .getService(GRPCHandlerRegister.class);
- final MeterSystem meterSystem = manager.find(CoreModule.NAME).provider().getService(MeterSystem.class);
- this.converters = rules.stream().map(r -> new PrometheusMetricConverter(r, meterSystem))
- .collect(toList());
- grpcHandlerRegister.addHandler(this);
- }
-}
diff --git a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/agent/common/v1/common.proto b/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/agent/common/v1/common.proto
deleted file mode 100644
index 0a16a5f36c..0000000000
--- a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/agent/common/v1/common.proto
+++ /dev/null
@@ -1,99 +0,0 @@
-// Copyright 2018, OpenCensus Authors
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-syntax = "proto3";
-
-// NOTE: This proto is experimental and is subject to change at this point.
-// Please do not use it at the moment.
-
-package opencensus.proto.agent.common.v1;
-
-import "google/protobuf/timestamp.proto";
-
-option java_multiple_files = true;
-option java_package = "io.opencensus.proto.agent.common.v1";
-option java_outer_classname = "CommonProto";
-
-option go_package = "github.com/census-instrumentation/opencensus-proto/gen-go/agent/common/v1";
-
-// Identifier metadata of the Node that produces the span or tracing data.
-// Note, this is not the metadata about the Node or service that is described by associated spans.
-// In the future we plan to extend the identifier proto definition to support
-// additional information (e.g cloud id, etc.)
-message Node {
- // Identifier that uniquely identifies a process within a VM/container.
- ProcessIdentifier identifier = 1;
-
- // Information on the OpenCensus Library that initiates the stream.
- LibraryInfo library_info = 2;
-
- // Additional information on service.
- ServiceInfo service_info = 3;
-
- // Additional attributes.
- map<string, string> attributes = 4;
-
- // TODO(songya): Add more identifiers in the future as needed, like cloud
- // identifiers.
-}
-
-// Identifier that uniquely identifies a process within a VM/container.
-message ProcessIdentifier {
-
- // The host name. Usually refers to the machine/container name.
- // For example: os.Hostname() in Go, socket.gethostname() in Python.
- string host_name = 1;
-
- // Process id.
- uint32 pid = 2;
-
- // Start time of this ProcessIdentifier. Represented in epoch time.
- google.protobuf.Timestamp start_timestamp = 3;
-}
-
-// Information on OpenCensus Library.
-message LibraryInfo {
-
- enum Language {
- LANGUAGE_UNSPECIFIED = 0;
- CPP = 1;
- C_SHARP = 2;
- ERLANG = 3;
- GO_LANG = 4;
- JAVA = 5;
- NODE_JS = 6;
- PHP = 7;
- PYTHON = 8;
- RUBY = 9;
- WEB_JS = 10;
- }
-
- // Language of OpenCensus Library.
- Language language = 1;
-
- // Version of Agent exporter of Library.
- string exporter_version = 2;
-
- // Version of OpenCensus Library.
- string core_library_version = 3;
-}
-
-// Additional service information.
-message ServiceInfo {
-
- // Name of the service.
- string name = 1;
-
- // TODO(songya): add more fields as needed.
-}
diff --git a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/agent/metrics/v1/metrics_service.proto b/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/agent/metrics/v1/metrics_service.proto
deleted file mode 100644
index f2aac28c0a..0000000000
--- a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/agent/metrics/v1/metrics_service.proto
+++ /dev/null
@@ -1,56 +0,0 @@
-// Copyright 2018, OpenCensus Authors
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-syntax = "proto3";
-
-package opencensus.proto.agent.metrics.v1;
-
-import "opencensus/proto/agent/common/v1/common.proto";
-import "opencensus/proto/metrics/v1/metrics.proto";
-import "opencensus/proto/resource/v1/resource.proto";
-
-option java_multiple_files = true;
-option java_package = "io.opencensus.proto.agent.metrics.v1";
-option java_outer_classname = "MetricsServiceProto";
-
-option go_package = "github.com/census-instrumentation/opencensus-proto/gen-go/agent/metrics/v1";
-
-// Service that can be used to push metrics between one Application
-// instrumented with OpenCensus and an agent, or between an agent and a
-// central collector.
-service MetricsService {
- // For performance reasons, it is recommended to keep this RPC
- // alive for the entire life of the application.
- rpc Export(stream ExportMetricsServiceRequest) returns (stream ExportMetricsServiceResponse) {}
-}
-
-message ExportMetricsServiceRequest {
- // This is required only in the first message on the stream or if the
- // previous sent ExportMetricsServiceRequest message has a different Node (e.g.
- // when the same RPC is used to send Metrics from multiple Applications).
- opencensus.proto.agent.common.v1.Node node = 1;
-
- // A list of metrics that belong to the last received Node.
- repeated opencensus.proto.metrics.v1.Metric metrics = 2;
-
- // The resource for the metrics in this message that do not have an explicit
- // resource set.
- // If unset, the most recently set resource in the RPC stream applies. It is
- // valid to never be set within a stream, e.g. when no resource info is known
- // at all or when all sent metrics have an explicit resource set.
- opencensus.proto.resource.v1.Resource resource = 3;
-}
-
-message ExportMetricsServiceResponse {
-}
diff --git a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/agent/trace/v1/trace_service.proto b/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/agent/trace/v1/trace_service.proto
deleted file mode 100644
index ed564ac5ce..0000000000
--- a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/agent/trace/v1/trace_service.proto
+++ /dev/null
@@ -1,85 +0,0 @@
-// Copyright 2018, OpenCensus Authors
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-syntax = "proto3";
-
-// NOTE: This proto is experimental and is subject to change at this point.
-// Please do not use it at the moment.
-
-package opencensus.proto.agent.trace.v1;
-
-import "opencensus/proto/agent/common/v1/common.proto";
-import "opencensus/proto/resource/v1/resource.proto";
-import "opencensus/proto/trace/v1/trace.proto";
-import "opencensus/proto/trace/v1/trace_config.proto";
-
-option java_multiple_files = true;
-option java_package = "io.opencensus.proto.agent.trace.v1";
-option java_outer_classname = "TraceServiceProto";
-
-option go_package = "github.com/census-instrumentation/opencensus-proto/gen-go/agent/trace/v1";
-
-// Service that can be used to push spans and configs between one Application
-// instrumented with OpenCensus and an agent, or between an agent and a
-// central collector or config service (in this case spans and configs are
-// sent/received to/from multiple Applications).
-service TraceService {
- // After initialization, this RPC must be kept alive for the entire life of
- // the application. The agent pushes configs down to applications via a
- // stream.
- rpc Config(stream CurrentLibraryConfig) returns (stream UpdatedLibraryConfig) {}
-
- // For performance reasons, it is recommended to keep this RPC
- // alive for the entire life of the application.
- rpc Export(stream ExportTraceServiceRequest) returns (stream ExportTraceServiceResponse) {}
-}
-
-message CurrentLibraryConfig {
- // This is required only in the first message on the stream or if the
- // previous sent CurrentLibraryConfig message has a different Node (e.g.
- // when the same RPC is used to configure multiple Applications).
- opencensus.proto.agent.common.v1.Node node = 1;
-
- // Current configuration.
- opencensus.proto.trace.v1.TraceConfig config = 2;
-}
-
-message UpdatedLibraryConfig {
- // This field is ignored when the RPC is used to configure only one Application.
- // This is required only in the first message on the stream or if the
- // previous sent UpdatedLibraryConfig message has a different Node.
- opencensus.proto.agent.common.v1.Node node = 1;
-
- // Requested updated configuration.
- opencensus.proto.trace.v1.TraceConfig config = 2;
-}
-
-message ExportTraceServiceRequest {
- // This is required only in the first message on the stream or if the
- // previous sent ExportTraceServiceRequest message has a different Node (e.g.
- // when the same RPC is used to send Spans from multiple Applications).
- opencensus.proto.agent.common.v1.Node node = 1;
-
- // A list of Spans that belong to the last received Node.
- repeated opencensus.proto.trace.v1.Span spans = 2;
-
- // The resource for the spans in this message that do not have an explicit
- // resource set.
- // If unset, the most recently set resource in the RPC stream applies. It is
- // valid to never be set within a stream, e.g. when no resource info is known.
- opencensus.proto.resource.v1.Resource resource = 3;
-}
-
-message ExportTraceServiceResponse {
-}
diff --git a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/metrics/v1/metrics.proto b/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/metrics/v1/metrics.proto
deleted file mode 100644
index 44ba0d3105..0000000000
--- a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/metrics/v1/metrics.proto
+++ /dev/null
@@ -1,301 +0,0 @@
-// Copyright 2018, OpenCensus Authors
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-// This package describes the Metrics data model. It is currently experimental
-// but may eventually become the wire format for metrics. Please see
-// https://github.com/census-instrumentation/opencensus-specs/blob/master/stats/Metrics.md
-// for more details.
-
-syntax = "proto3";
-
-package opencensus.proto.metrics.v1;
-
-import "google/protobuf/timestamp.proto";
-import "google/protobuf/wrappers.proto";
-import "opencensus/proto/resource/v1/resource.proto";
-
-option go_package = "github.com/census-instrumentation/opencensus-proto/gen-go/metrics/v1";
-
-option java_multiple_files = true;
-option java_package = "io.opencensus.proto.metrics.v1";
-option java_outer_classname = "MetricsProto";
-
-// Defines a Metric which has one or more timeseries.
-message Metric {
- // The descriptor of the Metric.
- // TODO(issue #152): consider only sending the name of descriptor for
- // optimization.
- MetricDescriptor metric_descriptor = 1;
-
- // One or more timeseries for a single metric, where each timeseries has
- // one or more points.
- repeated TimeSeries timeseries = 2;
-
- // The resource for the metric. If unset, it may be set to a default value
- // provided for a sequence of messages in an RPC stream.
- opencensus.proto.resource.v1.Resource resource = 3;
-}
-
-// Defines a metric type and its schema.
-message MetricDescriptor {
- // The metric type, including its DNS name prefix. It must be unique.
- string name = 1;
-
- // A detailed description of the metric, which can be used in documentation.
- string description = 2;
-
- // The unit in which the metric value is reported. Follows the format
- // described by http://unitsofmeasure.org/ucum.html.
- string unit = 3;
-
- // The kind of metric. It describes how the data is reported.
- //
- // A gauge is an instantaneous measurement of a value.
- //
- // A cumulative measurement is a value accumulated over a time interval. In
- // a time series, cumulative measurements should have the same start time,
- // increasing values and increasing end times, until an event resets the
- // cumulative value to zero and sets a new start time for the following
- // points.
- enum Type {
- // Do not use this default value.
- UNSPECIFIED = 0;
-
- // Integer gauge. The value can go both up and down.
- GAUGE_INT64 = 1;
-
- // Floating point gauge. The value can go both up and down.
- GAUGE_DOUBLE = 2;
-
- // Distribution gauge measurement. The count and sum can go both up and
- // down. Recorded values are always >= 0.
- // Used in scenarios like a snapshot of time the current items in a queue
- // have spent there.
- GAUGE_DISTRIBUTION = 3;
-
- // Integer cumulative measurement. The value cannot decrease, if resets
- // then the start_time should also be reset.
- CUMULATIVE_INT64 = 4;
-
- // Floating point cumulative measurement. The value cannot decrease, if
- // resets then the start_time should also be reset. Recorded values are
- // always >= 0.
- CUMULATIVE_DOUBLE = 5;
-
- // Distribution cumulative measurement. The count and sum cannot decrease,
- // if resets then the start_time should also be reset.
- CUMULATIVE_DISTRIBUTION = 6;
-
- // Some frameworks implemented Histograms as a summary of observations
- // (usually things like request durations and response sizes). While it
- // also provides a total count of observations and a sum of all observed
- // values, it calculates configurable percentiles over a sliding time
- // window. This is not recommended, since it cannot be aggregated.
- SUMMARY = 7;
- }
- Type type = 4;
-
- // The label keys associated with the metric descriptor.
- repeated LabelKey label_keys = 5;
-}
-
-// Defines a label key associated with a metric descriptor.
-message LabelKey {
- // The key for the label.
- string key = 1;
-
- // A human-readable description of what this label key represents.
- string description = 2;
-}
-
-// A collection of data points that describes the time-varying values
-// of a metric.
-message TimeSeries {
- // Must be present for cumulative metrics. The time when the cumulative value
- // was reset to zero. Exclusive. The cumulative value is over the time interval
- // (start_timestamp, timestamp]. If not specified, the backend can use the
- // previous recorded value.
- google.protobuf.Timestamp start_timestamp = 1;
-
- // The set of label values that uniquely identify this timeseries. Applies to
- // all points. The order of label values must match that of label keys in the
- // metric descriptor.
- repeated LabelValue label_values = 2;
-
- // The data points of this timeseries. Point.value type MUST match the
- // MetricDescriptor.type.
- repeated Point points = 3;
-}
-
-message LabelValue {
- // The value for the label.
- string value = 1;
- // If false the value field is ignored and considered not set.
- // This is used to differentiate a missing label from an empty string.
- bool has_value = 2;
-}
-
-// A timestamped measurement.
-message Point {
- // The moment when this point was recorded. Inclusive.
- // If not specified, the timestamp will be decided by the backend.
- google.protobuf.Timestamp timestamp = 1;
-
- // The actual point value.
- oneof value {
- // A 64-bit integer.
- int64 int64_value = 2;
-
- // A 64-bit double-precision floating-point number.
- double double_value = 3;
-
- // A distribution value.
- DistributionValue distribution_value = 4;
-
- // A summary value. This is not recommended, since it cannot be aggregated.
- SummaryValue summary_value = 5;
- }
-}
-
-// Distribution contains summary statistics for a population of values. It
-// optionally contains a histogram representing the distribution of those
-// values across a set of buckets.
-message DistributionValue {
- // The number of values in the population. Must be non-negative. This value
- // must equal the sum of the values in bucket_counts if a histogram is
- // provided.
- int64 count = 1;
-
- // The sum of the values in the population. If count is zero then this field
- // must be zero.
- double sum = 2;
-
- // The sum of squared deviations from the mean of the values in the
- // population. For values x_i this is:
- //
- // Sum[i=1..n]((x_i - mean)^2)
- //
- // Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
- // describes Welford's method for accumulating this sum in one pass.
- //
- // If count is zero then this field must be zero.
- double sum_of_squared_deviation = 3;
-
- // A Distribution may optionally contain a histogram of the values in the
- // population. The bucket boundaries for that histogram are described by
- // BucketOptions.
- //
- // If bucket_options has no type, then there is no histogram associated with
- // the Distribution.
- message BucketOptions {
- oneof type {
- // Bucket with explicit bounds.
- Explicit explicit = 1;
- }
-
- // Specifies a set of buckets with arbitrary upper-bounds.
- // This defines size(bounds) + 1 (= N) buckets. The boundaries for bucket
- // index i are:
- //
- // [0, bucket_bounds[i]) for i == 0
- // [bucket_bounds[i-1], bucket_bounds[i]) for 0 < i < N-1
- // [bucket_bounds[i], +infinity) for i == N-1
- message Explicit {
- // The values must be strictly increasing and > 0.
- repeated double bounds = 1;
- }
-
- // TODO: If OpenMetrics decides to support (a, b] intervals we should add
- // support for these by defining a boolean value here which decides what
- // type of intervals to use.
- }
-
- // Don't change bucket boundaries within a TimeSeries if your backend doesn't
- // support this.
- // TODO(issue #152): consider not required to send bucket options for
- // optimization.
- BucketOptions bucket_options = 4;
-
- message Bucket {
- // The number of values in each bucket of the histogram, as described in
- // bucket_bounds.
- int64 count = 1;
-
- // If the distribution does not have a histogram, then omit this field.
- Exemplar exemplar = 2;
- }
-
- // If the distribution does not have a histogram, then omit this field.
- // If there is a histogram, then the sum of the values in the Bucket counts
- // must equal the value in the count field of the distribution.
- repeated Bucket buckets = 5;
-
- // Exemplars are example points that may be used to annotate aggregated
- // Distribution values. They are metadata that gives information about a
- // particular value added to a Distribution bucket.
- message Exemplar {
- // Value of the exemplar point. It determines which bucket the exemplar
- // belongs to.
- double value = 1;
-
- // The observation (sampling) time of the above value.
- google.protobuf.Timestamp timestamp = 2;
-
- // Contextual information about the example value.
- map<string, string> attachments = 3;
- }
-}
-
-// The start_timestamp only applies to the count and sum in the SummaryValue.
-message SummaryValue {
- // The total number of recorded values since start_time. Optional since
- // some systems don't expose this.
- google.protobuf.Int64Value count = 1;
-
- // The total sum of recorded values since start_time. Optional since some
- // systems don't expose this. If count is zero then this field must be zero.
- // This field must be unset if the sum is not available.
- google.protobuf.DoubleValue sum = 2;
-
- // The values in this message can be reset at arbitrary unknown times, with
- // the requirement that all of them are reset at the same time.
- message Snapshot {
- // The number of values in the snapshot. Optional since some systems don't
- // expose this.
- google.protobuf.Int64Value count = 1;
-
- // The sum of values in the snapshot. Optional since some systems don't
- // expose this. If count is zero then this field must be zero or not set
- // (if not supported).
- google.protobuf.DoubleValue sum = 2;
-
- // Represents the value at a given percentile of a distribution.
- message ValueAtPercentile {
- // The percentile of a distribution. Must be in the interval
- // (0.0, 100.0].
- double percentile = 1;
-
- // The value at the given percentile of a distribution.
- double value = 2;
- }
-
- // A list of values at different percentiles of the distribution calculated
- // from the current snapshot. The percentiles must be strictly increasing.
- repeated ValueAtPercentile percentile_values = 3;
- }
-
- // Values calculated over an arbitrary time window.
- Snapshot snapshot = 3;
-}
-
diff --git a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/resource/v1/resource.proto b/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/resource/v1/resource.proto
deleted file mode 100644
index 61e5983dfa..0000000000
--- a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/resource/v1/resource.proto
+++ /dev/null
@@ -1,33 +0,0 @@
-// Copyright 2018, OpenCensus Authors
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-syntax = "proto3";
-
-package opencensus.proto.resource.v1;
-
-option go_package = "github.com/census-instrumentation/opencensus-proto/gen-go/resource/v1";
-
-option java_multiple_files = true;
-option java_package = "io.opencensus.proto.resource.v1";
-option java_outer_classname = "ResourceProto";
-
-// Resource information.
-message Resource {
-
- // Type identifier for the resource.
- string type = 1;
-
- // Set of labels that describe the resource.
- map<string,string> labels = 2;
-}
diff --git a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/stats/v1/stats.proto b/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/stats/v1/stats.proto
deleted file mode 100644
index 4c3ab0e8f6..0000000000
--- a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/stats/v1/stats.proto
+++ /dev/null
@@ -1,136 +0,0 @@
-// Copyright 2016-18, OpenCensus Authors
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-syntax = "proto3";
-
-package opencensus.proto.stats.v1;
-
-import "google/protobuf/timestamp.proto";
-
-option go_package = "github.com/census-instrumentation/opencensus-proto/gen-go/stats/v1";
-
-option java_multiple_files = true;
-option java_package = "io.opencensus.proto.stats.v1";
-option java_outer_classname = "StatsProto";
-
-// TODO(bdrutu): Consider if this should be moved to a "tags" directory to match the API structure.
-message Tag {
- string key = 1;
- string value = 2;
-}
-
-// Measure .
-message Measure {
- // A string by which the measure will be referred to, e.g. "rpc_server_latency". Names MUST be
- // unique within the library.
- string name = 1;
-
- // Describes the measure, e.g. "RPC latency in seconds".
- string description = 2;
-
- // Describes the unit used for the Measure. Follows the format described by
- // http://unitsofmeasure.org/ucum.html.
- string unit = 3;
-
- enum Type {
- // Unknown type.
- TYPE_UNSPECIFIED = 0;
- // Indicates an int64 Measure.
- INT64 = 1;
- // Indicates a double Measure.
- DOUBLE = 2;
- }
-
- // The type used for this Measure.
- Type type = 4;
-}
-
-message View {
- // A string by which the View will be referred to, e.g. "rpc_latency". Names MUST be unique
- // within the library.
- string name = 1;
-
- // Describes the view, e.g. "RPC latency distribution"
- string description = 2;
-
- // The Measure to which this view is applied.
- Measure measure = 3;
-
- // An array of tag keys. These values associated with tags of this name form the basis by which
- // individual stats will be aggregated (one aggregation per unique tag value). If none are
- // provided, then all data is recorded in a single aggregation.
- repeated string columns = 4;
-
- // The description of the aggregation used for this view which describes how data collected are
- // aggregated.
- oneof aggregation {
- // Counts the number of measurements recorded.
- CountAggregation count_aggregation = 5;
- // Indicates that data collected and aggregated with this Aggregation will be summed up.
- SumAggregation sum_aggregation = 6;
- // Indicates that data collected and aggregated with this Aggregation will represent the last
- // recorded value. This is useful to support Gauges.
- LastValueAggregation last_value_aggregation = 7;
- // Indicates that the desired Aggregation is a histogram distribution. A distribution
- // Aggregation may contain a histogram of the values in the population. User should define the
- // bucket boundaries for that histogram (see DistributionAggregation).
- DistributionAggregation distribution_aggregation = 8;
- }
-}
-
-message CountAggregation {}
-
-message SumAggregation {}
-
-message LastValueAggregation {}
-
-message DistributionAggregation {
- // A Distribution may optionally contain a histogram of the values in the
- // population. The bucket boundaries for that histogram are described by
- // `bucket_bounds`. This defines `size(bucket_bounds) + 1` (= N)
- // buckets. The boundaries for bucket index i are:
- //
- // (-infinity, bucket_bounds[i]) for i == 0
- // [bucket_bounds[i-1], bucket_bounds[i]) for 0 < i < N-2
- // [bucket_bounds[i-1], +infinity) for i == N-1
- //
- // i.e. an underflow bucket (number 0), zero or more finite buckets (1
- // through N - 2, and an overflow bucket (N - 1), with inclusive lower
- // bounds and exclusive upper bounds.
- //
- // If `bucket_bounds` has no elements (zero size), then there is no
- // histogram associated with the Distribution. If `bucket_bounds` has only
- // one element, there are no finite buckets, and that single element is the
- // common boundary of the overflow and underflow buckets. The values must
- // be monotonically increasing.
- repeated double bucket_bounds = 1;
-}
-
-// Describes a data point to be collected for a Measure.
-message Measurement {
- repeated Tag tags = 1;
-
- // The name of the measure to which the value is applied.
- string measure_name = 2;
-
- // The recorded value, MUST have the appropriate type to match the Measure.
- oneof value {
- double double_value = 3;
- int64 int_value = 4;
- }
-
- // The time when this measurement was recorded. If the implementation uses a async buffer to
- // record measurements this may be the time when the measurement was read from the buffer.
- google.protobuf.Timestamp time = 5;
-}
diff --git a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/trace/v1/trace.proto b/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/trace/v1/trace.proto
deleted file mode 100644
index d3ab528444..0000000000
--- a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/trace/v1/trace.proto
+++ /dev/null
@@ -1,420 +0,0 @@
-// Copyright 2017, OpenCensus Authors
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-syntax = "proto3";
-
-package opencensus.proto.trace.v1;
-
-import "opencensus/proto/resource/v1/resource.proto";
-import "google/protobuf/timestamp.proto";
-import "google/protobuf/wrappers.proto";
-
-option java_multiple_files = true;
-option java_package = "io.opencensus.proto.trace.v1";
-option java_outer_classname = "TraceProto";
-
-option go_package = "github.com/census-instrumentation/opencensus-proto/gen-go/trace/v1";
-
-// A span represents a single operation within a trace. Spans can be
-// nested to form a trace tree. Spans may also be linked to other spans
-// from the same or different trace. And form graphs. Often, a trace
-// contains a root span that describes the end-to-end latency, and one
-// or more subspans for its sub-operations. A trace can also contain
-// multiple root spans, or none at all. Spans do not need to be
-// contiguous - there may be gaps or overlaps between spans in a trace.
-//
-// The next id is 17.
-// TODO(bdrutu): Add an example.
-message Span {
- // A unique identifier for a trace. All spans from the same trace share
- // the same `trace_id`. The ID is a 16-byte array. An ID with all zeroes
- // is considered invalid.
- //
- // This field is semantically required. Receiver should generate new
- // random trace_id if empty or invalid trace_id was received.
- //
- // This field is required.
- bytes trace_id = 1;
-
- // A unique identifier for a span within a trace, assigned when the span
- // is created. The ID is an 8-byte array. An ID with all zeroes is considered
- // invalid.
- //
- // This field is semantically required. Receiver should generate new
- // random span_id if empty or invalid span_id was received.
- //
- // This field is required.
- bytes span_id = 2;
-
- // This field conveys information about request position in multiple distributed tracing graphs.
- // It is a list of Tracestate.Entry with a maximum of 32 members in the list.
- //
- // See the https://github.com/w3c/distributed-tracing for more details about this field.
- message Tracestate {
- message Entry {
- // The key must begin with a lowercase letter, and can only contain
- // lowercase letters 'a'-'z', digits '0'-'9', underscores '_', dashes
- // '-', asterisks '*', and forward slashes '/'.
- string key = 1;
-
- // The value is opaque string up to 256 characters printable ASCII
- // RFC0020 characters (i.e., the range 0x20 to 0x7E) except ',' and '='.
- // Note that this also excludes tabs, newlines, carriage returns, etc.
- string value = 2;
- }
-
- // A list of entries that represent the Tracestate.
- repeated Entry entries = 1;
- }
-
- // The Tracestate on the span.
- Tracestate tracestate = 15;
-
- // The `span_id` of this span's parent span. If this is a root span, then this
- // field must be empty. The ID is an 8-byte array.
- bytes parent_span_id = 3;
-
- // A description of the span's operation.
- //
- // For example, the name can be a qualified method name or a file name
- // and a line number where the operation is called. A best practice is to use
- // the same display name at the same call point in an application.
- // This makes it easier to correlate spans in different traces.
- //
- // This field is semantically required to be set to non-empty string.
- // When null or empty string received - receiver may use string "name"
- // as a replacement. There might be smarted algorithms implemented by
- // receiver to fix the empty span name.
- //
- // This field is required.
- TruncatableString name = 4;
-
- // Type of span. Can be used to specify additional relationships between spans
- // in addition to a parent/child relationship.
- enum SpanKind {
- // Unspecified.
- SPAN_KIND_UNSPECIFIED = 0;
-
- // Indicates that the span covers server-side handling of an RPC or other
- // remote network request.
- SERVER = 1;
-
- // Indicates that the span covers the client-side wrapper around an RPC or
- // other remote request.
- CLIENT = 2;
- }
-
- // Distinguishes between spans generated in a particular context. For example,
- // two spans with the same name may be distinguished using `CLIENT` (caller)
- // and `SERVER` (callee) to identify queueing latency associated with the span.
- SpanKind kind = 14;
-
- // The start time of the span. On the client side, this is the time kept by
- // the local machine where the span execution starts. On the server side, this
- // is the time when the server's application handler starts running.
- //
- // This field is semantically required. When not set on receive -
- // receiver should set it to the value of end_time field if it was
- // set. Or to the current time if neither was set. It is important to
- // keep end_time > start_time for consistency.
- //
- // This field is required.
- google.protobuf.Timestamp start_time = 5;
-
- // The end time of the span. On the client side, this is the time kept by
- // the local machine where the span execution ends. On the server side, this
- // is the time when the server application handler stops running.
- //
- // This field is semantically required. When not set on receive -
- // receiver should set it to start_time value. It is important to
- // keep end_time > start_time for consistency.
- //
- // This field is required.
- google.protobuf.Timestamp end_time = 6;
-
- // A set of attributes, each with a key and a value.
- message Attributes {
- // The set of attributes. The value can be a string, an integer, a double
- // or the Boolean values `true` or `false`. Note, global attributes like
- // server name can be set as tags using resource API. Examples of attributes:
- //
- // "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
- // "/http/server_latency": 300
- // "abc.com/myattribute": true
- // "abc.com/score": 10.239
- map<string, AttributeValue> attribute_map = 1;
-
- // The number of attributes that were discarded. Attributes can be discarded
- // because their keys are too long or because there are too many attributes.
- // If this value is 0, then no attributes were dropped.
- int32 dropped_attributes_count = 2;
- }
-
- // A set of attributes on the span.
- Attributes attributes = 7;
-
- // A stack trace captured at the start of the span.
- StackTrace stack_trace = 8;
-
- // A time-stamped annotation or message event in the Span.
- message TimeEvent {
- // The time the event occurred.
- google.protobuf.Timestamp time = 1;
-
- // A text annotation with a set of attributes.
- message Annotation {
- // A user-supplied message describing the event.
- TruncatableString description = 1;
-
- // A set of attributes on the annotation.
- Attributes attributes = 2;
- }
-
- // An event describing a message sent/received between Spans.
- message MessageEvent {
- // Indicates whether the message was sent or received.
- enum Type {
- // Unknown event type.
- TYPE_UNSPECIFIED = 0;
- // Indicates a sent message.
- SENT = 1;
- // Indicates a received message.
- RECEIVED = 2;
- }
-
- // The type of MessageEvent. Indicates whether the message was sent or
- // received.
- Type type = 1;
-
- // An identifier for the MessageEvent's message that can be used to match
- // SENT and RECEIVED MessageEvents. For example, this field could
- // represent a sequence ID for a streaming RPC. It is recommended to be
- // unique within a Span.
- uint64 id = 2;
-
- // The number of uncompressed bytes sent or received.
- uint64 uncompressed_size = 3;
-
- // The number of compressed bytes sent or received. If zero, assumed to
- // be the same size as uncompressed.
- uint64 compressed_size = 4;
- }
-
- // A `TimeEvent` can contain either an `Annotation` object or a
- // `MessageEvent` object, but not both.
- oneof value {
- // A text annotation with a set of attributes.
- Annotation annotation = 2;
-
- // An event describing a message sent/received between Spans.
- MessageEvent message_event = 3;
- }
- }
-
- // A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation
- // on the span, consisting of either user-supplied key-value pairs, or
- // details of a message sent/received between Spans.
- message TimeEvents {
- // A collection of `TimeEvent`s.
- repeated TimeEvent time_event = 1;
-
- // The number of dropped annotations in all the included time events.
- // If the value is 0, then no annotations were dropped.
- int32 dropped_annotations_count = 2;
-
- // The number of dropped message events in all the included time events.
- // If the value is 0, then no message events were dropped.
- int32 dropped_message_events_count = 3;
- }
-
- // The included time events.
- TimeEvents time_events = 9;
-
- // A pointer from the current span to another span in the same trace or in a
- // different trace. For example, this can be used in batching operations,
- // where a single batch handler processes multiple requests from different
- // traces or when the handler receives a request from a different project.
- message Link {
- // A unique identifier of a trace that this linked span is part of. The ID is a
- // 16-byte array.
- bytes trace_id = 1;
-
- // A unique identifier for the linked span. The ID is an 8-byte array.
- bytes span_id = 2;
-
- // The relationship of the current span relative to the linked span: child,
- // parent, or unspecified.
- enum Type {
- // The relationship of the two spans is unknown, or known but other
- // than parent-child.
- TYPE_UNSPECIFIED = 0;
- // The linked span is a child of the current span.
- CHILD_LINKED_SPAN = 1;
- // The linked span is a parent of the current span.
- PARENT_LINKED_SPAN = 2;
- }
-
- // The relationship of the current span relative to the linked span.
- Type type = 3;
-
- // A set of attributes on the link.
- Attributes attributes = 4;
-
- // The Tracestate associated with the link.
- Tracestate tracestate = 5;
- }
-
- // A collection of links, which are references from this span to a span
- // in the same or different trace.
- message Links {
- // A collection of links.
- repeated Link link = 1;
-
- // The number of dropped links after the maximum size was enforced. If
- // this value is 0, then no links were dropped.
- int32 dropped_links_count = 2;
- }
-
- // The included links.
- Links links = 10;
-
- // An optional final status for this span. Semantically when Status
- // wasn't set it is means span ended without errors and assume
- // Status.Ok (code = 0).
- Status status = 11;
-
- // An optional resource that is associated with this span. If not set, this span
- // should be part of a batch that does include the resource information, unless resource
- // information is unknown.
- opencensus.proto.resource.v1.Resource resource = 16;
-
- // A highly recommended but not required flag that identifies when a
- // trace crosses a process boundary. True when the parent_span belongs
- // to the same process as the current span. This flag is most commonly
- // used to indicate the need to adjust time as clocks in different
- // processes may not be synchronized.
- google.protobuf.BoolValue same_process_as_parent_span = 12;
-
- // An optional number of child spans that were generated while this span
- // was active. If set, allows an implementation to detect missing child spans.
- google.protobuf.UInt32Value child_span_count = 13;
-}
-
-// The `Status` type defines a logical error model that is suitable for different
-// programming environments, including REST APIs and RPC APIs. This proto's fields
-// are a subset of those of
-// [google.rpc.Status](https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto),
-// which is used by [gRPC](https://github.com/grpc).
-message Status {
- // The status code. This is optional field. It is safe to assume 0 (OK)
- // when not set.
- int32 code = 1;
-
- // A developer-facing error message, which should be in English.
- string message = 2;
-}
-
-// The value of an Attribute.
-message AttributeValue {
- // The type of the value.
- oneof value {
- // A string up to 256 bytes long.
- TruncatableString string_value = 1;
- // A 64-bit signed integer.
- int64 int_value = 2;
- // A Boolean value represented by `true` or `false`.
- bool bool_value = 3;
- // A double value.
- double double_value = 4;
- }
-}
-
-// The call stack which originated this span.
-message StackTrace {
- // A single stack frame in a stack trace.
- message StackFrame {
- // The fully-qualified name that uniquely identifies the function or
- // method that is active in this frame.
- TruncatableString function_name = 1;
- // An un-mangled function name, if `function_name` is
- // [mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can
- // be fully qualified.
- TruncatableString original_function_name = 2;
- // The name of the source file where the function call appears.
- TruncatableString file_name = 3;
- // The line number in `file_name` where the function call appears.
- int64 line_number = 4;
- // The column number where the function call appears, if available.
- // This is important in JavaScript because of its anonymous functions.
- int64 column_number = 5;
- // The binary module from where the code was loaded.
- Module load_module = 6;
- // The version of the deployed source code.
- TruncatableString source_version = 7;
- }
-
- // A collection of stack frames, which can be truncated.
- message StackFrames {
- // Stack frames in this call stack.
- repeated StackFrame frame = 1;
- // The number of stack frames that were dropped because there
- // were too many stack frames.
- // If this value is 0, then no stack frames were dropped.
- int32 dropped_frames_count = 2;
- }
-
- // Stack frames in this stack trace.
- StackFrames stack_frames = 1;
-
- // The hash ID is used to conserve network bandwidth for duplicate
- // stack traces within a single trace.
- //
- // Often multiple spans will have identical stack traces.
- // The first occurrence of a stack trace should contain both
- // `stack_frames` and a value in `stack_trace_hash_id`.
- //
- // Subsequent spans within the same request can refer
- // to that stack trace by setting only `stack_trace_hash_id`.
- //
- // TODO: describe how to deal with the case where stack_trace_hash_id is
- // zero because it was not set.
- uint64 stack_trace_hash_id = 2;
-}
-
-// A description of a binary module.
-message Module {
- // TODO: document the meaning of this field.
- // For example: main binary, kernel modules, and dynamic libraries
- // such as libc.so, sharedlib.so.
- TruncatableString module = 1;
-
- // A unique identifier for the module, usually a hash of its
- // contents.
- TruncatableString build_id = 2;
-}
-
-// A string that might be shortened to a specified length.
-message TruncatableString {
- // The shortened string. For example, if the original string was 500 bytes long and
- // the limit of the string was 128 bytes, then this value contains the first 128
- // bytes of the 500-byte string. Note that truncation always happens on a
- // character boundary, to ensure that a truncated string is still valid UTF-8.
- // Because it may contain multi-byte characters, the size of the truncated string
- // may be less than the truncation limit.
- string value = 1;
-
- // The number of bytes removed from the original string. If this
- // value is 0, then the string was not shortened.
- int32 truncated_byte_count = 2;
-}
diff --git a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/trace/v1/trace_config.proto b/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/trace/v1/trace_config.proto
deleted file mode 100644
index 0f9b5f3c03..0000000000
--- a/oap-server/server-receiver-plugin/receiver-proto/src/main/proto/opencensus/proto/trace/v1/trace_config.proto
+++ /dev/null
@@ -1,79 +0,0 @@
-// Copyright 2018, OpenCensus Authors
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-syntax = "proto3";
-
-package opencensus.proto.trace.v1;
-
-option java_multiple_files = true;
-option java_package = "io.opencensus.proto.trace.v1";
-option java_outer_classname = "TraceConfigProto";
-
-option go_package = "github.com/census-instrumentation/opencensus-proto/gen-go/trace/v1";
-
-// Global configuration of the trace service. All fields must be specified, or
-// the default (zero) values will be used for each type.
-message TraceConfig {
-
- // The global default sampler used to make decisions on span sampling.
- oneof sampler {
- ProbabilitySampler probability_sampler = 1;
-
- ConstantSampler constant_sampler = 2;
-
- RateLimitingSampler rate_limiting_sampler = 3;
- }
-
- // The global default max number of attributes per span.
- int64 max_number_of_attributes = 4;
-
- // The global default max number of annotation events per span.
- int64 max_number_of_annotations = 5;
-
- // The global default max number of message events per span.
- int64 max_number_of_message_events = 6;
-
- // The global default max number of link entries per span.
- int64 max_number_of_links = 7;
-}
-
-// Sampler that tries to uniformly sample traces with a given probability.
-// The probability of sampling a trace is equal to that of the specified probability.
-message ProbabilitySampler {
-
- // The desired probability of sampling. Must be within [0.0, 1.0].
- double samplingProbability = 1;
-}
-
-// Sampler that always makes a constant decision on span sampling.
-message ConstantSampler {
-
- // How spans should be sampled:
- // - Always off
- // - Always on
- // - Always follow the parent Span's decision (off if no parent).
- enum ConstantDecision {
- ALWAYS_OFF = 0;
- ALWAYS_ON = 1;
- ALWAYS_PARENT = 2;
- }
- ConstantDecision decision = 1;
-}
-
-// Sampler that tries to sample with a rate per time window.
-message RateLimitingSampler {
-
- // Rate per second.
- int64 qps = 1;
-}
diff --git a/oap-server/server-starter/src/main/resources/application.yml b/oap-server/server-starter/src/main/resources/application.yml
index 76c775e765..19146f0e36 100644
--- a/oap-server/server-starter/src/main/resources/application.yml
+++ b/oap-server/server-starter/src/main/resources/application.yml
@@ -331,7 +331,7 @@ receiver-meter:
receiver-otel:
selector: ${SW_OTEL_RECEIVER:default}
default:
- enabledHandlers: ${SW_OTEL_RECEIVER_ENABLED_HANDLERS:"oc,otlp"}
+ enabledHandlers: ${SW_OTEL_RECEIVER_ENABLED_HANDLERS:"otlp"}
enabledOtelRules: ${SW_OTEL_RECEIVER_ENABLED_OTEL_RULES:"apisix,k8s/*,istio-controlplane,vm,mysql/*,postgresql/*,oap,aws-eks/*,windows,aws-s3/*,aws-dynamodb/*,aws-gateway/*,redis/*,elasticsearch/*"}
receiver-zipkin:
diff --git a/test/e2e-v2/cases/mariadb/prometheus-mariadb-exporter/otel-collector-config.yaml b/test/e2e-v2/cases/mariadb/prometheus-mariadb-exporter/otel-collector-config.yaml
index 792fe0f621..e095a9636e 100644
--- a/test/e2e-v2/cases/mariadb/prometheus-mariadb-exporter/otel-collector-config.yaml
+++ b/test/e2e-v2/cases/mariadb/prometheus-mariadb-exporter/otel-collector-config.yaml
@@ -27,14 +27,6 @@ processors:
batch:
exporters:
- ####################################################################################
- # If you want to use otlp exporter please ensure that your OAP version is >= 9.2.0 #
- # or you can use oc exporter, The config format should be: #
- # opencensus: #
- # endpoint: "oap:11800" #
- # tls: #
- # insecure: true #
- ####################################################################################
otlp:
endpoint: oap:11800
tls:
@@ -47,8 +39,4 @@ service:
processors:
- batch
exporters:
- #########################################
- # oc exporter config format: #
- # - opencensus #
- #########################################
- otlp
diff --git a/test/e2e-v2/cases/mysql/prometheus-mysql-exporter/otel-collector-config.yaml b/test/e2e-v2/cases/mysql/prometheus-mysql-exporter/otel-collector-config.yaml
index 5a78af97fb..1207279441 100644
--- a/test/e2e-v2/cases/mysql/prometheus-mysql-exporter/otel-collector-config.yaml
+++ b/test/e2e-v2/cases/mysql/prometheus-mysql-exporter/otel-collector-config.yaml
@@ -27,14 +27,6 @@ processors:
batch:
exporters:
- ####################################################################################
- # If you want to use otlp exporter please ensure that your OAP version is >= 9.2.0 #
- # or you can use oc exporter, The config format should be: #
- # opencensus: #
- # endpoint: "oap:11800" #
- # tls: #
- # insecure: true #
- ####################################################################################
otlp:
endpoint: oap:11800
tls:
@@ -47,8 +39,4 @@ service:
processors:
- batch
exporters:
- #########################################
- # oc exporter config format: #
- # - opencensus #
- #########################################
- otlp
diff --git a/test/e2e-v2/cases/postgresql/postgres-exporter/otel-collector-config.yaml b/test/e2e-v2/cases/postgresql/postgres-exporter/otel-collector-config.yaml
index 17502ae819..5d8a7fd81b 100644
--- a/test/e2e-v2/cases/postgresql/postgres-exporter/otel-collector-config.yaml
+++ b/test/e2e-v2/cases/postgresql/postgres-exporter/otel-collector-config.yaml
@@ -27,14 +27,6 @@ processors:
batch:
exporters:
- ####################################################################################
- # If you want to use otlp exporter please ensure that your OAP version is >= 9.2.0 #
- # or you can use oc exporter, The config format should be: #
- # opencensus: #
- # endpoint: "oap:11800" #
- # tls: #
- # insecure: true #
- ####################################################################################
otlp:
endpoint: oap:11800
tls:
@@ -49,9 +41,5 @@ service:
processors:
- batch
exporters:
- #########################################
- # oc exporter config format: #
- # - opencensus #
- #########################################
- logging
- otlp
diff --git a/test/e2e-v2/cases/redis/redis-exporter/otel-collector-config.yaml b/test/e2e-v2/cases/redis/redis-exporter/otel-collector-config.yaml
index 5f1f4a04ac..f4f3c0dc64 100644
--- a/test/e2e-v2/cases/redis/redis-exporter/otel-collector-config.yaml
+++ b/test/e2e-v2/cases/redis/redis-exporter/otel-collector-config.yaml
@@ -27,14 +27,6 @@ processors:
batch:
exporters:
- ####################################################################################
- # If you want to use otlp exporter please ensure that your OAP version is >= 9.2.0 #
- # or you can use oc exporter, The config format should be: #
- # opencensus: #
- # endpoint: "oap:11800" #
- # tls: #
- # insecure: true #
- ####################################################################################
otlp:
endpoint: oap:11800
tls:
@@ -47,8 +39,4 @@ service:
processors:
- batch
exporters:
- #########################################
- # oc exporter config format: #
- # - opencensus #
- #########################################
- otlp
diff --git a/test/e2e-v2/cases/so11y/otel-collector-config.yaml b/test/e2e-v2/cases/so11y/otel-collector-config.yaml
index c3c91b0b5a..3a11fb3cc1 100644
--- a/test/e2e-v2/cases/so11y/otel-collector-config.yaml
+++ b/test/e2e-v2/cases/so11y/otel-collector-config.yaml
@@ -28,14 +28,6 @@ processors:
batch:
exporters:
- ####################################################################################
- # If you want to use otlp exporter please ensure that your OAP version is >= 9.2.0 #
- # or you can use oc exporter, The config format should be: #
- # opencensus: #
- # endpoint: "oap:11800" #
- # tls: #
- # insecure: true #
- ####################################################################################
otlp:
endpoint: oap:11800
tls:
@@ -51,9 +43,5 @@ service:
processors:
- batch
exporters:
- #########################################
- # oc exporter config format: #
- # - opencensus #
- #########################################
- otlp
- logging
diff --git a/test/e2e-v2/cases/vm/prometheus-node-exporter/otel-collector-config.yaml b/test/e2e-v2/cases/vm/prometheus-node-exporter/otel-collector-config.yaml
index 511809125e..4710259d22 100644
--- a/test/e2e-v2/cases/vm/prometheus-node-exporter/otel-collector-config.yaml
+++ b/test/e2e-v2/cases/vm/prometheus-node-exporter/otel-collector-config.yaml
@@ -26,23 +26,10 @@ processors:
batch:
exporters:
- ####################################################################################
- # If you want to use otlp exporter please ensure that your OAP version is >= 9.2.0 #
- # or you can use oc exporter, The config format should be: #
- # opencensus: #
- # endpoint: "oap:11800" #
- # tls: #
- # insecure: true #
- ####################################################################################
otlp:
endpoint: "oap:11800" # The OAP Server address
- ###############################################################################
- # OTEL previous version before 0.34.0 the config format, eg. 0.29.0 should be:#
- # insecure: true #
- # The new version should be: #
- # tls: #
- # insecure: true #
- ###############################################################################
+ # The config format of OTEL version prior to 0.34.0, eg. 0.29.0, should be:
+ # insecure: true
tls:
insecure: true
#insecure: true
@@ -55,8 +42,4 @@ service:
metrics:
receivers: [prometheus]
processors: [batch]
- #########################################
- # oc exporter config format: #
- # exporters: [opencensus,logging] #
- #########################################
exporters: [otlp, logging]
diff --git a/test/e2e-v2/cases/win/prometheus-windows_exporter/otel-collector-config.yaml b/test/e2e-v2/cases/win/prometheus-windows_exporter/otel-collector-config.yaml
index 373996186f..872c23d429 100644
--- a/test/e2e-v2/cases/win/prometheus-windows_exporter/otel-collector-config.yaml
+++ b/test/e2e-v2/cases/win/prometheus-windows_exporter/otel-collector-config.yaml
@@ -26,26 +26,12 @@ processors:
batch:
exporters:
- ####################################################################################
- # If you want to use otlp exporter please ensure that your OAP version is >= 9.2.0 #
- # or you can use oc exporter, The config format should be: #
- # opencensus: #
- # endpoint: "oap:11800" #
- # tls: #
- # insecure: true #
- ####################################################################################
otlp:
endpoint: "oap:11800" # The OAP Server address
- ###############################################################################
- # OTEL previous version before 0.34.0 the config format, eg. 0.29.0 should be:#
- # insecure: true #
- # The new version should be: #
- # tls: #
- # insecure: true #
- ###############################################################################
+ # The config format of OTEL version prior to 0.34.0, eg. 0.29.0, should be:
+ # insecure: true
tls:
insecure: true
- #insecure: true
# Exports data to the console
logging:
logLevel: debug
@@ -55,8 +41,4 @@ service:
metrics:
receivers: [prometheus]
processors: [batch]
- #########################################
- # oc exporter config format: #
- # exporters: [opencensus,logging] #
- #########################################
exporters: [otlp, logging]