This is an automated email from the ASF dual-hosted git repository. kezhenxu94 pushed a commit to branch chore/changelog-template in repository https://gitbox.apache.org/repos/asf/skywalking.git
commit c85f0f55eef0fc7a5a2d99e43fb06abbb36e16bf Author: kezhenxu94 <kezhenx...@163.com> AuthorDate: Sat Oct 24 23:52:22 2020 +0800 Improve the pull request template and changelog --- .github/PULL_REQUEST_TEMPLATE | 48 +++++++++++++++------ CHANGES.md | 97 +------------------------------------------ 2 files changed, 37 insertions(+), 108 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 42357c1..869fbb7 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -1,18 +1,40 @@ -Please answer these questions before submitting a pull request +<!-- + ⚠️ Please make sure to read this template first, pull requests that doesn't accord with this template + may be closed without notice. + Texts surrounded by `<` and `>` are meant to be replaced by you, e.g. <framework name>, <issue number>. + Put an `x` in the `[ ]` to mark the item as CHECKED. `[x]` +--> -- Why submit this pull request? -- [ ] Bug fix -- [ ] New feature provided -- [ ] Improve performance +<!-- ==== 🐛 Remove this line WHEN AND ONLY WHEN you're fixing a bug, follow the checklist 👇 ==== +### Fix <bug description or the bug issue number or bug issue link> +- [ ] Add a unit test to verify that the fix works. +- [ ] Explain briefly about why the bug exists and how to fix it. + ==== 🐛 Remove this line WHEN AND ONLY WHEN you're fixing a bug, follow the checklist 👆 ==== --> -- Related issues +<!-- ==== 🔌 Remove this line WHEN AND ONLY WHEN you're adding a new plugin, follow the checklist 👇 ==== +### Add an agent plugin to support <framework name> +- [ ] Add a test case for the new plugin, refer to [the doc](https://github.com/apache/skywalking/blob/master/docs/en/guides/Plugin-test.md) +- [ ] Add a component id in [the component-libraries.yml](https://github.com/apache/skywalking/blob/master/oap-server/server-bootstrap/src/main/resources/component-libraries.yml) +- [ ] Add a logo in [the UI repo](https://github.com/apache/skywalking-rocketbot-ui/tree/master/src/views/components/topology/assets) + ==== 🔌 Remove this line WHEN AND ONLY WHEN you're adding a new plugin, follow the checklist 👆 ==== --> -___ -### Bug fix -- Bug description. +<!-- ==== 📈 Remove this line WHEN AND ONLY WHEN you're improving the performance, follow the checklist 👇 ==== +### Improve the performance of <class or module or ...> +- [ ] Add a benchmark for the improvement, refer to [the existing ones](https://github.com/apache/skywalking/blob/master/apm-commons/apm-datacarrier/src/test/java/org/apache/skywalking/apm/commons/datacarrier/LinkedArrayBenchmark.java) +- [ ] The benchmark result. +```text +<Paste the benchmark results here> +``` +- [ ] Links/URLs to the theory proof or discussion articles/blogs. <links/URLs here> + ==== 📈 Remove this line WHEN AND ONLY WHEN you're improving the performance, follow the checklist 👆 ==== --> -- How to fix? +<!-- ==== 🆕 Remove this line WHEN AND ONLY WHEN you're adding a new feature, follow the checklist 👇 ==== +### <Feature description> +- [ ] If this is non-trivial feature, paste the links/URLs to the design doc. +- [ ] Update the documentation to include this new feature. +- [ ] Tests(including UT, IT, E2E) are added to verify the new feature. +- [ ] If it's UI related, attach the screenshots below. + ==== 🆕 Remove this line WHEN AND ONLY WHEN you're improving the performance, follow the checklist 👆 ==== --> -___ -### New feature or improvement -- Describe the details and related test reports. +- [ ] If this pull request closes/resolves/fixes an existing issue, replace the issue number. Closes #<issue number>. +- [ ] Update the [`CHANGES` log](https://github.com/apache/skywalking/blob/c2141978d1039375598a32418b75161a78da22c1/CHANGES.md). diff --git a/CHANGES.md b/CHANGES.md index 2abcdda..de90826 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -2,112 +2,19 @@ Changes by Version ================== Release Notes. -8.2.0 +8.3.0 ------------------ #### Project -* Support Browser monitoring. -* Add e2e test for ALS solution of service mesh observability. -* Support compiling(include testing) in JDK11. -* Support build a single module. #### Java Agent -* Support metrics plugin. -* Support slf4j logs of gRPC and Kafka(when agent uses them) into the agent log files. -* Add `PROPERTIES_REPORT_PERIOD_FACTOR` config to avoid the properties of instance cleared. -* Limit the size of traced SQL to avoid OOM. -* Support `mount` command to load a new set of plugins. -* Add plugin selector mechanism. -* Enhance the witness classes for MongoDB plugin. -* Enhance the parameter truncate mechanism of SQL plugins. -* Enhance the SpringMVC plugin in the reactive APIs. -* Enhance the SpringMVC plugin to collect HTTP headers as the span tags. -* Enhance the Kafka plugin, about `@KafkaPollAndInvoke` -* Enhance the configuration initialization core. Plugin could have its own plugins. -* Enhance Feign plugin to collect parameters. -* Enhance Dubbo plugin to collect parameters. -* Provide Thrift plugin. -* Provide XXL-job plugin. -* Provide MongoDB 4.x plugin. -* Provide Kafka client 2.1+ plugin. -* Provide WebFlux-WebClient plugin. -* Provide ignore-exception plugin. -* Provide quartz scheduler plugin. -* Provide ElasticJob 2.x plugin. -* Provide Spring @Scheduled plugin. -* Provide Spring-Kafka plugin. -* Provide HBase client plugin. -* Provide JSON log format. -* Move Spring WebFlux plugin to the optional plugin. -* Fix inconsistent logic bug in PrefixMatch -* Fix duplicate exit spans in Feign LoadBalancer mechanism. -* Fix the target service blocked by the Kafka reporter. -* Fix configurations of Kafka report don't work. -* Fix rest template concurrent conflict. -* Fix NPE in the ActiveMQ plugin. -* Fix conflict between Kafka reporter and sampling plugin. -* Fix NPE in the log formatter. -* Fix span layer missing in certain cases, in the Kafka plugin. -* Fix error format of time in serviceTraffic update. -* Upgrade bytebuddy to 1.10.14 #### OAP-Backend -* Support Nacos authentication. -* Support labeled meter in the meter receiver. -* Separate UI template into multiple files. -* Provide support for Envoy tracing. Envoy tracer depends on the Envoy community. -* Support query trace by tags. -* Support composite alarm rules. -* Support alarm messages to DingTalk. -* Support alarm messages to WeChat. -* Support alarm messages to Slack. -* Support SSL for Prometheus fetcher and self telemetry. -* Support labeled histogram in the prometheus format. -* Support the status of segment based on entry span or first span only. -* Support the error segment in the sampling mechanism. -* Support SSL certs of gRPC server. -* Support labeled metrics in the alarm rule setting. -* Support to query all labeled data, if no explicit label in the query condition. -* Add TLS parameters in the mesh analysis. -* Add health check for InfluxDB storage. -* Add `super dataset` concept for the traces/logs. -* Add separate replicas configuration for super dataset. -* Add `IN` operator in the OAL. -* Add `!=` operator in the OAL. -* Add `like` operator in the OAL. -* Add `latest` function in the prometheus analysis. -* Add more configurations in the gRPC server. -* Optimize the trace query performance. -* Optimize the CPU usage rate calculation, at least to be 1. -* Optimize the length of slow SQL column in the MySQL storage. -* Optimize the topology query, use client side component name when no server side mapping. -* Add component IDs for Python component. -* Add component ID range for C++. -* Fix Slack notification setting NPE. -* Fix some module missing check of the module manager core. -* Fix authentication doesn't work in sharing server. -* Fix metrics batch persistent size bug. -* Fix trace sampling bug. -* Fix CLR receiver bug. -* Fix end time bug in the query process. -* Fix `Exporter INCREMENT mode` is not working. -* Fix an error when executing startup.bat when the log directory exists -* Add syncBulkActions configuration to set up the batch size of the metrics persistent. -* Meter Analysis Language. #### UI -* Add browser dashboard. -* Add browser log query page. -* Support query trace by tags. -* Fix JVM configuration. -* Fix CLR configuration. #### Document -* Add the document about `SW_NO_UPSTREAM_REAL_ADDRESS`. -* Update ALS setup document. -* Add Customization Config section for plugin development. - -All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/56?closed=1) +All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/62?closed=1) ------------------ Find change logs of all versions [here](changes).