History

吴晟 Wu Sheng fb62025da8 Improve OAP extendibility (#2288 ) * Make scope meta configurable. * Fix test cases in ci. * Change step 1 * Refactor step 2 * Other compile issue done. Prepare the generator changes. * Revert some wrong changes to Istio receiver. * Step 3, make compile pass. * Try to make CI passed. * Add a check. * Fix generated code style * Provide new and extendable dispatcher generator tool * Fix startup. * Can't guarantee the dispatchers are always existing. Put explicit comments at there to avoid confusion, since this is different with old version. * Fix a H2 query for endpoint search. * Fix a wrong mysql alarm query. * Provide new document and `generate-tool-grammer` module. * Add missing last section of document. * Fix typo * Relocate the @ScopeDeclaration annotation, make it more sense. Also remove the useless @SourceType annotation. And adjust document for these changes * ScopeDeclaration can be used once for each class only, now.		2019-02-26 13:43:14 +08:00
..
Component-library-settings.md	Support Zookeeper plugin (#2211 )	2019-02-15 22:13:44 +08:00
How-to-build.md	Improve OAP extendibility (#2288 )	2019-02-26 13:43:14 +08:00
How-to-release.md	Set dist bin tar with -bin in the final name. (#2221 )	2019-01-30 20:37:40 +08:00
Java-Plugin-Development-Guide.md	Make sure all document images ref from our Apache website. (#2236 )	2019-02-11 14:52:52 +08:00
README.md	Improve OAP extendibility (#2288 )	2019-02-26 13:43:14 +08:00
backend-oal-scripts.md	Fix doc. (#2105 )	2019-01-01 11:44:32 +08:00
inventory-extension.md	Support service inventory extension fields in json format (#2148 )	2019-01-11 21:24:51 +08:00
source-extension.md	Improve OAP extendibility (#2288 )	2019-02-26 13:43:14 +08:00
storage-extention.md	Update user wall and document (#1982 )	2018-11-30 16:07:56 +08:00
write-oal.md	OAL tool module established (#2015 )	2018-12-07 09:31:16 +08:00

README.md

Guides

There are many ways that you can help the SkyWalking community.

Go through our documents, point out or fixed unclear things. Translate the documents to other languages.
Download our releases, try to monitor your applications, and feedback to us about what you think.
Read our source codes, Ask questions for details.
Find some bugs, submit issue, and try to fix it.
Find help wanted issues, which are good for you to start.
Submit issue or start discussion through GitHub issue.
See all mail list discussion through website list review. If you are a SkyWalking committer, could login and use the mail list in browser mode. Otherwise, follow the next step to subscribe.
Issue report and discussion also could take place in dev@skywalking.apache.org. Mail to dev-subscribe@skywalking.apache.org, follow the reply to subscribe the mail list.

Contact Us

All the following channels are open to the community, you could choose the way you like.

Submit an issue
Mail list: dev@skywalking.apache.org. Mail to dev-subscribe@skywalking.apache.org, follow the reply to subscribe the mail list.
Gitter
QQ Group: 392443393

For code developer

As a develop, first step, read Compiling Guide. It teaches developer how to build the project in local.

Project Extensions

SkyWalking project supports many ways to extend existing features. If you are interesting in these ways, read the following guides.

Java agent plugin development guide. This guide helps you to develop SkyWalking agent plugin to support more frameworks. Both open source plugin and private plugin developer should read this.
If you want to build a new probe or plugin in any language, please read Component library definition and extension document.
Storage extension development guide. Help potential contributors to build a new storage implementor besides the official.
Customize analysis by oal script. Guide you to use oal script to make your own metric available.
Source and scope extension for new metric. If you want to analysis a new metric, which SkyWalking haven't provide. You need to add a new receiver rather than choosing existed receiver. At that moment, you most likely need to add a new source and scope. This document will teach you how to do.
Backend Inventory entity extension. If you want to extend SkyWalking inventory entities, and want to push upstream back to our Apache OSS repo, please read these principles.

UI developer

Our UI is constituted by static pages and web container.

Static pages is built based on Ant Design Pro, which source codes are hosted in our UI repository.
Web container source codes are in apm-webapp module. This is a just an easy zuul proxy to host static resources and send GraphQL query requests to backend.

For release

Apache Release Guide introduces to the committer team about doing official Apache version release, to avoid breaking any Apache rule. Apache license allows everyone to redistribute if you keep our licenses and NOTICE in your redistribution.