This is an automated email from the ASF dual-hosted git repository. wusheng pushed a commit to branch rt-oal in repository https://gitbox.apache.org/repos/asf/skywalking.git
commit 4c3a706d00cdd18ff6e92d7864c1e51c8793ae6f Author: Wu Sheng <[email protected]> AuthorDate: Thu Jul 18 14:49:03 2019 +0800 Update license and document of new OAL engine. --- apm-dist/release-docs/LICENSE | 2 ++ docs/en/concepts-and-designs/oal.md | 6 ++++-- docs/en/guides/How-to-build.md | 1 - docs/en/guides/README.md | 3 ++- docs/en/guides/write-oal.md | 15 --------------- 5 files changed, 8 insertions(+), 19 deletions(-) diff --git a/apm-dist/release-docs/LICENSE b/apm-dist/release-docs/LICENSE index 891d805..bddc04a 100644 --- a/apm-dist/release-docs/LICENSE +++ b/apm-dist/release-docs/LICENSE @@ -271,6 +271,7 @@ The text of each license is the standard Apache 2.0 license. Apache: commons-io 2.4: https://github.com/apache/commons-io, Apache 2.0 Apache: commons-compress 1.18: https://github.com/apache/commons-compress, Apache 2.0 Apache: tomcat 8.5.27: https://github.com/apache/tomcat/tree/trunk, Apache 2.0 + Apache: freemaker 2.3.28: https://github.com/apache/freemarker, Apache 2.0 netty 5.5.0: https://github.com/netty/netty/blob/4.1/LICENSE.txt, Apache 2.0 annotations 13.0: http://www.jetbrains.org, Apache 2.0 compiler 0.9.3: https://github.com/spullara/mustache.java, Apache 2.0 @@ -323,6 +324,7 @@ The text of each license is the standard Apache 2.0 license. sundrio 0.9.2: https://github.com/sundrio/sundrio Apache 2.0 Ctripcorp: apollo 1.4.0: https://github.com/ctripcorp/apollo Apache 2.0 etcd4j 2.17.0: https://github.com/jurmous/etcd4j Apache 2.0 + javaassist 3.25.0-GA: https://github.com/jboss-javassist/javassist Apache 2.0 ======================================================================== MIT licenses diff --git a/docs/en/concepts-and-designs/oal.md b/docs/en/concepts-and-designs/oal.md index 5a89269..e3f2069 100644 --- a/docs/en/concepts-and-designs/oal.md +++ b/docs/en/concepts-and-designs/oal.md @@ -4,8 +4,10 @@ Provide OAL(Observability Analysis Language) to analysis incoming data in stream OAL focuses on metrics in Service, Service Instance and Endpoint. Because of that, the language is easy to learn and use. -Considering performance, reading and debugging, OAL is defined as a compile language. -The OAL scripts will be compiled to normal Java codes in package stage. + +Since 6.3, the OAL engine is embedded in OAP server runtime, as `oal-rt`(OAL Runtime). +OAL scripts now locate in `/config` folder, user could simply change and reboot the server to make it effective. +But still, OAL script is compile language, OAL Runtime generates java codes dynamically. ## Grammar Scripts should be named as `*.oal` diff --git a/docs/en/guides/How-to-build.md b/docs/en/guides/How-to-build.md index 5106d30..2e1aca8 100644 --- a/docs/en/guides/How-to-build.md +++ b/docs/en/guides/How-to-build.md @@ -76,7 +76,6 @@ a oap image with name `bar/oap:foo`, run the following command * `grpc-java` and `java` folders in **oap-server/exporter/target/generated-sources/protobuf** * `grpc-java` and `java` folders in **oap-server/server-configuration/grpc-configuration-sync/target/generated-sources/protobuf** * `antlr4` folder in **oap-server/generate-tool-grammar/target/generated-sources** - * `oal` folder in **oap-server/generated-analysis/target/generated-sources** ## Setup your Eclipse IDE **NOTICE**: If you clone the codes from GitHub, please make sure that you had finished step 1 to 7 in section **[Build from GitHub](#build-from-github)**, if you download the source codes from the official website of SkyWalking, please make sure that you had followed the steps in section **[Build from Apache source code release](#build-from-apache-source-code-release)**. diff --git a/docs/en/guides/README.md b/docs/en/guides/README.md index a6140df..788c07e 100755 --- a/docs/en/guides/README.md +++ b/docs/en/guides/README.md @@ -96,7 +96,8 @@ 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](Component-library-settings.md) document. - [Storage extension development guide](storage-extention.md). Help potential contributors to build a new storage implementor besides the official. -- [Customize analysis by oal script](write-oal.md). Guide you to use oal script to make your own metrics available. +- Customize analysis by oal script. OAL scripts locate in `config/official_analysis.oal`. You could change it and reboot the OAP server. Read +[Observability Analysis Language Introduction](../concepts-and-designs/oal.md) if you need to learn about OAL script. - [Source and scope extension for new metrics](source-extension.md). If you want to analysis a new metrics, which SkyWalking haven't provide. You need to add a new receiver rather than choosing [existed receiver](../setup/backend/backend-receivers.md). diff --git a/docs/en/guides/write-oal.md b/docs/en/guides/write-oal.md deleted file mode 100644 index 7d6eb2a..0000000 --- a/docs/en/guides/write-oal.md +++ /dev/null @@ -1,15 +0,0 @@ -# Write OAL script -Read [OAL overview](../concepts-and-designs/oal.md) to understand the oal script. - -## Find oal script in source codes -The official official_analysis.oal is [here](../../../oap-server/generated-analysis/src/main/resources/official_analysis.oal). - -## Generate tool -The `oap-server/generate-tool` module includes the source codes of compiling tool. This tool is already integrated -maven compile phase. So, unless you want to change the tool source codes, you don't need to set anything. - -Run `./mvnw compile` or `./mvnw package`, the generated codes of the oal script are in `oap-server/generate-tool/target/generated-sources/oal/*`. - -## Write and recompile -You could change the `official_analysis.oal` script, then recompile codes. -The generated codes are in **oap-server/generated-analysis/target/generated-sources/oal**. \ No newline at end of file
