kazusa
/
skywalking-java
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #679 from apache/apache/readme_update 

Update readme and remove the annoucement
This commit is contained in:
吴晟 Wu Sheng 2017-12-15 10:03:22 +08:00 committed by GitHub
parent 60a8390fef 14c4734f58
commit 3a418a41f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 38 additions and 125 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,15 +1,12 @@
Sky Walking | [中文](README_ZH.md)
Apache SkyWalking | [中文](README_ZH.md)
==========
# Announcement:
## SkyWalking has been accepted as an incubator project by Apache Foundation. All pull requests can't be accepted until Apache/SkyWalking repository established.
<img src="https://skywalkingtest.github.io/page-resources/3.0/skywalking.png" alt="Sky Walking logo" height="90px" align="right" />
**SkyWalking 3**: APM for Distributed Systems, also known Distributed Tracing System.
**SkyWalking**: APM for Distributed Systems, also known Distributed Tracing System.
[![Build Status](https://travis-ci.org/OpenSkywalking/skywalking.svg?branch=master)](https://travis-ci.org/OpenSkywalking/skywalking)
[![Coverage Status](https://coveralls.io/repos/github/OpenSkywalking/skywalking/badge.svg?branch=master&forceUpdate=3)](https://coveralls.io/github/OpenSkywalking/skywalking?branch=master)
[![Build Status](https://travis-ci.org/apache/incubator-skywalking.svg?branch=master)](https://travis-ci.org/apache/incubator-skywalking)
[![Coverage Status](https://coveralls.io/repos/github/apache/incubator-skywalking/badge.svg?branch=master&u=1)](https://coveralls.io/github/apache/incubator-skywalking?branch=master)
[![Join the chat at https://gitter.im/sky-walking/Lobby](https://badges.gitter.im/openskywalking/Lobby.svg)](https://gitter.im/openskywalking/Lobby)
[![OpenTracing-1.x Badge](https://img.shields.io/badge/OpenTracing--1.x-enabled-blue.svg)](http://opentracing.io)
@ -21,7 +18,7 @@ Sky Walking | [中文](README_ZH.md)
* Use **@Trace** annotation for any methods you want to trace.
* Integrate traceId into logs for log4j, log4j2 and logback.
* Pure Java server implementation, provide RESTful and gRPC services. Compatibility with other language agents/SDKs.
* The UI released on [skywalking-ui](https://github.com/OpenSkywalking/sky-walking-ui)
* The UI released on [skywalking-ui](https://github.com/apache/incubator-skywalking-ui)
# Architecture
* Architecture graph for 3.2.5+
@ -60,14 +57,7 @@ This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDU
# Contact Us
* Submit an issue
* [Gitter](https://gitter.im/openskywalking/Lobby)
* [Google Mailing List](https://groups.google.com/forum/#!forum/skywalking-distributed-tracing-and-apm)
* QQ Group: 392443393
# Open Skywalking Organization
[Open Skywalking Organization Teams and Contributors](https://github.com/OpenSkywalking/Organization/blob/master/README.md)
# Partners
<img src="https://skywalkingtest.github.io/page-resources/3.2.4/partners.png" width="800"/>
# License
[Apache 2.0 License.](/LICENSE)

17
README_ZH.md
View File

@ -1,12 +1,12 @@
Sky Walking | [English](README.md)
Apache SkyWalking | [English](README.md)
==========
<img src="https://skywalkingtest.github.io/page-resources/3.0/skywalking.png" alt="Sky Walking logo" height="90px" align="right" />
**SkyWalking 3**: 针对分布式系统的APM系统，也被称为分布式追踪系统
**SkyWalking**: 针对分布式系统的APM系统，也被称为分布式追踪系统
[![Build Status](https://travis-ci.org/OpenSkywalking/skywalking.svg?branch=master)](https://travis-ci.org/OpenSkywalking/skywalking)
[![Coverage Status](https://coveralls.io/repos/github/OpenSkywalking/skywalking/badge.svg?branch=master&forceUpdate=3)](https://coveralls.io/github/OpenSkywalking/skywalking?branch=master)
[![Build Status](https://travis-ci.org/apache/incubator-skywalking.svg?branch=master)](https://travis-ci.org/apache/incubator-skywalking)
[![Coverage Status](https://coveralls.io/repos/github/apache/incubator-skywalking/badge.svg?branch=master&u=1)](https://coveralls.io/github/apache/incubator-skywalking?branch=master)
[![Join the chat at https://gitter.im/openskywalking/Lobby](https://badges.gitter.im/openskywalking/Lobby.svg)](https://gitter.im/openskywalking/Lobby)
[![OpenTracing-1.x Badge](https://img.shields.io/badge/OpenTracing--1.x-enabled-blue.svg)](http://opentracing.io)
@ -20,7 +20,7 @@ Sky Walking | [English](README.md)
* 将 traceId 集成到 log4j, log4j2 或 logback这些日志组件中
* 纯Java后端Collector实现，提供RESTful和gRPC接口。兼容接受其他语言探针发送数据
* [如何将探针的Metric和Trace数据上传到Collector？](/docs/cn/How-to-communicate-with-the-collector-CN.md)
* UI工程请查看 [skywalking-ui](https://github.com/OpenSkywalking/skywalking-ui)
* UI工程请查看 [skywalking-ui](https://github.com/apache/incubator-skywalking-ui)
* 中文QQ群：392443393
# Architecture
@ -61,14 +61,7 @@ This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDU
# Contact Us
* 直接提交Issue
* [Gitter](https://gitter.im/openskywalking/Lobby)
* [Google Mailing List](https://groups.google.com/forum/#!forum/skywalking-distributed-tracing-and-apm)
* QQ群: 392443393
# Open Skywalking Organization
[Open Skywalking Organization Teams and Contributors](https://github.com/OpenSkywalking/Organization/blob/master/README.md)
# Partners
<img src="https://skywalkingtest.github.io/page-resources/3.2.4/partners.png" width="800"/>
# License
[Apache 2.0 License.](/LICENSE)

19
apm-collector/apm-collector-baseline/collector-baseline-computing-define/src/main/resources/services/org.skywalking.apm.collector.core.module.Module
View File

@ -1,19 +1,2 @@
#
# Copyright 2017, OpenSkywalking Organization All rights reserved.
#
# 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.
#
# Project repository: https://github.com/OpenSkywalking/skywalking
#
ComputingModule
org.apache.skywalking.apm.collector.baseline.computing.ComputingModule

14
apm-collector/apm-collector-baseline/collector-baseline-computing-provider/src/main/resources/services/org.skywalking.apm.collector.core.module.ModuleProvider
View File

@ -1,9 +1,10 @@
#
# Copyright 2017, OpenSkywalking Organization All rights reserved.
#
# 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
# 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
#
@ -13,7 +14,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Project repository: https://github.com/OpenSkywalking/skywalking
#
ComputingProvider
org.apache.skywalking.collector.baseline.computing.provider.ComputingProvider

53
apm-sniffer/apm-agent-core/src/main/resources/META-INF/services/org.apache.skywalking.apm.agent.core.boot.BootService
View File

@ -16,59 +16,6 @@
#
#
#
# Copyright 2017, OpenSkywalking Organization All rights reserved.
#
# 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.
#
# Repositories: https://github.com/OpenSkywalking/skywalking
#
#
# Copyright 2017, Skywalking Authors All rights reserved.
#
# 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.
#
#
# /*
# * Copyright 2017, Skywalking Authors All rights reserved.
# *
# * 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.
# */
#
org.apache.skywalking.apm.agent.core.remote.TraceSegmentServiceClient
org.apache.skywalking.apm.agent.core.context.ContextManager
org.apache.skywalking.apm.agent.core.remote.CollectorDiscoveryService

2
docs/cn/Deploy-collector-in-cluster-mode-CN.md
View File

@ -5,7 +5,7 @@
- Zookeeper 3.4.10
## 下载发布版本
- 前向[发布页面](https://github.com/OpenSkywalking/skywalking/releases)
- 前向[发布页面](https://github.com/apache/incubator-skywalking/releases)
## 部署Elasticsearch
- 修改`elasticsearch.yml`文件

2
docs/cn/Deploy-collector-in-standalone-mode-CN.md
View File

@ -5,7 +5,7 @@
- JDK8+
## 下载发布版本
- 前向[发布页面](https://github.com/OpenSkywalking/skywalking/releases)
- 前向[发布页面](https://github.com/apache/incubator-skywalking/releases)
## Quick Start
Collector单机模拟启动简单，提供和集群模式相同的功能，单机模式下除端口被占用的情况下，直接启动即可。

2
docs/cn/Deploy-docker-image-CN.md
View File

@ -1,4 +1,4 @@
- [下载Source code](https://github.com/OpenSkywalking/skywalking/releases)并解压，进入解压目录，执行以下命令：
- [下载Source code](https://github.com/apache/incubator-skywalking/releases)并解压，进入解压目录，执行以下命令：
```shell
> docker-compose pull

2
docs/cn/Deploy-skywalking-agent-CN.md
View File

@ -1,5 +1,5 @@
## 下载skywalking探针发布版本
- 前向[发布页面](https://github.com/OpenSkywalking/skywalking/releases)
- 前向[发布页面](https://github.com/apache/incubator-skywalking/releases)
## 部署探针
1. 拷贝skywalking-agent目录到所需位置，探针包含整个目录，请不要改变目录结构

16
docs/cn/How-to-communicate-with-the-collector-CN.md
View File

@ -33,7 +33,7 @@ JSON数组，数组的每个元素，为一个有效的gRPC服务地址。
gRPC服务
### 协议内容
https://github.com/OpenSkywalking/skywalking/blob/master/apm-network/src/main/proto/ApplicationRegisterService.proto
https://github.com/apache/incubator-skywalking/blob/master/apm-network/src/main/proto/ApplicationRegisterService.proto
```proto
syntax = "proto3";
@ -71,7 +71,7 @@ message ApplicationMapping {
gRPC服务
### 实例注册服务
https://github.com/OpenSkywalking/skywalking/blob/master/apm-network/src/main/proto/DiscoveryService.proto#L11-L12
https://github.com/apache/incubator-skywalking/blob/master/apm-network/src/main/proto/DiscoveryService.proto#L11-L12
```proto
service InstanceDiscoveryService {
rpc register (ApplicationInstance) returns (ApplicationInstanceMapping) {
@ -102,7 +102,7 @@ message ApplicationInstanceMapping {
- 服务端返回应用实例id，applicationInstanceId 。后续上报服务使用实例id标识。
### 实例心跳服务
https://github.com/OpenSkywalking/skywalking/blob/master/apm-network/src/main/proto/DiscoveryService.proto#L14-L15
https://github.com/apache/incubator-skywalking/blob/master/apm-network/src/main/proto/DiscoveryService.proto#L14-L15
```proto
service InstanceDiscoveryService {
rpc heartbeat (ApplicationInstanceHeartbeat) returns (Downstream) {
@ -118,7 +118,7 @@ message ApplicationInstanceHeartbeat {
- 如一分钟内有segment数据上报，则可不必上报心跳。
### 实例注册重连服务
https://github.com/OpenSkywalking/skywalking/blob/master/apm-network/src/main/proto/DiscoveryService.proto#L17-L18
https://github.com/apache/incubator-skywalking/blob/master/apm-network/src/main/proto/DiscoveryService.proto#L17-L18
```proto
service InstanceDiscoveryService {
rpc registerRecover (ApplicationInstanceRecover) returns (Downstream) {
@ -142,7 +142,7 @@ message ApplicationInstanceRecover {
gRPC服务
### 协议内容
https://github.com/OpenSkywalking/skywalking/blob/master/apm-network/src/main/proto/DiscoveryService.proto#L53-L74
https://github.com/apache/incubator-skywalking/blob/master/apm-network/src/main/proto/DiscoveryService.proto#L53-L74
```proto
//discovery service for ServiceName by Network address or application code
service ServiceNameDiscoveryService {
@ -179,7 +179,7 @@ message ServiceNameElement {
gRPC服务
### 协议内容
https://github.com/OpenSkywalking/skywalking/blob/master/apm-network/src/main/proto/JVMMetricsService.proto
https://github.com/apache/incubator-skywalking/blob/master/apm-network/src/main/proto/JVMMetricsService.proto
```proto
syntax = "proto3";
@ -342,11 +342,11 @@ message LogMessage {
}
```
- UniqueId为segment或者globalTraceId的数字表示。由3个long组成，1）applicationInstanceId，2）当前线程id，3）当前时间戳*10000 + seq(0-10000自循环)
- Span的数据，请参考[插件开发规范](https://github.com/OpenSkywalking/skywalking/wiki/Plugin-Development-Guide)
- Span的数据，请参考[插件开发规范](https://github.com/apache/incubator-skywalking/wiki/Plugin-Development-Guide)
- 以下id和名称根据注册返回结果，优先上报id，无法获取id时，再上传name。参考之前的应用和服务注册章节。
- operationNameId/operationName
- networkAddress/networkAddressId
- entryServiceName/entryServiceId
- parentServiceName/parentServiceId
- peerId/peer
- componentId为默认支持的插件id，非官方支持，需传输名称或修改服务端源代码。[官方组件列表](https://github.com/OpenSkywalking/skywalking/blob/master/apm-network/src/main/java/org.apache.skywalking.apm/network/trace/component/ComponentsDefine.java)
- componentId为默认支持的插件id，非官方支持，需传输名称或修改服务端源代码。[官方组件列表](https://github.com/apache/incubator-skywalking/blob/master/apm-network/src/main/java/org.apache.skywalking.apm/network/trace/component/ComponentsDefine.java)

2
docs/cn/Quick-start-CN.md
View File

@ -2,6 +2,6 @@
1. 部署 Collector
1. [单机模式](Deploy-collector-in-standalone-mode-CN.md)
1. [集群模式](Deploy-collector-in-cluster-mode-CN.md)
1. 部署 webui server, [doc](https://github.com/OpenSkywalking/skywalking-ui#quickstart)
1. 部署 webui server, [doc](https://github.com/apache/incubator-skywalking-ui#quickstart)
1. 部署 Java Agent，[doc](Deploy-skywalking-agent-CN.md)
1. 重启并访问系统功能，查看UI即可。

2
docs/en/Deploy-collector-in-cluster-mode.md
View File

@ -5,7 +5,7 @@
- Zookeeper 3.4.10
## Download released version
- Go to [released page](https://github.com/OpenSkywalking/skywalking/releases)
- Go to [released page](https://github.com/apache/incubator-skywalking/releases)
## Deploy Elasticsearch server
- Modify `elasticsearch.yml`

2
docs/en/Deploy-collector-in-standalone-mode.md
View File

@ -7,7 +7,7 @@ If you are using skywalking in a low throughputs monitoring scenario, and don't
* JDK 8+
## Download
* [Releases](https://github.com/OpenSkywalking/skywalking/releases)
* [Releases](https://github.com/apache/incubator-skywalking/releases)
## Quick start
You can simplely tar/unzip and startup if ports 10800, 11800, 12800 are free.

2
docs/en/Deploy-docker-image.md
View File

@ -1,4 +1,4 @@
- [Download source code](https://github.com/OpenSkywalking/skywalking/releases) and unzip source package. Execute following command under the unzipped directory.
- [Download source code](https://github.com/apache/incubator-skywalking/releases) and unzip source package. Execute following command under the unzipped directory.
```shell
> docker-compose pull

2
docs/en/Quick-start.md
View File

@ -2,6 +2,6 @@
1. Deploy Collector
1. [Standalone Mode](Deploy-collector-in-standalone-mode.md)
1. [Cluster Mode](Deploy-collector-in-cluster-mode.md)
1. Deploy webui server, [doc](https://github.com/OpenSkywalking/skywalking-ui#quickstart)
1. Deploy webui server, [doc](https://github.com/apache/incubator-skywalking-ui#quickstart)
1. Doploy Java Agent，[doc](Deploy-skywalking-agent.md)
1. Reboot your applications, and open UI.

6
pom.xml
View File

@ -61,11 +61,11 @@
<packaging>pom</packaging>
<name>apm</name>
<url>https://github.com/OpenSkywalking/skywalking</url>
<url>https://github.com/apache/incubator-skywalking</url>
<issueManagement>
<system>GitHub</system>
<url>https://github.com/OpenSkywalking/skywalking/issues</url>
<url>https://github.com/apache/incubator-skywalking/issues</url>
</issueManagement>
<ciManagement>
@ -270,7 +270,7 @@
<artifactId>coveralls-maven-plugin</artifactId>
<version>4.1.0</version>
<configuration>
<repoToken>lSwNTzlZBFIz3fmFntWGtc6BUwgU7dlms</repoToken>
<repoToken>xFwR2GqmxcMxV7tGEpW2NfwIrbCD4cQCS</repoToken>
<sourceDirectories>
<sourceDirectory>${project.build.sourceDirectory}</sourceDirectory>
</sourceDirectories>