This is an automated email from the ASF dual-hosted git repository. wusheng pushed a commit to branch oal-doc-fix in repository https://gitbox.apache.org/repos/asf/skywalking.git
commit 36613db5467492a8020928b51fe95a0670d79795 Author: Wu Sheng <[email protected]> AuthorDate: Thu Oct 17 16:49:39 2019 +0300 Polish doc, remove old OAL description. --- docs/en/guides/Java-Plugin-Development-Guide.md | 4 ++-- docs/en/guides/backend-oal-scripts.md | 11 ++++------- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/docs/en/guides/Java-Plugin-Development-Guide.md b/docs/en/guides/Java-Plugin-Development-Guide.md index fe08dbb..03c54c3 100644 --- a/docs/en/guides/Java-Plugin-Development-Guide.md +++ b/docs/en/guides/Java-Plugin-Development-Guide.md @@ -365,7 +365,7 @@ Please follow there steps: 1. Create sub modules under `apm-sniffer/apm-sdk-plugin` or `apm-sniffer/optional-plugins`, and the name should include supported library name and versions 1. Follow this guide to develop. Make sure comments and test cases are provided. 1. Develop and test. +1. Provide the automatic test cases. Read existing cases in `test/plugin/scenarios`, and add your new one. 1. Send the pull request and ask for review. -1. Provide the automatic test cases. -1. The plugin committers approve your plugins after automatic test cases provided and the tests passed in our CI. +1. The plugin committers approve your plugins, plugin CI-with-IT, e2e and plugin tests passed. 1. The plugin accepted by SkyWalking. diff --git a/docs/en/guides/backend-oal-scripts.md b/docs/en/guides/backend-oal-scripts.md index 7fc9057..bdd09f3 100644 --- a/docs/en/guides/backend-oal-scripts.md +++ b/docs/en/guides/backend-oal-scripts.md @@ -1,15 +1,12 @@ # Official OAL script First, read [OAL introduction](../concepts-and-designs/oal.md). -Here is the official scrips is the `generated-analysis-x.y.z.jar/official_analysis.oal` file in distribution, -also the [official_analysis.oal](../../../oap-server/generated-analysis/src/main/resources/official_analysis.oal) in source code repository. +Find OAL script at the `/config/official_analysis.oal` of SkyWalking dist, since 6.3. +You could change it(such as adding filter condition, or add new metrics) and reboot the OAP server, then it will affect. -**Notice**, this file doesn't effect anything in runtime, although included in distribution. -You need to use OAL tool code generator to build the real analysis codes from it. -All generated codes are under `oal` folder in **oap-server/generated-analysis/target/generated-sources**. +All metrics named in this script could be used in alarm and UI query. -All metrics named in this script could be used in alarm and UI query. Of course, you can change this -scripts and re-generate the analysis process and metrics, such as adding filter condition. +Notice, If you try to add or remove some metrics, UI may break, we only recommend you to do this when you plan to build your own UI based on the customization analysis core. \ No newline at end of file
