You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by wu...@apache.org on 2020/03/04 03:38:49 UTC
[skywalking] 02/02: Support activeExtraModelColumns as a default
OFF option.
This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch name-field
in repository https://gitbox.apache.org/repos/asf/skywalking.git
commit b2d1cd0f5bc3d2ee2bfb25c221e781571881929c
Author: Wu Sheng <wu...@foxmail.com>
AuthorDate: Wed Mar 4 11:38:30 2020 +0800
Support activeExtraModelColumns as a default OFF option.
---
dist-material/application.yml | 4 ++++
docs/en/setup/backend/backend-setup.md | 12 ++++++++++++
.../server-bootstrap/src/main/resources/application.yml | 4 ++++
.../apache/skywalking/oap/server/core/CoreModuleConfig.java | 2 +-
.../skywalking/oap/server/core/source/EndpointRelation.java | 6 ++++--
.../oap/server/core/source/ServiceInstanceRelation.java | 4 ++++
.../skywalking/oap/server/core/source/ServiceRelation.java | 2 ++
7 files changed, 31 insertions(+), 3 deletions(-)
diff --git a/dist-material/application.yml b/dist-material/application.yml
index 8012e41..4067fef 100644
--- a/dist-material/application.yml
+++ b/dist-material/application.yml
@@ -75,6 +75,10 @@ core:
# the metrics may not be accurate within that minute.
enableDatabaseSession: ${SW_CORE_ENABLE_DATABASE_SESSION:true}
topNReportPeriod: ${SW_CORE_TOPN_REPORT_PERIOD:10} # top_n record worker report cycle, unit is minute
+ # Extra model column are the column defined by in the codes, These columns of model are not required logically in aggregation or further query,
+ # and it will cause more load for memory, network of OAP and storage.
+ # But, being activated, user could see the name in the storage entities, which make users easier to use 3rd party tool, such as Kibana->ES, to query the data by themselves.
+ activeExtraModelColumns: ${SW_CORE_ACTIVE_EXTRA_MODEL_COLUMNS:false}
storage:
# elasticsearch:
# nameSpace: ${SW_NAMESPACE:""}
diff --git a/docs/en/setup/backend/backend-setup.md b/docs/en/setup/backend/backend-setup.md
index f006be2..223b886 100755
--- a/docs/en/setup/backend/backend-setup.md
+++ b/docs/en/setup/backend/backend-setup.md
@@ -115,3 +115,15 @@ which format process is timezone related.
In default, SkyWalking OAP backend choose the OS default timezone.
If you want to override it, please follow Java and OS documents to do so.
+
+#### How to query the storage directly from 3rd party tool?
+SkyWalking provides browser UI, CLI and GraphQL ways to support extensions. But some users may have the idea to query data
+directly from the storage. Such as in ElasticSearch case, Kibana is a great tool to do this.
+
+In default, due to save memory/network and storage space, SkyWalking saves id(s) only in the entity and metadata saved in the
+*_inventory entities only. But these tools usually don't support nested query, or don't work conveniently. In this special case,
+SkyWalking provide a config to add all necessary name column(s) into the final metrics entities with ID as a trade-off.
+
+Take a look at `core/default/activeExtraModelColumns` config in the `application.yaml`, and set it as `true` to open this feature.
+
+This feature wouldn't provide any new feature to the native SkyWalking scenarios, just for the 3rd party integration.
diff --git a/oap-server/server-bootstrap/src/main/resources/application.yml b/oap-server/server-bootstrap/src/main/resources/application.yml
index a97537b..3d87b3e 100755
--- a/oap-server/server-bootstrap/src/main/resources/application.yml
+++ b/oap-server/server-bootstrap/src/main/resources/application.yml
@@ -74,6 +74,10 @@ core:
# the metrics may not be accurate within that minute.
enableDatabaseSession: ${SW_CORE_ENABLE_DATABASE_SESSION:true}
topNReportPeriod: ${SW_CORE_TOPN_REPORT_PERIOD:10} # top_n record worker report cycle, unit is minute
+ # Extra model column are the column defined by in the codes, These columns of model are not required logically in aggregation or further query,
+ # and it will cause more load for memory, network of OAP and storage.
+ # But, being activated, user could see the name in the storage entities, which make users easier to use 3rd party tool, such as Kibana->ES, to query the data by themselves.
+ activeExtraModelColumns: ${SW_CORE_ACTIVE_EXTRA_MODEL_COLUMNS:false}
storage:
# elasticsearch:
# nameSpace: ${SW_NAMESPACE:""}
diff --git a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/CoreModuleConfig.java b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/CoreModuleConfig.java
index 034650e..09cf78c 100644
--- a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/CoreModuleConfig.java
+++ b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/CoreModuleConfig.java
@@ -106,7 +106,7 @@ public class CoreModuleConfig extends ModuleConfig {
/**
* Extra model column are the column defined by {@link ScopeDefaultColumn.DefinedByField#requireDynamicActive()} ==
- * true. This model is not required logically in aggregation or further query, and it will cause more load for
+ * true. These columns of model are not required logically in aggregation or further query, and it will cause more load for
* memory, network of OAP and storage.
*
* But, being activated, user could see the name in the storage entities, which make users easier to use 3rd party
diff --git a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/EndpointRelation.java b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/EndpointRelation.java
index 9731037..5a87d30 100644
--- a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/EndpointRelation.java
+++ b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/EndpointRelation.java
@@ -43,6 +43,7 @@ public class EndpointRelation extends Source {
private int endpointId;
@Getter
@Setter
+ @ScopeDefaultColumn.DefinedByField(columnName = "source_endpoint_name", requireDynamicActive = true)
private String endpoint;
@Getter
@Setter
@@ -50,10 +51,10 @@ public class EndpointRelation extends Source {
private int serviceId;
@Getter
@Setter
+ @ScopeDefaultColumn.DefinedByField(columnName = "source_service_name", requireDynamicActive = true)
private String serviceName;
@Getter
@Setter
- @ScopeDefaultColumn.DefinedByField(columnName = "service_instance_id")
private int serviceInstanceId;
@Getter
@Setter
@@ -64,6 +65,7 @@ public class EndpointRelation extends Source {
private int childEndpointId;
@Getter
@Setter
+ @ScopeDefaultColumn.DefinedByField(columnName = "child_endpoint_name", requireDynamicActive = true)
private String childEndpoint;
@Getter
@Setter
@@ -71,10 +73,10 @@ public class EndpointRelation extends Source {
private int childServiceId;
@Getter
@Setter
+ @ScopeDefaultColumn.DefinedByField(columnName = "child_service_name", requireDynamicActive = true)
private String childServiceName;
@Getter
@Setter
- @ScopeDefaultColumn.DefinedByField(columnName = "child_service_instance_id")
private int childServiceInstanceId;
@Getter
@Setter
diff --git a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/ServiceInstanceRelation.java b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/ServiceInstanceRelation.java
index 34b0906..9523c9a 100644
--- a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/ServiceInstanceRelation.java
+++ b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/ServiceInstanceRelation.java
@@ -48,9 +48,11 @@ public class ServiceInstanceRelation extends Source {
private int sourceServiceId;
@Getter
@Setter
+ @ScopeDefaultColumn.DefinedByField(columnName = "source_service_name", requireDynamicActive = true)
private String sourceServiceName;
@Getter
@Setter
+ @ScopeDefaultColumn.DefinedByField(columnName = "source_service_instance_name", requireDynamicActive = true)
private String sourceServiceInstanceName;
@Getter
@Setter
@@ -62,9 +64,11 @@ public class ServiceInstanceRelation extends Source {
private int destServiceId;
@Getter
@Setter
+ @ScopeDefaultColumn.DefinedByField(columnName = "dest_service_name", requireDynamicActive = true)
private String destServiceName;
@Getter
@Setter
+ @ScopeDefaultColumn.DefinedByField(columnName = "dest_service_instance_name", requireDynamicActive = true)
private String destServiceInstanceName;
@Getter
@Setter
diff --git a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/ServiceRelation.java b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/ServiceRelation.java
index f2016ba..7a8172b 100644
--- a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/ServiceRelation.java
+++ b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/ServiceRelation.java
@@ -43,6 +43,7 @@ public class ServiceRelation extends Source {
private int sourceServiceId;
@Getter
@Setter
+ @ScopeDefaultColumn.DefinedByField(columnName = "source_name", requireDynamicActive = true)
private String sourceServiceName;
@Getter
@Setter
@@ -52,6 +53,7 @@ public class ServiceRelation extends Source {
private int destServiceId;
@Getter
@Setter
+ @ScopeDefaultColumn.DefinedByField(columnName = "dest_name", requireDynamicActive = true)
private String destServiceName;
@Getter
@Setter