You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by GitBox <gi...@apache.org> on 2021/02/09 08:24:20 UTC
[GitHub] [skywalking-satellite] EvanLjp opened a new pull request #23: polish docs
EvanLjp opened a new pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23
polish docs
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] gxthrj commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
gxthrj commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r572712901
##########
File path: docs/en/concepts-and-designs/overview.md
##########
@@ -0,0 +1,22 @@
+# Overview
+SkyWalking Satellite: an open-source agent designed for the cloud-native infrastructures, which provides a low-cost, high-efficient, and more secure way to collect telemetry data, such that Trace Segments, Logs, or Metrics.
+
+
+## Why use SkyWalking Satellite?
+Observability is the solution to the complex scenario of cloud-native services. However, we may encounter different telemetry data scenarios, different language services, big data analysis, etc. Satellite provides a unified data collection layer for cloud-native services.
+You can easily use it to connect to the SkyWalking ecosystem and enhance the capacity of SkyWalking.
+There are some enhance features on the following when using Satellite.
+
+1. Provide a unified data collection layer to collect logs, traces, and metrics.
+2. Provide a safer local cache to reduce the memory cost of the service.
+3. Provide the unified transfer way shields the functional differences in the different language libs, such as MQ.
+4. Provides the preprocessing functions to ensure accuracy of the metrics, such as sampling.
+
+## Architecture
+SkyWalking Satellite is logically split into four parts: Gatherer, Processor, and Sender.
Review comment:
`four parts` -> `three parts`
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] EvanLjp commented on pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
EvanLjp commented on pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#issuecomment-775798885
> 1. Where could I find a recommend configuration in the source and dist?
That's configured in the plugin-description default config.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] EvanLjp commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
EvanLjp commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573416237
##########
File path: README.md
##########
@@ -8,16 +8,22 @@ Apache SkyWalking Satellite
[](https://github.com/apache/skywalking)
[](https://twitter.com/AsfSkyWalking)
-# Quick Start
-
# Documentation
-- [The first design of Satellite 0.1.0](https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/)
-- [The project structure](./docs/project_structue.md)
+- [Official documentation](https://skywalking.apache.org/docs/)
+- [Blog](https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/) about the design of Satellite 0.1.0.
+
+NOTICE, SkyWalking Satellite uses [v3 protocols](https://github.com/apache/skywalking/blob/master/docs/en/protocols/README.md). They are incompatible with previous SkyWalking releases before SkyWalking 8.0.
# Download
+Go to the [download page](https://skywalking.apache.org/downloads/) to download all available binaries, including MacOS and Linux.
+If you want to try the latest features or run on the Windows, however, you can compile the latest codes yourself, as the guide below.
# Compile
-[How to compile the Satellite.](./docs/compile/compile.md)
+As SkyWalking Satellite is using `Makefile`, compiling the project is as easy as executing a command in the root directory of the project.
+```shell script
+make build
+```
+Due to system compatibility problems, some plugins of SkyWalking Satellite cannot be used in Windows system. If you need to compile SkyWalking Satellite on Windows platform, please read [the doc](docs/en/guides/compile/compile.md).
Review comment:
fixed
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng commented on pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#issuecomment-775801424
> > 1. Where could I find a recommend configuration in the source and dist?
> > That's configured in the plugin-description default config.
No, it isn't. The end users are focusing how to use `satellite_config.yaml` in the dist as step one, the documentation you provided represents nothing related to that, no hierarchy structure, key words.
Let me give an example,
In your documentation, this is about fallback
This is how the YAML really looks like
How could a new users to link these two together? This is not easy even for me.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r574195996
##########
File path: docs/en/setup/README.md
##########
@@ -0,0 +1,19 @@
+# Setup
+First and most important thing is, SkyWalking Satellite startup behaviours are driven by configs/satellite_config.yaml. Understood the setting file will help you to read this document.
+
+## Startup script
+The startup script is /bin/skywalking-satellite-{version}-{plateform}-amd64.
+1. Start SkyWalking Satellite.
+```shell script
+./bin/skywalking-satellite-{version}-{plateform}-amd64 start --config=./configs/satellite_config.yaml
Review comment:
This is correct and not correct at the same time. This actually is a dev-command for the source code local compiling startup.
But usually, like you see in SkyWalking's main repo release, you should have a DIST tar, including binaries and config file in the same folder.
@EvanLjp Do you plan to use another PR to do this?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] EvanLjp edited a comment on pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
EvanLjp edited a comment on pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#issuecomment-775798885
> 1. Where could I find a recommend configuration in the source and dist?
That's configured in the plugin-description default config.
I would polish it the others.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] EvanLjp commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
EvanLjp commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573423066
##########
File path: docs/en/guides/compile/compile.md
##########
@@ -1,7 +1,7 @@
# Compiling
## Platform
-Linux and MacOS are supported in SkyWalking Satellite. Windows is not due to following components. Please read [the doc](../../FAQ/running_on_windows.md).
+Linux and MacOS are supported in SkyWalking Satellite. Windows is not due to following components.
Review comment:
fixed
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng removed a comment on pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng removed a comment on pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#issuecomment-777150083
You should run `generate_plugin_doc.go` in the CI, and compare the diff with sources.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng commented on pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#issuecomment-775762193
These 2 links are strange, should we remove them?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] EvanLjp commented on pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
EvanLjp commented on pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#issuecomment-775802941
> You should have read OAP documentation, we need to talk about file format, then with a vocabulary to provide configuration in a clear structure. Otherwise, it is very confusing.
I see what you mean.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] nic-chen commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
nic-chen commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573493729
##########
File path: docs/en/concepts-and-designs/project-goals.md
##########
@@ -0,0 +1,16 @@
+# Design Goals
+The document outlines the core design goals for SkyWalking Satellite project.
+
+- **Light Weight**. SkyWalking Satellite has a limited cost for resources and high-performance because of the requirements of the sidecar deployment model.
+
+- **Pluggable**. SkyWalking Satellite core team provides many default implementations, but definitely it is not enough,
+and also don't fit every scenario. So, we provide a lot of features for being pluggable.
+
+- **Portability**. SkyWalking Satellite can run in multiple environments, including:
Review comment:
```suggestion
- **Portability**. SkyWalking Satellite can run in multiple environments, including:
```
##########
File path: docs/en/concepts-and-designs/README.md
##########
@@ -0,0 +1,13 @@
+# Concepts and Designs
+Concepts and Designs help you to learn and understand the SkyWalking Satellite and the landscape.
+
+- What is SkyWalking Satellite?
+ - [Overview and Core concepts](overview.md). Provides a high-level description and introduction, including the problems the project solves.
+ - [Project Goals](project-goals.md). Provides the goals, which SkyWalking Satellite is trying to focus and provide features about them.
+
+After you read the above documents, you should understand the SkyWalking basic goals. Now, you can choose which following parts
Review comment:
```suggestion
After you read the above documents, you should understand basic goals of the SkyWalking Satellite. Now, you can choose which following parts
```
##########
File path: docs/README.md
##########
@@ -0,0 +1,20 @@
+# Welcome
+**Here are SkyWalking Satellite official documentations. You're welcome to join us.**
+
+From here you can learn all about **SkyWalking Satellite's** architecture, how to deploy and use SkyWalking Satellite.
Review comment:
```suggestion
From here you can learn all about **SkyWalking Satellite's** architecture, how to deploy and use SkyWalking Satellite.
```
##########
File path: docs/en/concepts-and-designs/project-goals.md
##########
@@ -0,0 +1,16 @@
+# Design Goals
+The document outlines the core design goals for SkyWalking Satellite project.
+
+- **Light Weight**. SkyWalking Satellite has a limited cost for resources and high-performance because of the requirements of the sidecar deployment model.
+
+- **Pluggable**. SkyWalking Satellite core team provides many default implementations, but definitely it is not enough,
+and also don't fit every scenario. So, we provide a lot of features for being pluggable.
+
+- **Portability**. SkyWalking Satellite can run in multiple environments, including:
+ - Use traditional deployment as a demon process to collect data.
+ - Use cloud services as a sidecar, such as in the kubernetes platform.
+
+- **Interop**. Observability is a big landscape, SkyWalking is impossible to support all, even by its community. So SkyWalking Satellite is compatible with many protocols, including:
Review comment:
```suggestion
- **Interop**. Observability is a big landscape, SkyWalking is impossible to support all, even by its community. So SkyWalking Satellite is compatible with many protocols, including:
```
##########
File path: docs/en/concepts-and-designs/overview.md
##########
@@ -0,0 +1,22 @@
+# Overview
+SkyWalking Satellite: an open-source agent designed for the cloud-native infrastructures, which provides a low-cost, high-efficient, and more secure way to collect telemetry data, such that Trace Segments, Logs, or Metrics.
+
+
+## Why use SkyWalking Satellite?
+Observability is the solution to the complex scenario of cloud-native services. However, we may encounter different telemetry data scenarios, different language services, big data analysis, etc. Satellite provides a unified data collection layer for cloud-native services.
+You can easily use it to connect to the SkyWalking ecosystem and enhance the capacity of SkyWalking.
+There are some enhance features on the following when using Satellite.
+
+1. Provide a unified data collection layer to collect logs, traces, and metrics.
+2. Provide a safer local cache to reduce the memory cost of the service.
+3. Provide the unified transfer way shields the functional differences in the different language libs, such as MQ.
+4. Provides the preprocessing functions to ensure accuracy of the metrics, such as sampling.
+
+## Architecture
+SkyWalking Satellite is logically split into three parts: Gatherer, Processor, and Sender.
+
+<img src="https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/Satellite.png"/>
+
+- Gatherer collect data and reformat them for SkyWalking requirements.
+- Processor processes the input data to generate the new data for Observability.
Review comment:
```suggestion
- Processor processes the input data to generate the new data for Observability.
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573379056
##########
File path: docs/en/setup/README.md
##########
@@ -0,0 +1,23 @@
+# Setup
+First and most important thing is, SkyWalking Satellite startup behaviours are driven by configs/satellite_config.yaml. Understood the setting file will help you to read this document.
+
+## Startup script
+The startup script is /bin/skywalking-satellite-{version}-{plateform}-amd64.
+1. Generate docs.
+```shell script
+./bin/skywalking-satellite-{version}-{plateform}-amd64 docs --output=./docs
+```
Review comment:
Why need generate doc in the setup part?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573422128
##########
File path: docs/en/guides/compile/compile.md
##########
@@ -1,7 +1,7 @@
# Compiling
## Platform
-Linux and MacOS are supported in SkyWalking Satellite. Windows is not due to following components. Please read [the doc](../../FAQ/running_on_windows.md).
+Linux and MacOS are supported in SkyWalking Satellite. Windows is not due to following components.
Review comment:
This is the question in my mind, if memory queue is available, then satellite should be available for WIndows platform. We should be clear about that. Could you deliver the window version binary? The current idea is saying code change, which is not a good one.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] EvanLjp commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
EvanLjp commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573418689
##########
File path: docs/en/guides/compile/compile.md
##########
@@ -1,7 +1,7 @@
# Compiling
## Platform
-Linux and MacOS are supported in SkyWalking Satellite. Windows is not due to following components. Please read [the doc](../../FAQ/running_on_windows.md).
+Linux and MacOS are supported in SkyWalking Satellite. Windows is not due to following components.
Review comment:
already push a memory queue
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r574197916
##########
File path: docs/en/concepts-and-designs/project_structue.md
##########
@@ -0,0 +1,33 @@
+# Project Structure
+- cmd: The starter of Satellite.
+- configs: Satellite configs.
+- internal: Core, Api, and common utils.
Review comment:
```suggestion
- internal: Core, API, and common utils.
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng merged pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng merged pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng commented on pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#issuecomment-777150083
You should run `generate_plugin_doc.go` in the CI, and compare the diff with sources.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] EvanLjp commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
EvanLjp commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r574209429
##########
File path: docs/en/setup/README.md
##########
@@ -0,0 +1,19 @@
+# Setup
+First and most important thing is, SkyWalking Satellite startup behaviours are driven by configs/satellite_config.yaml. Understood the setting file will help you to read this document.
+
+## Startup script
+The startup script is /bin/skywalking-satellite-{version}-{plateform}-amd64.
+1. Start SkyWalking Satellite.
+```shell script
+./bin/skywalking-satellite-{version}-{plateform}-amd64 start --config=./configs/satellite_config.yaml
Review comment:
please ignore it, would add the start script and polish configuration file in another PR for release.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng commented on pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#issuecomment-777150310
Others generally good to me. The documentation is better now.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] EvanLjp commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
EvanLjp commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573380319
##########
File path: docs/en/setup/README.md
##########
@@ -0,0 +1,23 @@
+# Setup
+First and most important thing is, SkyWalking Satellite startup behaviours are driven by configs/satellite_config.yaml. Understood the setting file will help you to read this document.
+
+## Startup script
+The startup script is /bin/skywalking-satellite-{version}-{plateform}-amd64.
+1. Generate docs.
+```shell script
+./bin/skywalking-satellite-{version}-{plateform}-amd64 docs --output=./docs
+```
Review comment:
just descripe the supported command
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] EvanLjp commented on pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
EvanLjp commented on pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#issuecomment-775768884
> 
>
> These 2 links are strange, should we remove them?
fixed
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] EvanLjp commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
EvanLjp commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573381078
##########
File path: README.md
##########
@@ -8,16 +8,22 @@ Apache SkyWalking Satellite
[](https://github.com/apache/skywalking)
[](https://twitter.com/AsfSkyWalking)
-# Quick Start
-
# Documentation
-- [The first design of Satellite 0.1.0](https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/)
-- [The project structure](./docs/project_structue.md)
+- [Official documentation](https://skywalking.apache.org/docs/)
+- [Blog](https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/) about the design of Satellite 0.1.0.
+
+NOTICE, SkyWalking Satellite uses [v3 protocols](https://github.com/apache/skywalking/blob/master/docs/en/protocols/README.md). They are incompatible with previous SkyWalking releases before SkyWalking 8.0.
# Download
+Go to the [download page](https://skywalking.apache.org/downloads/) to download all available binaries, including MacOS and Linux.
+If you want to try the latest features or run on the Windows, however, you can compile the latest codes yourself, as the guide below.
# Compile
-[How to compile the Satellite.](./docs/compile/compile.md)
+As SkyWalking Satellite is using `Makefile`, compiling the project is as easy as executing a command in the root directory of the project.
+```shell script
+make build
+```
+Due to system compatibility problems, some plugins of SkyWalking Satellite cannot be used in Windows system. If you need to compile SkyWalking Satellite on Windows platform, please read [the doc](docs/en/guides/compile/compile.md).
Review comment:
platform means the supported platform，however，it not works. It only works when append windows to the build
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r572692327
##########
File path: docs/en/guides/compile/compile.md
##########
@@ -1,10 +1,12 @@
# Compile
Review comment:
Compile -> Compiling
Don't use a verb in the document.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] EvanLjp commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
EvanLjp commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573435095
##########
File path: docs/en/guides/compile/compile.md
##########
@@ -1,7 +1,7 @@
# Compiling
## Platform
-Linux and MacOS are supported in SkyWalking Satellite. Windows is not due to following components. Please read [the doc](../../FAQ/running_on_windows.md).
+Linux and MacOS are supported in SkyWalking Satellite. Windows is not due to following components.
Review comment:
zhenxu help me to unify the compile at all platforms. Thanks a lot.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r572692984
##########
File path: docs/en/guides/compile/compile.md
##########
@@ -1,10 +1,12 @@
# Compile
-## command
-```
-make build
-```
-## platform
-Linux and MacOs is supported in SkyWalking Satellite. Windows is not good supported beacuse some features is not adaptive on the Windows, such as the mmap feature.
+
+## Platform
+Linux and MacOs is supported in SkyWalking Satellite. Windows is not good supported beacuse some features is not adaptive on the Windows, such as the mmap feature. If you want to run it on the windows platform, please read [the doc](../../FAQ/running_on_windows.md).
The Windows platform does not support plugins list:
Review comment:
```suggestion
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng commented on pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#issuecomment-776538382
Please add MacOS and Windows platform in the CI processes, https://github.com/apache/skywalking-satellite/blob/main/.github/workflows/build-and-test.yaml#L27
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] EvanLjp commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
EvanLjp commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r574209429
##########
File path: docs/en/setup/README.md
##########
@@ -0,0 +1,19 @@
+# Setup
+First and most important thing is, SkyWalking Satellite startup behaviours are driven by configs/satellite_config.yaml. Understood the setting file will help you to read this document.
+
+## Startup script
+The startup script is /bin/skywalking-satellite-{version}-{plateform}-amd64.
+1. Start SkyWalking Satellite.
+```shell script
+./bin/skywalking-satellite-{version}-{plateform}-amd64 start --config=./configs/satellite_config.yaml
Review comment:
please ignore it, would add the start script in another PR for release.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r572700202
##########
File path: docs/en/guides/README.md
##########
@@ -0,0 +1,6 @@
+# Guides
+If you want to debug or develop SkyWalking Satellite, The following documentations would guide you.
+
+- [How to contribute the plugins?](./contribuation/plugin.md)
+- [How to add unit test in the plugins?](./test/test.md)
+- [How to compile SkyWalking Satellite?](./compile/compile.md)
Review comment:
```suggestion
- [How to contribute a plugin?](./contribuation/plugin.md)
- [How to add unit test for a plugin?](./test/test.md)
- [How to compile SkyWalking Satellite?](./compile/compile.md)
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] EvanLjp commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
EvanLjp commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573418689
##########
File path: docs/en/guides/compile/compile.md
##########
@@ -1,7 +1,7 @@
# Compiling
## Platform
-Linux and MacOS are supported in SkyWalking Satellite. Windows is not due to following components. Please read [the doc](../../FAQ/running_on_windows.md).
+Linux and MacOS are supported in SkyWalking Satellite. Windows is not due to following components.
Review comment:
already push a memory queue
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] kezhenxu94 commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
kezhenxu94 commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573403179
##########
File path: docs/en/FAQ/README.md
##########
@@ -0,0 +1,3 @@
+## FAQ
+
+1. [How do we run Satellite on Windows?](./running_on_windows.md)
Review comment:
Having an individual doc for building Windows is troublesome, please review https://github.com/apache/skywalking-satellite/pull/24 and rework this part base on that
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] kezhenxu94 commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
kezhenxu94 commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573426300
##########
File path: README.md
##########
@@ -8,16 +8,34 @@ Apache SkyWalking Satellite
[](https://github.com/apache/skywalking)
[](https://twitter.com/AsfSkyWalking)
-# Quick Start
-
# Documentation
-- [The first design of Satellite 0.1.0](https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/)
-- [The project structure](./docs/project_structue.md)
+- [Official documentation](https://skywalking.apache.org/docs/)
+- [Blog](https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/) about the design of Satellite 0.1.0.
+
+NOTICE, SkyWalking Satellite uses [v3 protocols](https://github.com/apache/skywalking/blob/master/docs/en/protocols/README.md). They are incompatible with previous SkyWalking releases before SkyWalking 8.0.
# Download
+Go to the [download page](https://skywalking.apache.org/downloads/) to download all available binaries, including MacOS and Linux.
+If you want to try the latest features or run on the Windows, however, you can compile the latest codes yourself, as the guide below.
# Compile
-[How to compile the Satellite.](./docs/compile/compile.md)
+As SkyWalking Satellite is using `Makefile`, compiling the project is as easy as executing a command in the root directory of the project.
+```shell script
+git clone https://github.com/apache/skywalking-satellite
+cd skywalking-satellite
+git submodule init
+git submodule update
+make build
+```
+Due to system compatibility problems, some plugins of SkyWalking Satellite cannot be used in Windows system. If you need to compile SkyWalking Satellite on Windows platform, please read [the doc](docs/en/guides/compile/compile.md).
Review comment:
```suggestion
Due to system compatibility problems, some plugins of SkyWalking Satellite cannot be used in Windows system. Check the corresponding documentation to see whether the plugin is available on Windows.
```
##########
File path: README.md
##########
@@ -8,16 +8,34 @@ Apache SkyWalking Satellite
[](https://github.com/apache/skywalking)
[](https://twitter.com/AsfSkyWalking)
-# Quick Start
-
# Documentation
-- [The first design of Satellite 0.1.0](https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/)
-- [The project structure](./docs/project_structue.md)
+- [Official documentation](https://skywalking.apache.org/docs/)
+- [Blog](https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/) about the design of Satellite 0.1.0.
+
+NOTICE, SkyWalking Satellite uses [v3 protocols](https://github.com/apache/skywalking/blob/master/docs/en/protocols/README.md). They are incompatible with previous SkyWalking releases before SkyWalking 8.0.
# Download
+Go to the [download page](https://skywalking.apache.org/downloads/) to download all available binaries, including MacOS and Linux.
+If you want to try the latest features or run on the Windows, however, you can compile the latest codes yourself, as the guide below.
Review comment:
Should be reworded, we will deliver a Windows binary, right?
##########
File path: docs/en/setup/plugins/queue_mmap-queue.md
##########
@@ -0,0 +1,20 @@
+# Queue/mmap-queue
+## Description
+this is a memory mapped queue to provide the persistent storage.
+## DefaultConfig
Review comment:
You should indicate the Windows compatibility here
##########
File path: docs/en/setup/plugins/queue_mmap-queue.md
##########
@@ -0,0 +1,20 @@
+# Queue/mmap-queue
+## Description
+this is a memory mapped queue to provide the persistent storage.
Review comment:
The description (and other plugins') should be capitalized.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] EvanLjp commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
EvanLjp commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573381526
##########
File path: docs/en/setup/README.md
##########
@@ -0,0 +1,23 @@
+# Setup
+First and most important thing is, SkyWalking Satellite startup behaviours are driven by configs/satellite_config.yaml. Understood the setting file will help you to read this document.
+
+## Startup script
+The startup script is /bin/skywalking-satellite-{version}-{plateform}-amd64.
+1. Generate docs.
+```shell script
+./bin/skywalking-satellite-{version}-{plateform}-amd64 docs --output=./docs
+```
Review comment:
maybe should move it to the other part
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng commented on pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#issuecomment-775802200
You should have read OAP documentation, we need to talk about file format, then with a vocabulary to provide configuration in a clear structure. Otherwise, it is very confusing.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] kezhenxu94 commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
kezhenxu94 commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r572700895
##########
File path: docs/en/FAQ/running_on_windows.md
##########
@@ -0,0 +1,29 @@
+# How do we run Satellite on Windows?
+
+Windows is not good supported beacuse [some features](../guides/compile/compile.md) is not adaptive on the Windows. Let's take the mmap component as an example to talk how to solve the problem.
Review comment:
```suggestion
Windows is not good supported because [some features](../guides/compile/compile.md) is not adaptive on the Windows. Let's take the mmap component as an example to talk how to solve the problem.
```
##########
File path: docs/en/concepts-and-designs/project-goals.md
##########
@@ -0,0 +1,16 @@
+# Design Goals
+The document outlines the core design goals for SkyWalking Satellite project.
+
+- **Light Weight**. SkyWalking Satellite has a limited cost for resources and high-performance because of the requirements of the sidecar deployment model.
+
+- **Pluggable**. SkyWalking Satellite core team provides many default implementations, but definitely it is not enough,
+and also don't fit every scenario. So, we provide a lot of features for being pluggable.
+
+- **Portability**. SkyWalking Satellite can run in multiple environments, including:
+ - Use traditional deployment as a demon process to collect data.
+ - Use cloud services as a sidecar, such as in the kubernetes platform.
+
+- **Interop**. Observability is a big landscape, SkyWalking is impossible to support all, even by its community. So Skywalking Satellite is compatible with many protocols, including:
Review comment:
```suggestion
- **Interop**. Observability is a big landscape, SkyWalking is impossible to support all, even by its community. So SkyWalking Satellite is compatible with many protocols, including:
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] nic-chen commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
nic-chen commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r572843634
##########
File path: docs/README.md
##########
@@ -0,0 +1,19 @@
+# Welcome
+**Here are SkyWalking Satellite official documentations. You're welcome to join us.**
+
+From here you can learn all about **SkyWalking Satellite's** architecture, how to deploy and use SkyWalking Satellite.
+
+- [Concepts and Designs](en/concepts-and-designs/README.md). You'll find the most important core ideas about SkyWalking Satellite. You can learn from here if you want to understand what is going on under our cool features.
+- [Plugins description](en/plugins/plugin-description.md). You'll find the descriptions and the configurations of the whole plugins.
Review comment:
```suggestion
- [Plugins description](en/plugins/plugin-description.md). You'll find the descriptions and the configurations of all plugins.
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] nic-chen commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
nic-chen commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r572844437
##########
File path: docs/README.md
##########
@@ -0,0 +1,19 @@
+# Welcome
+**Here are SkyWalking Satellite official documentations. You're welcome to join us.**
+
+From here you can learn all about **SkyWalking Satellite's** architecture, how to deploy and use SkyWalking Satellite.
+
+- [Concepts and Designs](en/concepts-and-designs/README.md). You'll find the most important core ideas about SkyWalking Satellite. You can learn from here if you want to understand what is going on under our cool features.
+- [Plugins description](en/plugins/plugin-description.md). You'll find the descriptions and the configurations of the whole plugins.
+- [Guides](en/guides/README.md). You'll find how to develop or debug SkyWalking Satellite guides.
Review comment:
```suggestion
- [Guides](en/guides/README.md). You'll find guides about how to develop or debug SkyWalking Satellite.
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r572692840
##########
File path: docs/en/guides/compile/compile.md
##########
@@ -1,10 +1,12 @@
# Compile
-## command
-```
-make build
-```
-## platform
-Linux and MacOs is supported in SkyWalking Satellite. Windows is not good supported beacuse some features is not adaptive on the Windows, such as the mmap feature.
+
+## Platform
+Linux and MacOs is supported in SkyWalking Satellite. Windows is not good supported beacuse some features is not adaptive on the Windows, such as the mmap feature. If you want to run it on the windows platform, please read [the doc](../../FAQ/running_on_windows.md).
Review comment:
```suggestion
Linux and MacOS are supported in SkyWalking Satellite. Windows is not due to following components please read [the doc](../../FAQ/running_on_windows.md).
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] wu-sheng commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573364070
##########
File path: README.md
##########
@@ -8,16 +8,22 @@ Apache SkyWalking Satellite
[](https://github.com/apache/skywalking)
[](https://twitter.com/AsfSkyWalking)
-# Quick Start
-
# Documentation
-- [The first design of Satellite 0.1.0](https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/)
-- [The project structure](./docs/project_structue.md)
+- [Official documentation](https://skywalking.apache.org/docs/)
+- [Blog](https://skywalking.apache.org/blog/2020-11-25-skywalking-satellite-0.1.0-design/) about the design of Satellite 0.1.0.
+
+NOTICE, SkyWalking Satellite uses [v3 protocols](https://github.com/apache/skywalking/blob/master/docs/en/protocols/README.md). They are incompatible with previous SkyWalking releases before SkyWalking 8.0.
# Download
+Go to the [download page](https://skywalking.apache.org/downloads/) to download all available binaries, including MacOS and Linux.
+If you want to try the latest features or run on the Windows, however, you can compile the latest codes yourself, as the guide below.
# Compile
-[How to compile the Satellite.](./docs/compile/compile.md)
+As SkyWalking Satellite is using `Makefile`, compiling the project is as easy as executing a command in the root directory of the project.
+```shell script
+make build
+```
+Due to system compatibility problems, some plugins of SkyWalking Satellite cannot be used in Windows system. If you need to compile SkyWalking Satellite on Windows platform, please read [the doc](docs/en/guides/compile/compile.md).
Review comment:
I can see `Windows` is your makefile, what do you mean ?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] kezhenxu94 commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
kezhenxu94 commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573418094
##########
File path: docs/en/guides/compile/compile.md
##########
@@ -1,7 +1,7 @@
# Compiling
## Platform
-Linux and MacOS are supported in SkyWalking Satellite. Windows is not due to following components. Please read [the doc](../../FAQ/running_on_windows.md).
+Linux and MacOS are supported in SkyWalking Satellite. Windows is not due to following components.
Review comment:
Is Windows unsupported anyway, or do we have a fallback queue implementation on Windows? For example, users can try it on Windows with `memory-queue`?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-satellite] kezhenxu94 commented on a change in pull request #23: polish docs
Posted by GitBox <gi...@apache.org>.
kezhenxu94 commented on a change in pull request #23:
URL: https://github.com/apache/skywalking-satellite/pull/23#discussion_r573420099
##########
File path: docs/en/guides/compile/compile.md
##########
@@ -1,7 +1,7 @@
# Compiling
## Platform
-Linux and MacOS are supported in SkyWalking Satellite. Windows is not due to following components. Please read [the doc](../../FAQ/running_on_windows.md).
+Linux and MacOS are supported in SkyWalking Satellite. Windows is not due to following components.
Review comment:
> already push a memory queue
I know that, I mean we cannot simply say "Windows is not due to following components.", `mmap-queue` is only a component in Satellite, users can still try / use Satellite if they configure another component (like `memory-queue`), the unavailability is component level and should be documented in that specific component, i.e. document "This component is not available on Windows" in [the `mmap-queue` plugin doc](https://github.com/apache/skywalking-satellite/blob/main/docs/plugins/queue/mmap/README.md), instead of here, "compile" doc.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org