You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by ke...@apache.org on 2022/06/02 08:06:25 UTC
[skywalking-showcase] branch main updated: Move trace profiling to separate feature, add some docs (#41)
This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-showcase.git
The following commit(s) were added to refs/heads/main by this push:
new c7edbb3 Move trace profiling to separate feature, add some docs (#41)
c7edbb3 is described below
commit c7edbb37e6bba7447049c3fe3ae03f4b833ad8a3
Author: kezhenxu94 <ke...@apache.org>
AuthorDate: Thu Jun 2 16:06:20 2022 +0800
Move trace profiling to separate feature, add some docs (#41)
- Trace profiling should not be added in `agent` feature, because it's reused for agentless scenario and in that case the trace profiling won't work, causing many failed jobs.
- Add docs about the risks regarding environment.
- Add back doc about `agent`, it's not enabled by default but it's still there so users should be able to use if they wish.
---
deploy/platform/kubernetes/Makefile.in | 2 +-
deploy/platform/kubernetes/feature-rover/profiling.yaml | 3 +--
.../{feature-agent => feature-trace-profiling}/profiling.yaml | 1 -
docs/readme.md | 6 ++++++
4 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/deploy/platform/kubernetes/Makefile.in b/deploy/platform/kubernetes/Makefile.in
index 0bc00eb..74c7d9d 100644
--- a/deploy/platform/kubernetes/Makefile.in
+++ b/deploy/platform/kubernetes/Makefile.in
@@ -22,4 +22,4 @@ NAMESPACE ?= default
AGENTLESS ?= false
BACKEND_SERVICE ?= oap
-FEATURE_FLAGS ?= java-agent-injector,cluster,kubernetes-monitor,so11y,vm,als,event,istiod-monitor,satellite,rover
+FEATURE_FLAGS ?= java-agent-injector,cluster,kubernetes-monitor,so11y,vm,als,event,istiod-monitor,satellite,rover,trace-profiling
diff --git a/deploy/platform/kubernetes/feature-rover/profiling.yaml b/deploy/platform/kubernetes/feature-rover/profiling.yaml
index 81e3b2d..67294f8 100644
--- a/deploy/platform/kubernetes/feature-rover/profiling.yaml
+++ b/deploy/platform/kubernetes/feature-rover/profiling.yaml
@@ -34,7 +34,6 @@ spec:
containers:
- name: ebpf-profiling-trigger
image: ${SW_CLI_IMAGE}
- volumeMounts:
command:
- /bin/sh
- -c
@@ -50,4 +49,4 @@ spec:
/swctl --base-url=http://oap:12800/graphql profiling ebpf create fixed \
--service-name agentless::songs --labels mesh-envoy --duration=9m --target-type OFF_CPU;
- restartPolicy: Never
\ No newline at end of file
+ restartPolicy: Never
diff --git a/deploy/platform/kubernetes/feature-agent/profiling.yaml b/deploy/platform/kubernetes/feature-trace-profiling/profiling.yaml
similarity index 98%
rename from deploy/platform/kubernetes/feature-agent/profiling.yaml
rename to deploy/platform/kubernetes/feature-trace-profiling/profiling.yaml
index 480af54..a3fa757 100644
--- a/deploy/platform/kubernetes/feature-agent/profiling.yaml
+++ b/deploy/platform/kubernetes/feature-trace-profiling/profiling.yaml
@@ -34,7 +34,6 @@ spec:
containers:
- name: trace-profiling-trigger
image: ${SW_CLI_IMAGE}
- volumeMounts:
command:
- /bin/sh
- -c
diff --git a/docs/readme.md b/docs/readme.md
index 56fb2d4..e301789 100644
--- a/docs/readme.md
+++ b/docs/readme.md
@@ -17,6 +17,10 @@ graph LR;
## Usage
+**Please run the showcase in a brand new test cluster, otherwise the undeploy process may delete
+some resources that you have installed before running this showcase (for example cert-manager).
+If you don't do this in a new test cluster, it's all on your own risks!**
+
The showcase uses [GNU Make](https://www.gnu.org/software/make/) and Docker containers to run commands, so please make
sure you have `make` installed and Docker daemon running.
@@ -79,6 +83,7 @@ Currently, the features supported are:
| Name | Description | Note |
|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| `java-agent-injector` | Use the java agent injector to inject the Skywalking Java agent and deploy microservices with other SkyWalking agent enabled. | The microservices include agents for Java, NodeJS server, browser, Python. |
+| `agent` | Deploy microservices with SkyWalking agent pre-installed. | In Kubernetes sceanarios, please use `java-agent-injector` instead of this, if possible. |
| `cluster` | Deploy SkyWalking OAP in cluster mode, with 2 nodes, and SkyWalking UI, ElasticSearch as storage. | Only one of `cluster` or `single-node` can be enabled. |
| `single-node` | Deploy only one single node of SkyWalking OAP, and SkyWalking UI, ElasticSearch as storage. | Only one of `cluster` or `single-node` can be enabled. |
| `so11y` | Enable SkyWalking self observability. | This is enabled by default for platform [Docker Compose](#docker-compose). |
@@ -89,6 +94,7 @@ Currently, the features supported are:
| `event` | Deploy tools to trigger events, and SkyWalking Kubernetes event exporter to export events into SkyWalking. | |
| `satellite` | Deploy SkyWalking Satellite to load balance the monitoring data. | |
| `function` | Deploy [OpenFunction](https://openfunction.dev/) and export trace to SkyWalking. | Command [ofn](https://github.com/OpenFunction/cli) is required to run this feature. |
+| `trace-profiling` | Deploy tools to submit trace profiling tasks. | Only support deployment with SkyWalking agents installed, currently Java agent and Python agent support trace profiling. |
| `rover` | Deploy SkyWalking Rover and detect the processes in the Kubernetes environment. | Only support deployment in the Kubernetes environment, docker is not supported. |
### Kubernetes