Update readme for beta release. (#1191)
* New english readme. * New chinese readme.
This commit is contained in:
parent
04579a5617
commit
c7b26dfea9
39
README.md
39
README.md
|
|
@ -5,7 +5,6 @@ Apache SkyWalking | [中文](README_ZH.md)
|
|||
|
||||
**SkyWalking**: APM (application performance monitor) tool for distributed systems, especially designed for
|
||||
microservices, cloud native and container-based (Docker, Kubernetes, Mesos) architectures.
|
||||
Underlying technology is a distributed tracing system.
|
||||
|
||||
[](https://github.com/apache/incubator-skywalking)
|
||||
[](https://twitter.com/AsfSkyWalking)
|
||||
|
|
@ -16,19 +15,35 @@ Underlying technology is a distributed tracing system.
|
|||
[](https://gitter.im/openskywalking/Lobby)
|
||||
[](http://opentracing.io)
|
||||
|
||||
* Provide Java agent, **no need to CHANGE any application source code**.
|
||||
* High performance agent.
|
||||
* [Supported middlewares, frameworks and libraries](docs/Supported-list.md).
|
||||
* Manual instrumentation
|
||||
* As an [OpenTracing supported tracer](http://opentracing.io/documentation/pages/supported-tracers)
|
||||
* 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.
|
||||
* Community Agents/SDKs
|
||||
* [.NET Core](https://github.com/OpenSkywalking/skywalking-netcore)
|
||||
# Abstract
|
||||
**SkyWalking** started as a distributed system in 2015. From 5.x, it evolved to the fully functional [Application Performance Management](https://en.wikipedia.org/wiki/Application_performance_management)
|
||||
system. It is used for tracing, monitoring, diagnose distributed systems, especially based on microservices, cloud native and container,
|
||||
including:
|
||||
- Distributed tracing and context propagation
|
||||
- Application, instance, service metrics analysis
|
||||
- Root cause analysis
|
||||
- Application topology map analysis
|
||||
- Application and service dependency analysis
|
||||
- Slow service detected
|
||||
- Performance optimization
|
||||
|
||||
# Core features
|
||||
- Multiple languages instrumentation agent or libraries
|
||||
- Native Java auto instrumentation agent. Trace and monitor your cluster without changing any source codes
|
||||
- Community instrumentation agent or libraries
|
||||
* [.NET Core](https://github.com/OpenSkywalking/skywalking-netcore)
|
||||
* [Node.js](https://github.com/OpenSkywalking/skywalking-nodejs)
|
||||
- Multiple storage backends: ElasticSearch, H2
|
||||
- [OpenTracing](http://opentracing.io/) compatible
|
||||
- Native Java auto instrumentation agent could work with OpenTracing APIs in the same context
|
||||
- Lightweight and powerful backend aggregation and analysis capabilities
|
||||
- Modern and cool Web UI
|
||||
- Log integration
|
||||
- Alarm for slow or unstable(low SLA) application, instance and service
|
||||
|
||||
# Document
|
||||
[](docs/README.md) [](docs/README_ZH.md)
|
||||
- [Documents in English](docs/README.md)
|
||||
- [Documents in Chinese](docs/README_ZH.md)
|
||||
|
||||
# 5.x Architecture
|
||||
<img src="https://skywalkingtest.github.io/page-resources/5.0/architecture.png"/>
|
||||
|
|
|
|||
40
README_ZH.md
40
README_ZH.md
|
|
@ -3,8 +3,7 @@ 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**: 针对分布式系统的APM(应用性能监控)系统,特别针对微服务、cloud native和容器化(Docker, Kubernetes, Mesos)架构,
|
||||
其核心是个分布式追踪系统。
|
||||
**SkyWalking**: 针对分布式系统的APM(应用性能监控)系统,特别针对微服务、cloud native和容器化(Docker, Kubernetes, Mesos)架构
|
||||
|
||||
[](https://github.com/apache/incubator-skywalking)
|
||||
[](https://twitter.com/AsfSkyWalking)
|
||||
|
|
@ -15,21 +14,34 @@ Apache SkyWalking | [English](README.md)
|
|||
[](https://gitter.im/openskywalking/Lobby)
|
||||
[](http://opentracing.io)
|
||||
|
||||
# Abstract
|
||||
**SkyWalking** 创建与2015年,提供分布式追踪功能。从5.x开始,项目进化为一个完成功能的[Application Performance Management](https://en.wikipedia.org/wiki/Application_performance_management)系统。
|
||||
他被用于追踪、监控和诊断分布式系统,特别是使用微服务架构,云原生或容积技术。提供以下主要功能:
|
||||
- 分布式追踪和上下文传输
|
||||
- 应用、实例、服务性能指标分析
|
||||
- 根源分析
|
||||
- 应用拓扑分析
|
||||
- 应用和服务依赖分析
|
||||
- 慢服务检测
|
||||
- 性能优化
|
||||
|
||||
- Java自动探针,**不需要修改应用程序源代码**.
|
||||
- 高性能探针.
|
||||
- [中间件,框架与类库支持列表](docs/Supported-list.md).
|
||||
- 手动探针
|
||||
- [使用OpenTracing手动探针API](http://opentracing.io/documentation/pages/supported-tracers)
|
||||
- 使用 [**@Trace**](docs/cn/Application-toolkit-trace-CN.md) 标注追踪业务方法
|
||||
- 将 traceId 集成到 log4j, log4j2 或 logback这些日志组件中
|
||||
- 纯Java后端Collector实现,提供RESTful和gRPC接口。兼容接受其他语言探针发送数据
|
||||
- 社区探针和SDK
|
||||
- [.NET Core](https://github.com/OpenSkywalking/skywalking-netcore)
|
||||
# Core features
|
||||
- 多语言探针或类库
|
||||
- Java自动探针,追踪和监控程序时,不需要修改源码。
|
||||
- 社区提供的其他多语言探针
|
||||
* [.NET Core](https://github.com/OpenSkywalking/skywalking-netcore)
|
||||
* [Node.js](https://github.com/OpenSkywalking/skywalking-nodejs)
|
||||
- 多种后端存储: ElasticSearch, H2
|
||||
- 支持[OpenTracing](http://opentracing.io/)
|
||||
- Java自动探针支持和OpenTracing API协同工作
|
||||
- 轻量级、完善功能的后端聚合和分析
|
||||
- 现代化Web UI
|
||||
- 日志集成
|
||||
- 应用、实例和服务的告警
|
||||
|
||||
# Document
|
||||
[](docs/README.md) [](docs/README_ZH.md)
|
||||
|
||||
- [英文文档](docs/README.md)
|
||||
- [中文文档](docs/README_ZH.md)
|
||||
|
||||
# 5.x Architecture
|
||||
<img src="https://skywalkingtest.github.io/page-resources/5.0/architecture.png"/>
|
||||
|
|
|
|||
Loading…
Reference in New Issue